UserError

The name of the one-time purchase from the app.

The amount to be charged to the store for the app one-time purchase.

The URL where the merchant is redirected after approving the app one-time purchase.

Whether the app one-time purchase is a test transaction.

The newly created app one-time purchase.

The URL that the merchant can access to approve or decline the newly created app one-time purchase.

If the merchant declines, then the merchant is redirected to the app and receives a notification message stating that the charge was declined. If the merchant approves and they're successfully invoiced, then the state of the charge changes from pending to active.

You get paid after the charge is activated.

The list of errors that occurred from executing the mutation.

The ID of the app subscription to be cancelled.

Whether to issue prorated credits for the unused portion of the app subscription. There will be a corresponding deduction (based on revenue share) to your Partner account. For example, if a $10.00 app subscription (with 0% revenue share) is cancelled and prorated half way through the billing cycle, then the merchant will be credited $5.00 and that amount will be deducted from your Partner account.

The cancelled app subscription.

The list of errors that occurred from executing the mutation.

Attaches one or more pricing plans to an app subscription. Only one pricing plan can be defined for each available type.

A descriptive name for the app subscription.

The replacement behavior when creating an app subscription for a merchant with an already existing app subscription.

The URL pointing to the page where the merchant is redirected after approving the app subscription.

Whether the app subscription is a test transaction.

The number of days of the free trial period, beginning on the day that the merchant approves the app charges.

The newly-created app subscription.

The URL pointing to the page where the merchant approves or declines the charges for an app subscription.

The list of errors that occurred from executing the mutation.

The new maximum amount of usage charges that can be incurred within a subscription billing interval.

The ID of the app subscription line item to be updated.

The updated app subscription.

The URL where the merchant approves or declines the updated app subscription line item.

The list of errors that occurred from executing the mutation.

The description of the app usage record.

A unique key generated by the client to avoid duplicate charges. Maximum length of 255 characters.

The price of the app usage record.

The ID of the app subscription line item to create the usage record under. This app subscription line item must have a usage pricing plan.

The newly created app usage record.

The list of errors that occurred from executing the mutation.

The ID of the bulk operation to cancel.

The bulk operation to be canceled.

The list of errors that occurred from executing the mutation.

The ID of the collection that's being updated. This can't be a smart collection.

The IDs of the products that are being added to the collection. If any of the products is already present in the input collection, then an error is raised and no products are added.

The updated collection. Returns null if an error is raised.

The list of errors that occurred from executing the mutation.

The properties to use when creating the collection.

The collection that has been created.

The list of errors that occurred from executing the mutation.

The collection to delete.

The ID of the collection that was deleted. Returns null if the collection doesn't exist.

The shop associated with the collection.

The list of errors that occurred from executing the mutation.

The ID of the collection to remove products from. The ID must reference an existing manual collection.

The IDs of products to remove from the collection. The mutation doesn't validate that the products belong to the collection or whether the products exist.

The asynchronous job removing the products.

The list of errors that occurred from executing the mutation.

The ID of the collection on which to reorder products.

A list of moves to perform, which will be evaluated in order. Up to 250 moves are supported, the newPosition does not have to be unique.

The asynchronous job reordering the products.

The list of errors that occurred from executing the mutation.

The updated properties for the collection.

The updated collection.

The asynchronous job updating the products based on the new rule set.

The list of errors that occurred from executing the mutation.

The ID of the customer to update.

The list of tax exemptions to add for the customer, in the format of an array or a comma-separated list. Example values: ["CA_BC_RESELLER_EXEMPTION", "CA_STATUS_CARD_EXEMPTION"], "CA_BC_RESELLER_EXEMPTION, CA_STATUS_CARD_EXEMPTION".

The updated customer.

The list of errors that occurred from executing the mutation.

The input fields to create a customer.

The created customer.

The list of errors that occurred from executing the mutation.

Specifies the customer to delete.

The ID of the deleted customer.

The shop of the deleted customer.

The list of errors that occurred from executing the mutation.

The ID of the customer that the URL is generated for.

The generated account activation URL.

The list of errors that occurred from executing the mutation.

The billing address.

The ID of the customer.

The Cardserver session ID. Obtained by storing card data with Shopify's Cardsink. Exchanging raw card data for a session ID must be done in a PCI complaint environment.

The customer payment method.

If the card verification result is processing. When this is true, customer_payment_method will be null.

The list of errors that occurred from executing the mutation.

The billing address.

The ID of the customer payment method.

The Cardserver session ID.

The customer payment method.

If the card verification result is processing. When this is true, customer_payment_method will be null.

The list of errors that occurred from executing the mutation.

The ID of the customer payment method to be revoked.

The ID of the revoked customer payment method.

The list of errors that occurred from executing the mutation.

The payment method to be updated.

Specifies the payment method update email fields. Only the 'from' and 'bcc' fields are accepted for input.

The customer to whom an update payment method email was sent.

The list of errors that occurred from executing the mutation.

The ID of the customer to update.

