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

CheckoutErrorContext

OBJECT

Definition

1 type CheckoutErrorContext {
2   field: String!
3   value: String
4 }

A single piece of structured context describing where in the request an error occurred, pairing a path to the offending field with its value.

Was this page helpful?

CheckoutDiscountAllocation

Fields

fieldStringRequired

A JSON path to the offending field in the request payload, e.g. $.lineItems[0].productEntityId.

valueStringOptional

The offending value at the referenced path, serialized as a string.

Referenced by

Fields

CartError.context
CartLineItemError.context
CheckoutBillingAddressError.context
CheckoutCouponError.context
CheckoutShippingConsignmentError.context
CheckoutTaxError.context