Docs
Dashboard

UserError

Interface

Shared fields implemented by user error types.

#

Fields


message
String!

The message associated with this user error.

#

Implementations


AddressAlreadyExistsError
AddressAlreadyExistsError

An identical address already exists for this customer.

AddressNotFoundError
AddressNotFoundError

The address with the specified ID was not found.

AttributeAssignmentFailedError
AttributeAssignmentFailedError

Represents an error raised when assigning an attribute to a product fails.

AttributeInUseError
AttributeInUseError

Represents an error that occurs when attempting to modify or delete an attribute that is currently in use.

AttributeNotFoundError
AttributeNotFoundError

Represents an error that occurs when a requested product attribute cannot be found.

AttributeValueTakenError
AttributeValueTakenError

Represents an error that occurs when an attribute value is already taken or in use.

AttributeValueTypeMismatchError
AttributeValueTypeMismatchError

Error class representing a type mismatch in attribute values.

AttributeValuesInUseError
AttributeValuesInUseError

Represents an error that occurs when attempting to modify or delete attribute values that are currently in use.

BulkOperationLimitExceededError
BulkOperationLimitExceededError

Fields returned for bulk operation limit exceeded error.

BulkUpdateValidationFailedError
BulkUpdateValidationFailedError

One or more inventory entries failed validation during bulk update.

CartCustomLineItemInvalidInputError
CartCustomLineItemInvalidInputError

Thrown when custom line item input is invalid.

CartDiscountCodesInvalidValidityPeriodError
CartDiscountCodesInvalidValidityPeriodError

Raised when the validity period of a cart discount code is invalid.

CartDiscountCodesNotFoundError
CartDiscountCodesNotFoundError

Raised when a cart discount code is not found.

CartDiscountGroupNotFoundError
CartDiscountGroupNotFoundError

Raised when a cart discount group is not found.

CartDiscountInvalidPredicateError
CartDiscountInvalidPredicateError

Raised when a cart discount predicate is invalid.

CartDiscountInvalidValidityPeriodError
CartDiscountInvalidValidityPeriodError

Raised when the validity period of a cart discount is invalid.

CartDiscountNotFoundError
CartDiscountNotFoundError

Raised when a cart discount is not found.

CartDiscountTargetRequiredError
CartDiscountTargetRequiredError

Raised when the target-specific input for a cart discount is missing.

CartDiscountValidityPeriodMustHaveBothValuesError
CartDiscountValidityPeriodMustHaveBothValuesError

Raised when only one of validFrom or validUntil is provided.

CartDiscountValueRequiredError
CartDiscountValueRequiredError

Raised when a cart discount value input is missing.

CartLineItemsNotFoundError
CartLineItemsNotFoundError

Thrown when one or more line items cannot be resolved.

CartNotFoundError
CartNotFoundError

Thrown when a cart cannot be resolved.

CategoryNotFoundError
CategoryNotFoundError

Represents an error that occurs when a category is not found.

ChannelNotFoundError
ChannelNotFoundError

Raised when a channel is not found.

CheckoutDomainAlreadyConfiguredError
CheckoutDomainAlreadyConfiguredError

Raised when a checkout domain is already configured.

CheckoutDomainHostnameAlreadyExistsError
CheckoutDomainHostnameAlreadyExistsError

Raised when a domain hostname is already configured.

CheckoutDomainNotFoundError
CheckoutDomainNotFoundError

Raised when no checkout domain is configured.

CheckoutSettingsInvalidInputError
CheckoutSettingsInvalidInputError

Raised when checkout settings input is invalid.

CollectionNotFoundError
CollectionNotFoundError

Represents an error that occurs when a collection is not found.

CreateStripeGatewayFailedError
CreateStripeGatewayFailedError

Raised when creating a Stripe gateway fails.

CustomerAccountCreationFailedError
CustomerAccountCreationFailedError

Customer account creation failed.

CustomerGroupNotFoundError
CustomerGroupNotFoundError

The customer with the specified ID was not found.

CustomerGroupsNotFoundError
CustomerGroupsNotFoundError

One or more customer groups referenced on update could not be found.

CustomerMetafieldSyncFailedError
CustomerMetafieldSyncFailedError

Raised when customer metafields could not be synchronized to the catalog service.

CustomerMissingEmailError
CustomerMissingEmailError

The customer does not have an email address.

CustomerNotFoundError
CustomerNotFoundError

The customer with the specified ID was not found.

