AvailableShippingMethodsPayload

Result of availableShippingMethods / cart.availableShippingMethods — the methods to render plus optional free-shipping progress and any user errors.

type AvailableShippingMethodsPayload {
  freeShippingProgress: FreeShippingProgress
  methods: [AvailableShippingMethod!]!
  userErrors: [UserError!]!
}

Fields

AvailableShippingMethodsPayload.freeShippingProgress ● FreeShippingProgress object

Best free-shipping progress across all returned methods. Use to render a single banner above the picker.

AvailableShippingMethodsPayload.methods ● [AvailableShippingMethod!]! non-null object

Methods available for the current cart and destination, sorted by sortOrder.

AvailableShippingMethodsPayload.userErrors ● [UserError!]! non-null object

Validation / availability errors — e.g. DIGITAL_ONLY_NO_SHIPPING when the cart contains only non-physical items. Branch on code.

Returned By

availableShippingMethods query

Member Of

Cart object