For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Docs API Reference Learn Community Changelog

Docs API Reference Learn Community Changelog

- About Our APIs
- Download OpenAPI Specs
REST
GraphQL
MCP
Resources

GraphQL Storefront Types Interfaces

Error

INTERFACE

Definition

1 interface Error {
2   message: String!
3 }

An error object, indicating what went wrong with a mutation.

Was this page helpful?

CustomerFormFieldValue

ExtraFieldValue

Fields

messageStringRequired

A description of the error in user language.

Implemented by

AccountCreationDisabledError
AddressDoesNotExistError
AlreadyExistsError
CartError
CartLineItemError
CartUnassignInaccessibleError
CartUnassignNotAllowedError
CheckoutBillingAddressError
CheckoutCouponError
CheckoutShippingConsignmentError
CheckoutTaxError
CreatePaymentWalletIntentGenericError
CreateSubscriberAlreadyExistsError
CreateSubscriberEmailInvalidError
CreateSubscriberFirstNameInvalidError
CreateSubscriberLastNameInvalidError
CreateSubscriberUnexpectedError
CreateVaultAccessTokenError
CustomerAddressCreationError
CustomerAddressDeletionError
CustomerAddressUpdateError
CustomerAlreadyReviewedProductError
CustomerDoesNotExistError
CustomerNotLoggedInError
CustomerPasswordError
CustomerRegistrationError
DeleteStoredPaymentInstrumentError
EmailAlreadyInUseError
GenerateSessionSyncTokenCartNotFound
InvalidInputFieldsError
InvalidSessionSyncJwtError
JwtTokenExpiredError
LimitExceededError
LocaleInvalidError
NotAuthorisedError
NotAuthorizedToAddProductReviewError
NotFoundError
ProductIdNotFoundError
RemoveSubscriberEmailInvalidError
RemoveSubscriberUnexpectedError
UnexpectedAddReviewError
UnexpectedUpdateCustomerError
UpdateStoredPaymentInstrumentError
ValidationError