DraftOrderCustomerNotFoundError
DraftOrderCustomerNotFoundError

Fields returned for draft order customer not found error.

DraftOrderDiscountCodeNotFoundError
DraftOrderDiscountCodeNotFoundError

Fields returned for draft order discount code not found error.

DraftOrderInvalidInputError
DraftOrderInvalidInputError

Fields returned for draft order invalid input error.

DraftOrderMetafieldSyncFailedError
DraftOrderMetafieldSyncFailedError

Fields returned for draft order metafield sync failed error.

DraftOrderNotFoundError
DraftOrderNotFoundError

Fields returned for draft order not found error.

DraftOrderPlacementError
DraftOrderPlacementError

Fields returned for draft order placement error.

DraftOrderPriceNotFoundError
DraftOrderPriceNotFoundError

Fields returned for draft order price not found error.

DraftOrderStoreNotFoundError
DraftOrderStoreNotFoundError

Fields returned for draft order store not found error.

DraftOrderVariantNotFoundError
DraftOrderVariantNotFoundError

Fields returned for draft order variant not found error.

DuplicateInventoryEntriesError
DuplicateInventoryEntriesError

Duplicate inventory entries were detected (same SKU and supply channel combination).

DuplicateMetafieldDefinitionError
DuplicateMetafieldDefinitionError

Fields returned for duplicate metafield definition error.

DuplicatePublishableChannelError
DuplicatePublishableChannelError

One publishable contains more than one publication update for the same channel.

DuplicatePublishableError
DuplicatePublishableError

The same product or product variant appears more than once in a bulk request.

DuplicateSkuError
DuplicateSkuError

Represents an error that occurs when attempting to use SKUs that are already taken.

DuplicateSlugError
DuplicateSlugError

Represents an error that occurs when a slug is already taken.

DuplicateVariantCombinationError
DuplicateVariantCombinationError

Represents an error that occurs when a duplicate variant combination is detected.

EmailAlreadyInUseError
EmailAlreadyInUseError

The email address is already in use.

ExactlyOneOfTwoRequiredError
ExactlyOneOfTwoRequiredError

Represents an error that occurs when exactly one of two required fields must be provided, but the validation fails.

ExportLocaleNotEnabledError
ExportLocaleNotEnabledError

Indicates the request specified a locale that is not enabled for the tenant.

ExportRequiresAuthenticatedUserError
ExportRequiresAuthenticatedUserError

Indicates the request could not be associated with an authenticated user with an email address.

ExternalTaxConfigurationInvalidExternalApiUrlError
ExternalTaxConfigurationInvalidExternalApiUrlError

Raised when an external tax configuration URL is invalid.

ExternalTaxConfigurationNotFoundError
ExternalTaxConfigurationNotFoundError

Represents an error that occurs when an external tax configuration is not found.

FacetFieldInvalidError
FacetFieldInvalidError

Thrown when a facet field configuration is invalid.

FacetMutationFailedError
FacetMutationFailedError

Thrown when a facet layout change is invalid.

FacetNotFoundError
FacetNotFoundError

Thrown when a facet cannot be resolved.

FacetValueDoesNotExistError
FacetValueDoesNotExistError

Thrown when a facet value does not exist.

FileSizeLimitExceededError
FileSizeLimitExceededError

Represents an error that occurs when a file size exceeds the allowed limit.

FulfillmentInvalidLinesError
FulfillmentInvalidLinesError

The fulfillment lines provided are invalid.

FulfillmentInvalidUpdateError
FulfillmentInvalidUpdateError

The fulfillment update request was invalid.

FulfillmentNotFoundError
FulfillmentNotFoundError

The fulfillment with the specified ID was not found.

ImportEmptyFileError
ImportEmptyFileError

Indicates the uploaded file is empty.

ImportFileTooLargeError
ImportFileTooLargeError

Indicates the uploaded file exceeds the import size limit.

ImportInvalidCsvFormatError
ImportInvalidCsvFormatError

Indicates the uploaded CSV is missing required columns or is not a valid CSV.

ImportRequiresAuthenticatedUserError
ImportRequiresAuthenticatedUserError

Indicates the request could not be associated with an authenticated user with an email address.

ImportUnsupportedFileTypeError
ImportUnsupportedFileTypeError

Indicates the uploaded file has an unsupported content type.

InvalidAllocatedQuantityError
InvalidAllocatedQuantityError

Invalid allocated quantity for inventory entry.

