CheckoutDeliveryOptions
Delivery choices for checkout. FLAT: no options, the bill carries the fee. LIVE_QUOTE: the buyer must pick one option; code NO_DELIVERY_OPTIONS means delivery is unavailable to this address; DELIVERY_FREIGHT_QUOTE means the order is too heavy to price live — it may be placed with no delivery option and the store quotes delivery afterwards.
type CheckoutDeliveryOptions {
choiceMode: DeliveryChoiceMode!
code: String
mode: DeliveryFeeMode!
options: [CheckoutDeliveryOption!]!
retryable: Boolean!
unavailable: [CheckoutDeliveryUnavailable!]!
}
Fields
CheckoutDeliveryOptions.choiceMode ● DeliveryChoiceMode! non-null enum
How to render the options: LIST (pick a service), SPEEDS (pick a speed), AUTO (one pre-selected price, no picker — still send its id as deliveryOptionId).
CheckoutDeliveryOptions.code ● String scalar
NO_DELIVERY_OPTIONS when live-quote checkout has nothing to offer; DELIVERY_FREIGHT_QUOTE when the order is too heavy to price live (place it without a delivery option — the store quotes delivery afterwards); null otherwise.
CheckoutDeliveryOptions.mode ● DeliveryFeeMode! non-null enum
How the delivery fee is worked out: a flat fee or a live quote.
CheckoutDeliveryOptions.options ● [CheckoutDeliveryOption!]! non-null object
The delivery options on offer.
CheckoutDeliveryOptions.retryable ● Boolean! non-null scalar
With no options: true when a partner failed for a reason that may clear (timeout, provider outage) — offer Retry rather than a dead end.
CheckoutDeliveryOptions.unavailable ● [CheckoutDeliveryUnavailable!]! non-null object
The delivery partners that could not give an option, and why.
Returned By
customerDeliveryOptions query ● mobileDeliveryOptions query