UserError

object

Charges a shop for features or services one time. This type of charge is recommended for apps that aren't billed on a recurring basis. Test and demo shops aren't charged.

Cancels an app subscription on a store.

Allows an app to charge a store for features or services on a recurring basis.

Updates the capped amount on the usage pricing plan of an app subscription line item.

Enables an app to charge a store for features or services on a per-use basis. The usage charge value is counted towards the cappedAmount limit that was specified in the appUsagePricingDetails field when the app subscription was created. If you create an app usage charge that causes the total usage charges in a billing interval to exceed the capped amount, then a Total price exceeds balance remaining error is returned.

Starts the cancelation process of a running bulk operation.

There may be a short delay from when a cancelation starts until the operation is actually canceled.

Creates and runs a bulk operation query.

See the bulk operations guide for more details.

Adds products to a collection.

Creates a collection.

Deletes a collection.

Removes a set of products from a given collection. The mutation can take a long time to run. Instead of returning an updated collection the mutation returns a job, which should be polled. For use with manual collections only.

Asynchronously reorders a set of products within a specified collection. Instead of returning an updated collection, this mutation returns a job, which should be polled. The Collection.sortOrder must be MANUAL. Displaced products will have their position altered in a consistent manner, with no gaps.

Updates a collection.

Add tax exemptions for the customer.

Create a new customer. As of API version 2022-10, apps using protected customer data must meet the protected customer data requirements.

Delete a customer. As of API version 2022-10, apps using protected customer data must meet the protected customer data requirements.

Generate an account activation URL for a customer.

Creates a credit card payment method for a customer using a session id. These values are only obtained through card imports happening from a PCI compliant environment. Please use customerPaymentMethodRemoteCreate if you are not managing credit cards directly.

Updates the credit card payment method for a customer.

Revokes a customer's payment method.

Sends a link to the customer so they can update a specific payment method.

Remove tax exemptions from a customer.

Replace tax exemptions for a customer.

Updates a customer's default address.

Update a customer's attributes. As of API version 2022-10, apps using protected customer data must meet the protected customer data requirements.

Create a delivery profile.

Enqueue the removal of a delivery profile.

Update a delivery profile.

Set the delivery settings for a shop.

Assigns a location as the shipping origin while using legacy compatibility mode for multi-location delivery profiles.

Adds tags to multiple draft orders.

Deletes multiple draft orders.

Removes tags from multiple draft orders.

Calculates the properties of a draft order. Useful for determining information such as total taxes or price without actually creating a draft order.

Completes a draft order and creates an order.

Creates a draft order from order.

Creates a merchant checkout for the given draft order.

Creates a draft order.

Deletes a draft order.

Duplicates a draft order.

Previews a draft order invoice email.

Sends an email invoice for a draft order.

Updates a draft order.

If a checkout has been started for a draft order, any update to the draft will unlink the checkout. Checkouts are created but not immediately completed when opening the merchant credit card modal in the admin, and when a buyer opens the invoice URL. This is usually fine, but there is an edge case where a checkout is in progress and the draft is updated before the checkout completes. This will not interfere with the checkout and order creation, but if the link from draft to checkout is broken the draft will remain open even after the order is created.

Creates a new Amazon EventBridge webhook subscription.

Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your shopify.app.toml may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read About managing webhook subscriptions.

Updates an Amazon EventBridge webhook subscription.

Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your shopify.app.toml may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read About managing webhook subscriptions.

Triggers any workflows that begin with the trigger specified in the request body. To learn more, refer to Create Shopify Flow triggers.

Cancels a fulfillment.

Creates a fulfillment for one or many fulfillment orders. The fulfillment orders are associated with the same order and are assigned to the same location.

Creates a fulfillment event for a specified fulfillment.

Accept a cancellation request sent to a fulfillment service for a fulfillment order.

Accepts a fulfillment request sent to a fulfillment service for a fulfillment order.

Marks a fulfillment order as canceled.

Marks an in-progress fulfillment order as incomplete, indicating the fulfillment service is unable to ship any remaining items and intends to close the fulfillment order.

Changes the location which is assigned to fulfill a number of unfulfilled fulfillment order line items.

Moving a fulfillment order will fail in the following circumstances:

• The fulfillment order is closed.
• The destination location has never stocked the requested inventory item.
• The API client doesn't have the correct permissions.

Line items which have already been fulfilled can't be re-assigned and will always remain assigned to the original location.

You can't change the assigned location while a fulfillment order has a request status of SUBMITTED, ACCEPTED, CANCELLATION_REQUESTED, or CANCELLATION_REJECTED. These request statuses mean that a fulfillment order is awaiting action by a fulfillment service and can't be re-assigned without first having the fulfillment service accept a cancellation request. This behavior is intended to prevent items from being fulfilled by multiple locations or fulfillment services.

How re-assigning line items affects fulfillment orders

First scenario: Re-assign all line items belonging to a fulfillment order to a new location.

In this case, the assignedLocation of the original fulfillment order will be updated to the new location.

Second scenario: Re-assign a subset of the line items belonging to a fulfillment order to a new location. You can specify a subset of line items using the fulfillmentOrderLineItems parameter (available as of the 2023-04 API version), or specify that the original fulfillment order contains line items which have already been fulfilled.

If the new location is already assigned to another active fulfillment order, on the same order, then a new fulfillment order is created. The existing fulfillment order is closed and line items are recreated in a new fulfillment order.

Marks a scheduled fulfillment order as open.

Rejects a cancellation request sent to a fulfillment service for a fulfillment order.