The list of tax exemptions to remove for the customer, in the format of an array or a comma-separated list. Example values: ["CA_BC_RESELLER_EXEMPTION", "A_STATUS_CARD_EXEMPTION"], "CA_BC_RESELLER_EXEMPTION, CA_STATUS_CARD_EXEMPTION".

The updated customer.

The list of errors that occurred from executing the mutation.

The ID of the customer to update.

The list of tax exemptions that will replace the current exemptions for a customer. Can be an array or a comma-separated list. Example values: ["CA_BC_RESELLER_EXEMPTION", "A_STATUS_CARD_EXEMPTION"], "CA_BC_RESELLER_EXEMPTION, CA_STATUS_CARD_EXEMPTION".

The updated customer.

The list of errors that occurred from executing the mutation.

Provides updated fields for the customer. To set marketing consent, use the customerEmailMarketingConsentUpdate or customerSmsMarketingConsentUpdate mutations instead.

The updated customer.

The list of errors that occurred from executing the mutation.

The ID of the customer's new default address.

The ID of the customer whose default address is being updated.

The customer whose address was updated.

The list of errors that occurred from executing the mutation.

Specifies the input fields for a delivery profile.

The delivery profile that was created.

The list of errors that occurred from executing the mutation.

The ID of the delivery profile to remove.

The delivery profile deletion job triggered by the mutation.

The list of errors that occurred from executing the mutation.

The ID of the delivery profile to update.

Whether this delivery profile should leave legacy mode.

Specifies the input fields for a delivery profile.

The delivery profile that was updated.

The list of errors that occurred from executing the mutation.

The branded promise handle to update the delivery promise participants for.

The owners to add to the delivery promise participants.

The owners to remove from the delivery promise participants.

The promise participants that were added.

The list of errors that occurred from executing the mutation.

Specifies the input fields for the delivery shop level settings.

The updated delivery shop level settings.

The list of errors that occurred from executing the mutation.

The ID of the location to assign as the shipping origin.

The list of errors that occurred from executing the mutation.

The IDs of the draft orders to add tags to.

The ID of the draft order saved search for filtering draft orders on.

The conditions for filtering draft orders on. See the detailed search syntax.

List of tags to be added.

The asynchronous job for adding tags to the draft orders.

The list of errors that occurred from executing the mutation.

The IDs of the draft orders to delete.

The ID of the draft order saved search for filtering draft orders on.

The conditions for filtering draft orders on. See the detailed search syntax.

The asynchronous job for deleting the draft orders.

The list of errors that occurred from executing the mutation.

The IDs of the draft orders to remove tags from.

The ID of the draft order saved search for filtering draft orders on.

The conditions for filtering draft orders on. See the detailed search syntax.

List of tags to be removed.

The asynchronous job for removing tags from the draft orders.

The list of errors that occurred from executing the mutation.

The fields for the draft order.

The calculated properties for a draft order.

The list of errors that occurred from executing the mutation.

The draft order to complete.

The gateway for the completed draft order.

A channel definition handle used for sales channel attribution.

The completed draft order.

The list of errors that occurred from executing the mutation.

The fields used to create the draft order.

The created draft order.

The list of errors that occurred from executing the mutation.

Specifies the order's id that we create the draft order from.

The created draft order.

The list of errors that occurred from executing the mutation.

Specify the draft order to delete by its ID.

The ID of the deleted draft order.

The list of errors that occurred from executing the mutation.

The ID of the draft order to duplicate.

The newly duplicated draft order.

The list of errors that occurred from executing the mutation.

Specifies the draft order invoice email fields.

Specifies the draft order invoice email to preview.

The draft order invoice email rendered as HTML to allow previewing.

The subject preview for the draft order invoice email.

The list of errors that occurred from executing the mutation.

Specifies the draft order invoice email fields.

Specifies the draft order to send the invoice for.

The draft order an invoice email is sent for.

The list of errors that occurred from executing the mutation.

Specifies the draft order to update.

The draft order properties to update.

The updated draft order.

The list of errors that occurred from executing the mutation.

The type of event that triggers the webhook.

Specifies the input fields for an EventBridge webhook subscription.

The list of errors that occurred from executing the mutation.

The webhook subscription that was created.

The ID of the webhook subscription to update.

Specifies the input fields for an EventBridge webhook subscription.

The list of errors that occurred from executing the mutation.

The webhook subscription that was updated.

The handle of the trigger.

The payload needed to run the Trigger.

The list of errors that occurred from executing the mutation.

The ID of the fulfillment to be canceled.

The canceled fulfillment.

The list of errors that occurred from executing the mutation.

The input fields used to create a fulfillment from fulfillment orders.

An optional message for the fulfillment request.

The created fulfillment.

The list of errors that occurred from executing the mutation.

The input fields used to create a fulfillment event for a fulfillment.

The created fulfillment event.

The list of errors that occurred from executing the mutation.

The ID of the fulfillment order associated with the cancellation request.

An optional reason for accepting the cancellation request.

The fulfillment order whose cancellation request was accepted.

The list of errors that occurred from executing the mutation.

The ID of the fulfillment order associated with the fulfillment request.

