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 Objects

CheckoutCouponError

OBJECT

Definition

type CheckoutCouponError implements Error {
  code: CheckoutErrorCode!
  context: [CheckoutErrorContext!]
  message: String!
}

A failure pertaining to a coupon applied to the checkout. Inspect code for the specific cause.

Was this page helpful?

CheckoutDiscountAllocation

Fields

codeCheckoutErrorCodeRequired

The specific cause of the coupon-related checkout failure.

messageStringRequired

A description of the error in user language.

contextlist of CheckoutErrorContextsOptional

Structured details identifying the request value(s) that caused this error, when available.

Referenced by

Possible type in

CompleteCheckoutError
CreateCheckoutError
UpdateCheckoutError