Rejects a fulfillment request sent to a fulfillment service for a fulfillment order.

Sends a cancellation request to the fulfillment service of a fulfillment order.

Sends a fulfillment request to the fulfillment service of a fulfillment order.

Creates a fulfillment service.

Fulfillment service location

When creating a fulfillment service, a new location will be automatically created on the shop and will be associated with this fulfillment service. This location will be named after the fulfillment service and inherit the shop's address.

If you are using API version 2023-10 or later, and you need to specify custom attributes for the fulfillment service location (for example, to change its address to a country different from the shop's country), use the LocationEdit mutation after creating the fulfillment service.

Deletes a fulfillment service.

Updates a fulfillment service.

If you are using API version 2023-10 or later, and you need to update the location managed by the fulfillment service (for example, to change the address of a fulfillment service), use the LocationEdit mutation.

Updates tracking information for a fulfillment.

Update a gift card.

Activate an inventory item at a location.

Removes an inventory item's quantities from a location, and turns off inventory at the location.

Updates an inventory item.

Create new marketing activity.

Updates a marketing activity with the latest information.

Deletes multiple metafields in bulk.

Cancels an order.

Captures payment for an authorized transaction on an order. An order can only be captured if it has a successful authorization transaction. Capturing an order will claim the money reserved by the authorization. orderCapture can be used to capture multiple times as long as the OrderTransaction is multi-capturable. To capture a partial payment, the included amount value should be less than the total order amount. Multi-capture is available only to stores on a Shopify Plus plan.

Closes an open order.

Adds a custom line item to an existing order. For example, you could add a gift wrapping service as a custom line item. To learn how to edit existing orders, refer to Edit an existing order with Admin API.

Adds a discount to a line item on the current order edit. For more information on how to use the GraphQL Admin API to edit an existing order, refer to Edit existing orders.

Adds a line item from an existing product variant.

Starts editing an order. Mutations are operating on OrderEdit. All order edits start with orderEditBegin, have any number of orderEdit* mutations made, and end with orderEditCommit.

Applies and saves staged changes to an order. Mutations are operating on OrderEdit. All order edits start with orderEditBegin, have any number of orderEdit* mutations made, and end with orderEditCommit.

Sets the quantity of a line item on an order that is being edited. For more information on how to use the GraphQL Admin API to edit an existing order, refer to Edit existing orders.

Marks an order as paid. You can only mark an order as paid if it isn't already fully paid.

Opens a closed order.

Updates the fields of an order.

Creates a new componentized product.

Updates a componentized product.

Creates media for a product.

Creates a product.

Learn more about the product model and adding product data.

Deletes media for a product.

Deletes a product, including all associated variants and media.

As of API version 2023-01, if you need to delete a large product, such as one that has many variants that are active at several locations, you may encounter timeout errors. To avoid these timeout errors, you can instead use the asynchronous ProductDeleteAsync mutation.

Duplicates a product.

If you need to duplicate a large product, such as one that has many variants that are active at several locations, you might encounter timeout errors.

To avoid these timeout errors, you can instead duplicate the product asynchronously.

In API version 2024-10 and higher, include synchronous: false argument in this mutation to perform the duplication asynchronously.

In API version 2024-07 and lower, use the asynchronous ProductDuplicateAsyncV2.

Asynchronously reorders the media attached to a product.

Updates media for a product.

Updates a product.

For versions 2024-01 and older: If you update a product and only include some variants in the update, then any variants not included will be deleted.

To safely manage variants without the risk of deleting excluded variants, use productVariantsBulkUpdate.

If you want to update a single variant, then use productVariantUpdate.

Publishes a resource to a channel. If the resource is a product, then it's visible in the channel only if the product status is active. Products that are sold exclusively on subscription (requiresSellingPlan: true) can be published only on online stores.

Publishes a resource to current channel. If the resource is a product, then it's visible in the channel only if the product status is active. Products that are sold exclusively on subscription (requiresSellingPlan: true) can be published only on online stores.

Unpublishes a resource from a channel. If the resource is a product, then it's visible in the channel only if the product status is active.

Unpublishes a resource from the current channel. If the resource is a product, then it's visible in the channel only if the product status is active.

Creates a refund.

Creates a saved search.

Delete a saved search.

Updates a saved search.

Creates a new script tag.

Deletes a script tag.

Updates a script tag.

Creates a segment.

Deletes a segment.

Updates a segment.

Deletes a shipping package.

Set a shipping package as the default. The default shipping package is the one used to calculate shipping costs on checkout.

Updates a shipping package.

Deletes a locale for a shop. This also deletes all translations of this locale.

Adds a locale for a shop. The newly added locale is in the unpublished state.

Updates a locale for a shop.

Creates staged upload targets for each input. This is the first step in the upload process. The returned staged upload targets' URL and parameter fields can be used to send a request to upload the file described in the corresponding input.

For more information on the upload process, refer to Upload media to Shopify.

Creates a storefront access token for use with the Storefront API.

An app can have a maximum of 100 active storefront access tokens for each shop.

Get started with the Storefront API.

Deletes a storefront access token.

Add tags to an order, a draft order, a customer, a product, or an online store article.

Remove tags from an order, a draft order, a customer, a product, or an online store article.

Asynchronously delete URL redirects in bulk.

Creates a new webhook subscription.

Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your shopify.app.toml may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read About managing webhook subscriptions.

Deletes a webhook subscription.

Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your shopify.app.toml may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read About managing webhook subscriptions.

Updates a webhook subscription.

Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your shopify.app.toml may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read About managing webhook subscriptions.