UserError - storefront - OBJECT

Version: 2024-04

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

  • checkoutAttributesUpdateV2 Updates the attributes of a checkout if `allowPartialAddresses` is `true`.
  • checkoutCompleteFree Completes a checkout without providing payment information. You can use this mutation for free items or items whose purchase price is covered by a gift card.
  • checkoutCompleteWithCreditCardV2 Completes a checkout using a credit card token from Shopify's card vault. Before you can complete checkouts using CheckoutCompleteWithCreditCardV2, you need to [_request payment processing_](https://shopify.dev/apps/channels/getting-started#request-payment-processing).
  • checkoutCompleteWithTokenizedPaymentV3 Completes a checkout with a tokenized payment.
  • checkoutCreate Creates a new checkout.
  • checkoutCustomerAssociateV2 Associates a customer to the checkout.
  • checkoutCustomerDisassociateV2 Disassociates the current checkout customer from the checkout.
  • checkoutDiscountCodeApplyV2 Applies a discount to an existing checkout using a discount code.
  • checkoutDiscountCodeRemove Removes the applied discounts from an existing checkout.
  • checkoutEmailUpdateV2 Updates the email on an existing checkout.
  • checkoutGiftCardRemoveV2 Removes an applied gift card from the checkout.
  • checkoutGiftCardsAppend Appends gift cards to an existing checkout.
  • checkoutLineItemsAdd Adds a list of line items to a checkout.
  • checkoutLineItemsRemove Removes line items from an existing checkout.
  • checkoutLineItemsUpdate Updates line items on a checkout.
  • checkoutShippingAddressUpdateV2 Updates the shipping address of an existing checkout.
  • checkoutShippingLineUpdate Updates the shipping lines on an existing checkout.
  • customerAccessTokenCreate Creates a customer access token. The customer access token is required to modify the customer object in any way.
  • customerAccessTokenDelete Permanently destroys a customer access token.
  • customerAccessTokenRenew Renews a customer access token. Access token renewal must happen *before* a token expires. If a token has already expired, a new one should be created instead via `customerAccessTokenCreate`.
  • customerActivate Activates a customer.
  • customerAddressCreate Creates a new address for a customer.
  • customerAddressDelete Permanently deletes the address of an existing customer.
  • customerAddressUpdate Updates the address of an existing customer.
  • customerCreate Creates a new customer.
  • customerDefaultAddressUpdate Updates the default address of an existing customer.
  • customerRecover Sends a reset password email to the customer. The reset password email contains a reset password URL and token that you can pass to the [`customerResetByUrl`](https://shopify.dev/api/storefront/latest/mutations/customerResetByUrl) or [`customerReset`](https://shopify.dev/api/storefront/latest/mutations/customerReset) mutation to reset the customer password. This mutation is throttled by IP. With private access, you can provide a [`Shopify-Storefront-Buyer-IP`](https://shopify.dev/api/usage/authentication#optional-ip-header) instead of the request IP. The header is case-sensitive and must be sent as `Shopify-Storefront-Buyer-IP`. Make sure that the value provided to `Shopify-Storefront-Buyer-IP` is trusted. Unthrottled access to this mutation presents a security risk.
  • customerResetByUrl "Resets a customer’s password with the reset password URL received from a reset password email. You can send a reset password email with the [`customerRecover`](https://shopify.dev/api/storefront/latest/mutations/customerRecover) mutation."
  • customerReset "Resets a customer’s password with the token received from a reset password email. You can send a reset password email with the [`customerRecover`](https://shopify.dev/api/storefront/latest/mutations/customerRecover) mutation."
  • customerUpdate Updates an existing customer.

Related Unions

Examples