/
Guides
API reference
search
Search
Close search
Change color mode. Active mode is light.
Open search
UserError
Interface
Shared fields implemented by user error types.
#
Fields
message
•
String!
#
Implementations
AddressAlreadyExistsError
•
AddressAlreadyExistsError
AddressNotFoundError
•
AddressNotFoundError
AttributeAssignmentFailedError
•
AttributeAssignmentFailedError
AttributeInUseError
•
AttributeInUseError
AttributeNotFoundError
•
AttributeNotFoundError
AttributeValueTakenError
•
AttributeValueTakenError
AttributeValueTypeMismatchError
•
AttributeValueTypeMismatchError
AttributeValuesInUseError
•
AttributeValuesInUseError
BulkOperationLimitExceededError
•
BulkOperationLimitExceededError
BulkUpdateValidationFailedError
•
BulkUpdateValidationFailedError
CartCustomLineItemInvalidInputError
•
CartCustomLineItemInvalidInputError
CartDiscountCodesInvalidValidityPeriodError
•
CartDiscountCodesInvalidValidityPeriodError
CartDiscountCodesNotFoundError
•
CartDiscountCodesNotFoundError
CartDiscountGroupNotFoundError
•
CartDiscountGroupNotFoundError
CartDiscountInvalidPredicateError
•
CartDiscountInvalidPredicateError
CartDiscountInvalidValidityPeriodError
•
CartDiscountInvalidValidityPeriodError
CartDiscountNotFoundError
•
CartDiscountNotFoundError
CartDiscountValidityPeriodMustHaveBothValuesError
•
CartDiscountValidityPeriodMustHaveBothValuesError
CartLineItemsNotFoundError
•
CartLineItemsNotFoundError
CartNotFoundError
•
CartNotFoundError
CategoryNotFoundError
•
CategoryNotFoundError
ChannelNotFoundError
•
ChannelNotFoundError
CheckoutDomainAlreadyConfiguredError
•
CheckoutDomainAlreadyConfiguredError
CheckoutDomainHostnameAlreadyExistsError
•
CheckoutDomainHostnameAlreadyExistsError
CheckoutDomainNotFoundError
•
CheckoutDomainNotFoundError
CheckoutSettingsInvalidInputError
•
CheckoutSettingsInvalidInputError
CollectionNotFoundError
•
CollectionNotFoundError
CreateStripeGatewayFailedError
•
CreateStripeGatewayFailedError
CustomerAccountCreationFailedError
•
CustomerAccountCreationFailedError
CustomerGroupNotFoundError
•
CustomerGroupNotFoundError
CustomerGroupsNotFoundError
•
CustomerGroupsNotFoundError
CustomerMetafieldSyncFailedError
•
CustomerMetafieldSyncFailedError
CustomerMissingEmailError
•
CustomerMissingEmailError
CustomerNotFoundError
•
CustomerNotFoundError
DuplicateInventoryEntriesError
•
DuplicateInventoryEntriesError
DuplicateMetafieldDefinitionError
•
DuplicateMetafieldDefinitionError
DuplicateSkuError
•
DuplicateSkuError
DuplicateSlugError
•
DuplicateSlugError
DuplicateVariantCombinationError
•
DuplicateVariantCombinationError
EmailAlreadyInUseError
•
EmailAlreadyInUseError
ExactlyOneOfTwoRequiredError
•
ExactlyOneOfTwoRequiredError
ExportLocaleNotEnabledError
•
ExportLocaleNotEnabledError
ExportRequiresAuthenticatedUserError
•
ExportRequiresAuthenticatedUserError
ExternalTaxConfigurationInvalidExternalApiUrlError
•
ExternalTaxConfigurationInvalidExternalApiUrlError
ExternalTaxConfigurationNotFoundError
•
ExternalTaxConfigurationNotFoundError
FacetNotFoundError
•
FacetNotFoundError
FacetValueDoesNotExistError
•
FacetValueDoesNotExistError
FileSizeLimitExceededError
•
FileSizeLimitExceededError
FulfillmentInvalidLinesError
•
FulfillmentInvalidLinesError
FulfillmentInvalidUpdateError
•
FulfillmentInvalidUpdateError
FulfillmentNotFoundError
•
FulfillmentNotFoundError
ImportEmptyFileError
•
ImportEmptyFileError
ImportFileTooLargeError
•
ImportFileTooLargeError
ImportInvalidCsvFormatError
•
ImportInvalidCsvFormatError
ImportRequiresAuthenticatedUserError
•
ImportRequiresAuthenticatedUserError
ImportUnsupportedFileTypeError
•
ImportUnsupportedFileTypeError
InvalidAllocatedQuantityError
•
InvalidAllocatedQuantityError
InvalidAllocationStrategyError
•
InvalidAllocationStrategyError
InvalidDistributionChannelsError
•
InvalidDistributionChannelsError
InvalidExportLocaleError
•
InvalidExportLocaleError
InvalidInventoryQuantityError
•
InvalidInventoryQuantityError
InvalidInventorySupplyChannelsError
•
InvalidInventorySupplyChannelsError
InvalidPasswordError
•
InvalidPasswordError
InvalidPriceChannelsError
•
InvalidPriceChannelsError
InvalidSlugError
•
InvalidSlugError
InvalidSupplyChannelsError
•
InvalidSupplyChannelsError
InvalidTranslationLocaleError
•
InvalidTranslationLocaleError
InvalidUrlError
•
InvalidUrlError
InventoryEntriesHaveAllocatedQuantityError
•
InventoryEntriesHaveAllocatedQuantityError
InventoryEntriesNotFoundError
•
InventoryEntriesNotFoundError
InventoryEntryHasAllocatedQuantityError
•
InventoryEntryHasAllocatedQuantityError
InventoryEntryNotFoundError
•
InventoryEntryNotFoundError
LocaleCodeAlreadyExistsError
•
LocaleCodeAlreadyExistsError
LocaleNotFoundError
•
LocaleNotFoundError
MaxLengthExceededError
•
MaxLengthExceededError
MediaNotFoundError
•
MediaNotFoundError
MetafieldDefinitionNotFoundError
•
MetafieldDefinitionNotFoundError
MetafieldDefinitionOwnerTypeMismatchError
•
MetafieldDefinitionOwnerTypeMismatchError
MetafieldMutationFailedError
•
MetafieldMutationFailedError
NoEventsProvidedError
•
NoEventsProvidedError
OneOfExpectationError
•
OneOfExpectationError
OrderAlreadyHasCustomerError
•
OrderAlreadyHasCustomerError
OrderCustomerNotFoundError
•
OrderCustomerNotFoundError
OrderHasNoCustomerError
•
OrderHasNoCustomerError
OrderNotFoundError
•
OrderNotFoundError
PasswordResetTokenCustomerNotFoundError
•
PasswordResetTokenCustomerNotFoundError
PasswordResetTokenGenerationFailedError
•
PasswordResetTokenGenerationFailedError
PaymentGatewayCancelFailedError
•
PaymentGatewayCancelFailedError
PaymentGatewayCancelInvalidStatusError
•
PaymentGatewayCancelInvalidStatusError
PaymentGatewayCaptureFailedError
•
PaymentGatewayCaptureFailedError
PaymentGatewayInvalidPredicateError
•
PaymentGatewayInvalidPredicateError
PaymentGatewayNotFoundError
•
PaymentGatewayNotFoundError
PaymentGatewayPaymentNotFoundError
•
PaymentGatewayPaymentNotFoundError
PaymentGatewayRefundFailedError
•
PaymentGatewayRefundFailedError
PaymentGatewayRefundInsufficientBalanceError
•
PaymentGatewayRefundInsufficientBalanceError
ProductAttributeNotFoundError
•
ProductAttributeNotFoundError
ProductAttributeValueNotFoundError
•
ProductAttributeValueNotFoundError
ProductDiscountNotFoundError
•
ProductDiscountNotFoundError
ProductDiscountValueRequiredError
•
ProductDiscountValueRequiredError
ProductNotFoundError
•
ProductNotFoundError
ProductTranslationNotFoundError
•
ProductTranslationNotFoundError
ProductVariantNotFoundError
•
ProductVariantNotFoundError
ProductVariantPriceMutationError
•
ProductVariantPriceMutationError
ProductVariantPriceNotFoundError
•
ProductVariantPriceNotFoundError
ProductVariantsBulkDomainErrorError
•
ProductVariantsBulkDomainErrorError
ShippingMethodNotFoundError
•
ShippingMethodNotFoundError
ShippingMethodRateNotFoundGraphqlError
•
ShippingMethodRateNotFoundGraphqlError
ShippingMethodRateReorderShippingMethodNotFoundGraphqlError
•
ShippingMethodRateReorderShippingMethodNotFoundGraphqlError
ShippingZoneNotFoundError
•
ShippingZoneNotFoundError
StoreNotFoundError
•
StoreNotFoundError
TranslationLocaleNotEnabledError
•
TranslationLocaleNotEnabledError
TranslationUpsertFailedError
•
TranslationUpsertFailedError
UnsupportedTranslatableEntityError
•
UnsupportedTranslatableEntityError
UpdateCartLineItemsInsufficientStockError
•
UpdateCartLineItemsInsufficientStockError
UpdateProductDiscountDomainValidationFailureError
•
UpdateProductDiscountDomainValidationFailureError
UpdateProductDiscountInvalidPredicateError
•
UpdateProductDiscountInvalidPredicateError
WebhookDeliveryCannotResendError
•
WebhookDeliveryCannotResendError
WebhookDeliveryNotFoundError
•
WebhookDeliveryNotFoundError
WebhookSubscriptionNotFoundError
•
WebhookSubscriptionNotFoundError
Introduction
Project routing
Authentication
IDs and pagination
Errors
Admin API quickstart
Catalog visibility
Localization and metafields
Pagination, bulk operations, and sync jobs
Pricing, inventory, and tax
Webhooks
Attributes
Cart discounts
Categories
Channels
Collections
Common
Customers
Identity
Objects
Interfaces
UserError
Orders
Payment gateways
Product discounts
Products
Shipping