InvalidAllocationStrategyError
InvalidAllocationStrategyError

Invalid allocation strategy for inventory entry.

InvalidDistributionChannelsError
InvalidDistributionChannelsError

One or more distribution channels are invalid for the store.

InvalidExportLocaleError
InvalidExportLocaleError

Indicates the request specified a locale that is not a valid BCP 47 language tag.

InvalidInventoryQuantityError
InvalidInventoryQuantityError

Invalid quantity value provided for inventory entry.

InvalidInventorySupplyChannelsError
InvalidInventorySupplyChannelsError

One or more supply channels are invalid for the inventory entries.

InvalidPasswordError
InvalidPasswordError

The provided password is invalid.

InvalidPriceChannelsError
InvalidPriceChannelsError

One or more price channels are invalid for the store.

InvalidPublicationChannelError
InvalidPublicationChannelError

A publication update contains an ID that does not identify a sales channel.

InvalidSlugError
InvalidSlugError

Represents an exception that is thrown when an invalid slug is encountered.

InvalidSupplyChannelsError
InvalidSupplyChannelsError

One or more supply channels are invalid for the store.

InvalidTranslationLocaleError
InvalidTranslationLocaleError

Represents a translation request with an invalid locale code.

InvalidUrlError
InvalidUrlError

The provided URL is invalid or not accessible.

InventoryEntriesHaveAllocatedQuantityError
InventoryEntriesHaveAllocatedQuantityError

Cannot delete inventory entries because they have allocated quantities.

InventoryEntriesNotFoundError
InventoryEntriesNotFoundError

One or more inventory entries with the specified IDs were not found.

InventoryEntryHasAllocatedQuantityError
InventoryEntryHasAllocatedQuantityError

Cannot delete inventory entry because it has allocated quantity.

InventoryEntryNotFoundError
InventoryEntryNotFoundError

The inventory entry with the specified ID was not found.

LocaleCodeAlreadyExistsError
LocaleCodeAlreadyExistsError

Raised when a locale code is already used by another locale.

LocaleNotFoundError
LocaleNotFoundError

Raised when a locale is not found.

MaxLengthExceededError
MaxLengthExceededError

Fields returned for max length exceeded error.

MediaDeleteInvalidInputError
MediaDeleteInvalidInputError

Thrown when a media deletion request is invalid.

MediaDeleteNotFoundError
MediaDeleteNotFoundError

Thrown when one or more media items requested for deletion cannot be found.

MediaNotFoundError
MediaNotFoundError

Represents an error that occurs when a requested media item cannot be found.

MediaUpdateInvalidError
MediaUpdateInvalidError

Thrown when a media update contains invalid metadata.

MetafieldDefinitionNotFoundError
MetafieldDefinitionNotFoundError

Fields returned for metafield definition not found error.

MetafieldDefinitionOwnerTypeMismatchError
MetafieldDefinitionOwnerTypeMismatchError

Fields returned for metafield definition owner type mismatch error.

MetafieldMutationFailedError
MetafieldMutationFailedError

Fields returned for metafield mutation failed error.

NoEventsProvidedError
NoEventsProvidedError

No events were provided for the webhook subscription.

OneOfExpectationError
OneOfExpectationError

Fields returned for one of expectation error.

OrderAlreadyHasCustomerError
OrderAlreadyHasCustomerError

The order already has a customer assigned.

OrderCustomerNotFoundError
OrderCustomerNotFoundError

The customer with the specified ID was not found.

OrderHasNoCustomerError
OrderHasNoCustomerError

The order does not have a customer assigned.

OrderMetafieldSyncFailedError
OrderMetafieldSyncFailedError

Raised when order metafields could not be synchronized to the catalog service.

OrderNotFoundError
OrderNotFoundError

The order with the specified ID was not found.

PasswordResetTokenCustomerNotFoundError
PasswordResetTokenCustomerNotFoundError

Password reset token generation could not find the customer account.

PasswordResetTokenGenerationFailedError
PasswordResetTokenGenerationFailedError

Password reset token generation failed for the requested customer.

PaymentGatewayCancelFailedError
PaymentGatewayCancelFailedError

Raised when cancelling a payment fails for other reasons.

PaymentGatewayCancelInvalidStatusError
PaymentGatewayCancelInvalidStatusError

Raised when cancelling a payment is invalid due to current status.

PaymentGatewayCaptureFailedError
PaymentGatewayCaptureFailedError

Raised when capturing a payment via a gateway fails.

