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.

CartAddDiscountCodeNotFoundError
CartAddDiscountCodeNotFoundError

This exception is thrown when adding a discount code fails because it was not found.

CartAuthenticationFailedError
CartAuthenticationFailedError

This exception is thrown when cart authentication fails.

CartAuthorizationFailedError
CartAuthorizationFailedError

This exception is thrown when cart authorization fails.

CartCompletionDiscountCodeAlreadyUsedError
CartCompletionDiscountCodeAlreadyUsedError

This exception is thrown when completing a cart fails because a discount code was already used.

CartCompletionDiscrepancyError
CartCompletionDiscrepancyError

This exception is thrown when the cart completion detects a discrepancy between cart and order totals.

CartCustomLineItemInvalidInputError
CartCustomLineItemInvalidInputError

This exception is thrown when custom line item input is invalid.

CartDiscountCodeMaxApplicationsReachedError
CartDiscountCodeMaxApplicationsReachedError

The exception is thrown when the maximum number of applications for a discount code has been reached.

CartLineItemPriceNotFoundError
CartLineItemPriceNotFoundError

This exception is thrown when price lookup fails for a line item variant.

CartLineItemUnavailableForPurchase
CartLineItemUnavailableForPurchase

This exception is thrown when a variant or its parent product is unavailable for purchase.

CartLineItemsInsufficientStockError
CartLineItemsInsufficientStockError

This exception is thrown when one or more requested line items do not have enough stock.

CartLineItemsNotFoundError
CartLineItemsNotFoundError

This exception is thrown when updating line items fails due to missing line items.

CartNotFoundError
CartNotFoundError

This exception is thrown when a cart with the specified ID cannot be found.

CartReplicateStrictValidationFailedError
CartReplicateStrictValidationFailedError

This exception is thrown when a cart cannot be replicated due to strict validation failures.

CartShippingLineNotFoundError
CartShippingLineNotFoundError

This exception is thrown when a cart shipping line with the specified ID cannot be found.

CartUpdatePriceChannelNotFoundError
CartUpdatePriceChannelNotFoundError

This exception is thrown when a price channel with the specified ID cannot be found or is not a valid price channel during cart update.

CreateCartAddressDoesNotHaveCountryCodeError
CreateCartAddressDoesNotHaveCountryCodeError

This exception is thrown when an address is not null, but does not have a country code.

CreateCartAuthenticationFailedError
CreateCartAuthenticationFailedError

This exception is thrown when cart authentication fails.

CreateCartAuthorizationFailedError
CreateCartAuthorizationFailedError

This exception is thrown when cart authorization fails.

CreateCartChannelDoesNotSupportCountryError
CreateCartChannelDoesNotSupportCountryError

This exception is thrown when a channel does not support the specified country.

CreateCartChannelDoesNotSupportCurrencyError
CreateCartChannelDoesNotSupportCurrencyError

This exception is thrown when a channel does not support the specified currency.

CreateCartChannelHasNoCountriesError
CreateCartChannelHasNoCountriesError

This exception is thrown when a channel has no countries defined.

CreateCartChannelNotFoundError
CreateCartChannelNotFoundError

This exception is thrown when a channel with the specified ID cannot be found.

CreateCartPriceChannelNotFoundError
CreateCartPriceChannelNotFoundError

This exception is thrown when a price channel with the specified ID cannot be found or is not a valid price channel.

CreateCartShippingAddressDoesNotHaveShippingZonesError
CreateCartShippingAddressDoesNotHaveShippingZonesError

This exception is thrown when a shipping address country has no configured shipping zones.

CreateCartStoreNotFoundError
CreateCartStoreNotFoundError

This exception is thrown when a store with the specified ID cannot be found during cart creation.

CustomerEmailAlreadyConfirmedError
CustomerEmailAlreadyConfirmedError

The email address has already been confirmed.

CustomerInvalidActivationTokenError
CustomerInvalidActivationTokenError

The provided activation token is invalid or has expired.

CustomerInvalidPasswordError
CustomerInvalidPasswordError

The provided password does not meet the required criteria.

CustomerNotFoundError
CustomerNotFoundError

The customer with the specified ID was not found.

CustomerRegisterFailedError
CustomerRegisterFailedError

Registration of the customer failed.

InvalidCredentialsError
InvalidCredentialsError

Represents an exception that occurs when a user provides invalid credentials.

InvalidPasswordError
InvalidPasswordError

Represents an exception that occurs when a user provides an invalid email address.

InvalidRefreshTokenError
InvalidRefreshTokenError

Represents an exception that occurs when a user provides an invalid refresh token.

InvalidTokenError
InvalidTokenError

Represents an exception that occurs when a user provides an invalid token.

PaymentGatewayChannelMismatchError
PaymentGatewayChannelMismatchError

This exception is thrown when the payment gateway cannot be used with the cart due to channel mismatch.

PaymentGatewayNotFoundError
PaymentGatewayNotFoundError

This exception is thrown when a payment gateway is not found.

PaymentGatewaySessionInitializeFailedError
PaymentGatewaySessionInitializeFailedError

This exception is thrown when initializing the payment session fails at the provider.

PaymentGatewayUnavailableError
PaymentGatewayUnavailableError

This exception is thrown when the payment gateway is not available for the cart context.

ProductVariantNotFoundError
ProductVariantNotFoundError

This exception is thrown when a product variant with the specified ID cannot be found.

ShippingMethodNotFoundError
ShippingMethodNotFoundError

This exception is thrown when a shipping method with the specified ID cannot be found.

UpdateCartLineItemsInsufficientStockError
UpdateCartLineItemsInsufficientStockError

This exception is thrown when line item updates exceed available stock.