UserError - admin-graphql - OBJECT

Version: 2024-10

Description:

Represents an error in the input of a mutation.

Access Scopes

Fields

• field: String - The path to the input field that caused the error.
• message: String! - The error message.

Connections

Related queries

Related mutations

• appPurchaseOneTimeCreate 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.
• appSubscriptionCancel Cancels an app subscription on a store.
• appSubscriptionCreate Allows an app to charge a store for features or services on a recurring basis.
• appSubscriptionLineItemUpdate Updates the capped amount on the usage pricing plan of an app subscription line item.
• appUsageRecordCreate 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.
• bulkOperationCancel 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.
• bulkOperationRunQuery Creates and runs a bulk operation query. See the [bulk operations guide](https://shopify.dev/api/usage/bulk-operations/queries) for more details.
• collectionAddProducts Adds products to a collection.
• collectionCreate Creates a collection.
• collectionDelete Deletes a collection.
• collectionPublish Publishes a collection to a channel.
• collectionRemoveProducts 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](https://shopify.dev/api/admin-graphql/latest/queries/job). For use with manual collections only.
• collectionReorderProducts 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](https://shopify.dev/api/admin-graphql/latest/queries/job). The [`Collection.sortOrder`](https://shopify.dev/api/admin-graphql/latest/objects/Collection#field-collection-sortorder) must be `MANUAL`. Displaced products will have their position altered in a consistent manner, with no gaps.
• collectionUnpublish Unpublishes a collection.
• collectionUpdate Updates a collection.
• customerAddTaxExemptions Add tax exemptions for the customer.
• customerCreate Create a new customer. As of API version 2022-10, apps using protected customer data must meet the protected customer data [requirements](https://shopify.dev/apps/store/data-protection/protected-customer-data).
• customerDelete Delete a customer. As of API version 2022-10, apps using protected customer data must meet the protected customer data [requirements](https://shopify.dev/apps/store/data-protection/protected-customer-data).
• customerGenerateAccountActivationUrl Generate an account activation URL for a customer.
• customerPaymentMethodCreditCardCreate 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.
• customerPaymentMethodCreditCardUpdate Updates the credit card payment method for a customer.
• customerPaymentMethodRevoke Revokes a customer's payment method.
• customerPaymentMethodSendUpdateEmail Sends a link to the customer so they can update a specific payment method.
• customerRemoveTaxExemptions Remove tax exemptions from a customer.
• customerReplaceTaxExemptions Replace tax exemptions for a customer.
• customerUpdateDefaultAddress Updates a customer's default address.
• customerUpdate Update a customer's attributes. As of API version 2022-10, apps using protected customer data must meet the protected customer data [requirements](https://shopify.dev/apps/store/data-protection/protected-customer-data).
• deliveryProfileCreate Create a delivery profile.
• deliveryProfileRemove Enqueue the removal of a delivery profile.
• deliveryProfileUpdate Update a delivery profile.
• deliverySettingUpdate Set the delivery settings for a shop.
• deliveryShippingOriginAssign Assigns a location as the shipping origin while using legacy compatibility mode for multi-location delivery profiles.
• draftOrderBulkAddTags Adds tags to multiple draft orders.
• draftOrderBulkDelete Deletes multiple draft orders.
• draftOrderBulkRemoveTags Removes tags from multiple draft orders.
• draftOrderCalculate Calculates the properties of a draft order. Useful for determining information such as total taxes or price without actually creating a draft order.
• draftOrderComplete Completes a draft order and creates an order.
• draftOrderCreateFromOrder Creates a draft order from order.
• draftOrderCreateMerchantCheckout Creates a merchant checkout for the given draft order.
• draftOrderCreate Creates a draft order.
• draftOrderDelete Deletes a draft order.
• draftOrderDuplicate Duplicates a draft order.
• draftOrderInvoicePreview Previews a draft order invoice email.
• draftOrderInvoiceSend Sends an email invoice for a draft order.
• draftOrderUpdate 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.
• eventBridgeWebhookSubscriptionCreate 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](https://shopify.dev/docs/apps/build/webhooks/subscribe).
• eventBridgeWebhookSubscriptionUpdate 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](https://shopify.dev/docs/apps/build/webhooks/subscribe).
• flowTriggerReceive Triggers any workflows that begin with the trigger specified in the request body. To learn more, refer to [_Create Shopify Flow triggers_](https://shopify.dev/apps/flow/triggers).
• fulfillmentCancel Cancels a fulfillment.
• fulfillmentCreate 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.
• fulfillmentCreateV2 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.
• fulfillmentEventCreate Creates a fulfillment event for a specified fulfillment.
• fulfillmentOrderAcceptCancellationRequest Accept a cancellation request sent to a fulfillment service for a fulfillment order.
• fulfillmentOrderAcceptFulfillmentRequest Accepts a fulfillment request sent to a fulfillment service for a fulfillment order.
• fulfillmentOrderCancel Marks a fulfillment order as canceled.
• fulfillmentOrderClose 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.
• fulfillmentOrderMove 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](https://shopify.dev/docs/api/admin-graphql/latest/enums/FulfillmentOrderRequestStatus) 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](https://shopify.dev/docs/api/admin-graphql/latest/objects/fulfillmentorder#field-fulfillmentorder-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.
• fulfillmentOrderOpen Marks a scheduled fulfillment order as open.
• fulfillmentOrderRejectCancellationRequest Rejects a cancellation request sent to a fulfillment service for a fulfillment order.
• fulfillmentOrderRejectFulfillmentRequest Rejects a fulfillment request sent to a fulfillment service for a fulfillment order.
• fulfillmentOrderSubmitCancellationRequest Sends a cancellation request to the fulfillment service of a fulfillment order.
• fulfillmentOrderSubmitFulfillmentRequest Sends a fulfillment request to the fulfillment service of a fulfillment order.
• fulfillmentServiceCreate 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](https://shopify.dev/api/admin-graphql/latest/mutations/locationEdit) mutation after creating the fulfillment service.
• fulfillmentServiceDelete Deletes a fulfillment service.
• fulfillmentServiceUpdate 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](https://shopify.dev/api/admin-graphql/latest/mutations/locationEdit) mutation.
• fulfillmentTrackingInfoUpdate Updates tracking information for a fulfillment.
• fulfillmentTrackingInfoUpdateV2 Updates tracking information for a fulfillment.
• giftCardUpdate Update a gift card.
• inventoryActivate Activate an inventory item at a location.
• inventoryDeactivate Removes an inventory item's quantities from a location, and turns off inventory at the location.
• inventoryItemUpdate Updates an inventory item.
• marketingActivityCreate Create new marketing activity.
• marketingActivityUpdate Updates a marketing activity with the latest information.
• metafieldDelete Deletes a metafield.
• metafieldStorefrontVisibilityCreate Creates a `MetafieldStorefrontVisibility` record to make all metafields that belong to the specified resource and have the established `namespace` and `key` combination visible in the Storefront API.
• metafieldStorefrontVisibilityDelete Deletes a `MetafieldStorefrontVisibility` record. All metafields that belongs to the specified record will no longer be visible in the Storefront API.
• metafieldsDelete Deletes multiple metafields in bulk.
• orderCancel Cancels an order.
• orderCapture 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.
• orderClose Closes an open order.
• orderEditAddCustomItem Adds a custom line item to an existing order. For example, you could add a gift wrapping service as a [custom line item](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing#add-a-custom-line-item). To learn how to edit existing orders, refer to [Edit an existing order with Admin API](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).
• orderEditAddLineItemDiscount 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](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).
• orderEditAddVariant Adds a line item from an existing product variant.
• orderEditBegin 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`.
• 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`.
• orderEditRemoveLineItemDiscount Removes a line item discount that was applied as part of an order edit.
• orderEditSetQuantity 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](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).
• orderMarkAsPaid Marks an order as paid. You can only mark an order as paid if it isn't already fully paid.
• orderOpen Opens a closed order.
• orderUpdate Updates the fields of an order.
• privateMetafieldDelete Deletes a private metafield. Private metafields are automatically deleted when the app that created them is uninstalled.
• privateMetafieldUpsert Creates or updates a private metafield. Use private metafields when you don't want the metafield data to be accessible by merchants or other apps. Private metafields are accessible only by the application that created them and only from the GraphQL Admin API. An application can create a maximum of 10 private metafields per shop resource.
• productBundleCreate Creates a new componentized product.
• productBundleUpdate Updates a componentized product.
• productCreateMedia Creates media for a product.
• productCreate Creates a product. Learn more about the [product model](https://shopify.dev/docs/apps/build/graphql/migrate/new-product-model) and [adding product data](https://shopify.dev/docs/apps/build/graphql/migrate/new-product-model/add-data).
• productDeleteMedia Deletes media for a product.
• productDelete 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](https://shopify.dev/api/admin-graphql/latest/input-objects/ProductVariantInput) that are active at several [locations](https://shopify.dev/api/admin-graphql/latest/input-objects/InventoryLevelInput), you may encounter timeout errors. To avoid these timeout errors, you can instead use the asynchronous [ProductDeleteAsync](https://shopify.dev/api/admin-graphql/latest/mutations/productDeleteAsync) mutation.
• productDuplicate Duplicates a product. If you need to duplicate a large product, such as one that has many [variants](https://shopify.dev/api/admin-graphql/latest/input-objects/ProductVariantInput) that are active at several [locations](https://shopify.dev/api/admin-graphql/latest/input-objects/InventoryLevelInput), 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`](https://shopify.dev/api/admin-graphql/2024-07/mutations/productDuplicateAsyncV2).
• productPublish Publishes a product. Products that are sold exclusively on subscription (`requiresSellingPlan: true`) can only be published on online stores.
• productReorderMedia Asynchronously reorders the media attached to a product.
• productUnpublish Unpublishes a product.
• productUpdateMedia Updates media for a product.
• productUpdate 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](https://shopify.dev/api/admin-graphql/latest/mutations/productvariantsbulkupdate). If you want to update a single variant, then use [productVariantUpdate](https://shopify.dev/api/admin-graphql/latest/mutations/productvariantupdate).
• publishablePublish 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.
• publishablePublishToCurrentChannel 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.
• publishableUnpublish 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`.
• publishableUnpublishToCurrentChannel 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`.
• refundCreate Creates a refund.
• savedSearchCreate Creates a saved search.
• savedSearchDelete Delete a saved search.
• savedSearchUpdate Updates a saved search.
• scriptTagCreate <div class="note"><h4>Theme app extensions</h4> <p>Your app might not pass App Store review if it uses script tags instead of theme app extensions. All new apps, and apps that integrate with Online Store 2.0 themes, should use theme app extensions, such as app blocks or app embed blocks. Script tags are an alternative you can use with only vintage themes. <a href="/apps/online-store#what-integration-method-should-i-use" target="_blank">Learn more</a>.</p></div> <div class="note"><h4>Script tag deprecation</h4> <p>Script tags will be sunset for the <b>Order status</b> page on August 28, 2025. <a href="https://www.shopify.com/plus/upgrading-to-checkout-extensibility">Upgrade to Checkout Extensibility</a> before this date. <a href="/docs/api/liquid/objects#script">Shopify Scripts</a> will continue to work alongside Checkout Extensibility until August 28, 2025.</p></div> Creates a new script tag.
• scriptTagDelete <div class="note"><h4>Theme app extensions</h4> <p>Your app might not pass App Store review if it uses script tags instead of theme app extensions. All new apps, and apps that integrate with Online Store 2.0 themes, should use theme app extensions, such as app blocks or app embed blocks. Script tags are an alternative you can use with only vintage themes. <a href="/apps/online-store#what-integration-method-should-i-use" target="_blank">Learn more</a>.</p></div> <div class="note"><h4>Script tag deprecation</h4> <p>Script tags will be sunset for the <b>Order status</b> page on August 28, 2025. <a href="https://www.shopify.com/plus/upgrading-to-checkout-extensibility">Upgrade to Checkout Extensibility</a> before this date. <a href="/docs/api/liquid/objects#script">Shopify Scripts</a> will continue to work alongside Checkout Extensibility until August 28, 2025.</p></div> Deletes a script tag.
• scriptTagUpdate <div class="note"><h4>Theme app extensions</h4> <p>Your app might not pass App Store review if it uses script tags instead of theme app extensions. All new apps, and apps that integrate with Online Store 2.0 themes, should use theme app extensions, such as app blocks or app embed blocks. Script tags are an alternative you can use with only vintage themes. <a href="/apps/online-store#what-integration-method-should-i-use" target="_blank">Learn more</a>.</p></div> <div class="note"><h4>Script tag deprecation</h4> <p>Script tags will be sunset for the <b>Order status</b> page on August 28, 2025. <a href="https://www.shopify.com/plus/upgrading-to-checkout-extensibility">Upgrade to Checkout Extensibility</a> before this date. <a href="/docs/api/liquid/objects#script">Shopify Scripts</a> will continue to work alongside Checkout Extensibility until August 28, 2025.</p></div> Updates a script tag.
• segmentCreate Creates a segment.
• segmentDelete Deletes a segment.
• segmentUpdate Updates a segment.
• shippingPackageDelete Deletes a shipping package.
• shippingPackageMakeDefault Set a shipping package as the default. The default shipping package is the one used to calculate shipping costs on checkout.
• shippingPackageUpdate Updates a shipping package.
• shopLocaleDisable Deletes a locale for a shop. This also deletes all translations of this locale.
• shopLocaleEnable Adds a locale for a shop. The newly added locale is in the unpublished state.
• shopLocaleUpdate Updates a locale for a shop.
• stagedUploadTargetGenerate Generates the URL and signed paramaters needed to upload an asset to Shopify.
• stagedUploadTargetsGenerate Uploads multiple images.
• stagedUploadsCreate 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](https://shopify.dev/apps/online-store/media/products#step-1-upload-media-to-shopify).
• storefrontAccessTokenCreate Creates a storefront access token for use with the [Storefront API](https://shopify.dev/docs/api/storefront). An app can have a maximum of 100 active storefront access tokens for each shop. [Get started with the Storefront API](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/getting-started).
• storefrontAccessTokenDelete Deletes a storefront access token.
• tagsAdd Add tags to an order, a draft order, a customer, a product, or an online store article.
• tagsRemove Remove tags from an order, a draft order, a customer, a product, or an online store article.
• urlRedirectBulkDeleteAll Asynchronously delete [URL redirects](https://shopify.dev/api/admin-graphql/latest/objects/UrlRedirect) in bulk.
• webhookSubscriptionCreate 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](https://shopify.dev/docs/apps/build/webhooks/subscribe).
• webhookSubscriptionDelete 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](https://shopify.dev/docs/apps/build/webhooks/subscribe).
• webhookSubscriptionUpdate 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](https://shopify.dev/docs/apps/build/webhooks/subscribe).

Related Unions

Examples