PaymentGatewayInvalidPredicateError
PaymentGatewayInvalidPredicateError

Raised when a payment gateway predicate is invalid.

PaymentGatewayNotFoundError
PaymentGatewayNotFoundError

Raised when a payment gateway is not found.

PaymentGatewayPaymentNotFoundError
PaymentGatewayPaymentNotFoundError

Raised when a payment identified by PSP reference cannot be found.

PaymentGatewayRefundFailedError
PaymentGatewayRefundFailedError

Raised when refunding a payment fails for other reasons.

PaymentGatewayRefundInsufficientBalanceError
PaymentGatewayRefundInsufficientBalanceError

Raised when refunding a payment fails due to insufficient refundable balance.

ProductAttributeNotFoundError
ProductAttributeNotFoundError

Fields returned for product attribute not found error.

ProductAttributeValueNotFoundError
ProductAttributeValueNotFoundError

Fields returned for product attribute value not found error.

ProductDiscountNotFoundError
ProductDiscountNotFoundError

Raised when a product discount cannot be found.

ProductDiscountValueRequiredError
ProductDiscountValueRequiredError

Raised when a discount value input is missing.

ProductNotFoundError
ProductNotFoundError

Represents an error indicating that a product was not found.

ProductTranslationNotFoundError
ProductTranslationNotFoundError

Raised when a product translation is not found.

ProductVariantNotFoundError
ProductVariantNotFoundError

Fields returned for product variant not found error.

ProductVariantPriceMutationError
ProductVariantPriceMutationError

Raised when a product variant price mutation fails validation.

ProductVariantPriceNotFoundError
ProductVariantPriceNotFoundError

Raised when a product variant price cannot be found.

ProductVariantPublicationsLinkedError
ProductVariantPublicationsLinkedError

The product variant cannot be published independently because variant publications are linked to the product.

ProductVariantsBulkDomainErrorError
ProductVariantsBulkDomainErrorError

Raised when bulk product variant creation returns a domain error.

PublishableNotFoundError
PublishableNotFoundError

The requested product or product variant could not be found.

ShippingMethodNotFoundError
ShippingMethodNotFoundError

Represents an error that occurs when a shipping method is not found.

ShippingMethodRateNotFoundGraphqlError
ShippingMethodRateNotFoundGraphqlError

Raised when a shipping method rate is not found.

ShippingMethodRateReorderShippingMethodNotFoundGraphqlError
ShippingMethodRateReorderShippingMethodNotFoundGraphqlError

Raised when a shipping method is not found during rate reordering.

ShippingZoneNotFoundError
ShippingZoneNotFoundError

Represents an error that occurs when a shipping zone is not found.

StoreNotFoundError
StoreNotFoundError

The store with the specified ID was not found.

TranslationLocaleNotEnabledError
TranslationLocaleNotEnabledError

Represents a translation request for a locale that is not enabled.

TranslationUpsertFailedError
TranslationUpsertFailedError

Represents a failed translation upsert operation.

UnsupportedPublishableTypeError
UnsupportedPublishableTypeError

The supplied typed ID identifies a resource that is not publishable through this API.

UnsupportedTranslatableEntityError
UnsupportedTranslatableEntityError

Represents an unsupported translatable entity type.

UpdateCartLineItemsInsufficientStockError
UpdateCartLineItemsInsufficientStockError

Thrown when updating line items exceeds available stock.

UpdateProductDiscountDomainValidationFailureError
UpdateProductDiscountDomainValidationFailureError

Raised when updating a product discount fails domain validation.

UpdateProductDiscountInvalidPredicateError
UpdateProductDiscountInvalidPredicateError

Raised when updating a product discount has an invalid predicate.

VatRateOverrideConflictError
VatRateOverrideConflictError

Raised when VAT-rate override effective periods overlap.

VatRateOverrideInvalidError
VatRateOverrideInvalidError

Raised when VAT-rate override input is invalid.

VatRateOverrideNotFoundError
VatRateOverrideNotFoundError

Raised when a VAT-rate override cannot be found.

WebhookDeliveryCannotResendError
WebhookDeliveryCannotResendError

The webhook delivery cannot be resent due to its current state or business rules.

WebhookDeliveryNotFoundError
WebhookDeliveryNotFoundError

The webhook delivery with the specified ID was not found.

WebhookSubscriptionNotFoundError
WebhookSubscriptionNotFoundError

The webhook subscription with the specified ID was not found.