An optional reason for accepting the fulfillment request.

The fulfillment order whose fulfillment request was accepted.

The list of errors that occurred from executing the mutation.

The ID of the fulfillment order to mark as canceled.

The fulfillment order that was marked as canceled.

The fulfillment order that was created to replace the canceled fulfillment order.

The list of errors that occurred from executing the mutation.

The ID of the fulfillment order to mark as incomplete.

An optional reason for marking the fulfillment order as incomplete.

The fulfillment order that was marked as incomplete.

The list of errors that occurred from executing the mutation.

The fulfillment order line items to be moved. If left blank, all unfulfilled line items belonging to the fulfillment order are moved.

The ID of the fulfillment order to be moved.

The ID of the location where the fulfillment order will be moved.

The fulfillment order which now contains the moved line items and is assigned to the destination location.

If the original fulfillment order doesn't have any line items which are fully or partially fulfilled, the original fulfillment order will be moved to the new location. However if this isn't the case, the moved fulfillment order will differ from the original one.

The final state of the original fulfillment order.

As a result of the move operation, the original fulfillment order might be moved to the new location or remain in the original location. The original fulfillment order might have the same status or be closed.

This field is deprecated.

The list of errors that occurred from executing the mutation.

The ID of the fulfillment order to mark as open.

The fulfillment order that was transitioned to open and is fulfillable.

The list of errors that occurred from executing the mutation.

The ID of the fulfillment order associated with the cancellation request.

An optional reason for rejecting the cancellation request.

The fulfillment order whose cancellation request was rejected.

The list of errors that occurred from executing the mutation.

The ID of the fulfillment order associated with the fulfillment request.

An optional array of line item rejection details. If none are provided, all line items will be assumed to be unfulfillable.

Note: After the fulfillment request has been rejected, none of the line items will be able to be fulfilled. This field documents which line items specifically were unable to be fulfilled and why.

An optional reason for rejecting the fulfillment request.

The reason for the fulfillment order rejection.

The fulfillment order whose fulfillment request was rejected.

The list of errors that occurred from executing the mutation.

The ID of the fulfillment order associated with the cancellation request.

An optional reason for the cancellation request.

The fulfillment order specified in the cancelation request.

The list of errors that occurred from executing the mutation.

The fulfillment order line items to be requested for fulfillment. If left blank, all line items of the fulfillment order are requested for fulfillment.

The ID of the fulfillment order associated with fulfillment request.

An optional message for the fulfillment request.

Whether the customer should be notified when fulfillments are created for this fulfillment order.

The original fulfillment order intended to request fulfillment for.

The fulfillment order that was submitted to the fulfillment service. This will be the same as the original fulfillment order field. The exception to this is partial fulfillment requests or fulfillment request for cancelled or incomplete fulfillment orders.

This field will only be present for partial fulfillment requests. This will represent the new fulfillment order with the remaining line items not submitted to the fulfillment service.

The list of errors that occurred from executing the mutation.

The URL to send requests for the fulfillment service. The following considerations apply:

• Shopify queries the callback_url/fetch_tracking_numbers endpoint to retrieve tracking numbers for orders, if trackingSupport is set to true.
• Shopify queries the callback_url/fetch_stock endpoint to retrieve inventory levels, if inventoryManagement is set to true.
• Shopify uses the callback_url/fulfillment_order_notification endpoint to send fulfillment and cancellation requests.

Whether the fulfillment service manages product inventory and provides updates to Shopify.

The name of the fulfillment service.

Whether the fulfillment service provides tracking numbers for packages.

The created fulfillment service.

The list of errors that occurred from executing the mutation.

The ID of an active merchant managed location where inventory and commitments will be relocated after the fulfillment service is deleted.

Inventory will only be transferred if the TRANSFER inventory action has been chosen.

The ID of the fulfillment service to delete.

The action to take with the location after the fulfillment service is deleted.

The ID of the deleted fulfillment service.

The list of errors that occurred from executing the mutation.

The URL to send requests for the fulfillment service. The following considerations apply:

• Shopify queries the callback_url/fetch_tracking_numbers endpoint to retrieve tracking numbers for orders, if trackingSupport is set to true.
• Shopify queries the callback_url/fetch_stock endpoint to retrieve inventory levels, if inventoryManagement is set to true.
• Shopify uses the callback_url/fulfillment_order_notification endpoint to send fulfillment and cancellation requests.

The id of the fulfillment service.

Whether the fulfillment service tracks product inventory and provides updates to Shopify.

The name of the fulfillment service.

Whether the fulfillment service provides tracking numbers for packages.

The updated fulfillment service.

The list of errors that occurred from executing the mutation.

The ID of the fulfillment.

Whether the customer will be notified of this update and future updates for the fulfillment. If this field is left blank, then notifications won't be sent to the customer when the fulfillment is updated.

The tracking input for the mutation, including tracking URL, number, and company.

The updated fulfillment with tracking information.

The list of errors that occurred from executing the mutation.

The ID of the gift card to be updated.

The input fields to update the gift card.