Skip to main content

StaffDeliveryOptions

Live delivery options for a staff draft order. available false: the plan has no delivery partners or none is enabled — keep the manual shipping amount.

type StaffDeliveryOptions {
  available: Boolean!
  choiceMode: DeliveryChoiceMode!
  code: String
  freightQuote: StaffDeliveryFreightQuote
  options: [StaffDeliveryOption!]!
  retryable: Boolean!
  unavailable: [CheckoutDeliveryUnavailable!]!
}

Fields​

StaffDeliveryOptions.available ● Boolean! non-null scalar​

True when delivery options could be worked out.

StaffDeliveryOptions.choiceMode ● DeliveryChoiceMode! non-null enum​

LIST unless the store shows reps the customer view (then the customer choice mode).

StaffDeliveryOptions.code ● String scalar​

DELIVERY_PARTNERS_NOT_IN_PLAN, NO_ENABLED_PARTNERS, NO_DELIVERY_OPTIONS or DELIVERY_FREIGHT_QUOTE (too heavy to price live — set the shipping charge by hand); null when options exist.

StaffDeliveryOptions.freightQuote ● StaffDeliveryFreightQuote object​

Set with code DELIVERY_FREIGHT_QUOTE; null otherwise.

StaffDeliveryOptions.options ● [StaffDeliveryOption!]! non-null object​

The delivery options on offer.

StaffDeliveryOptions.retryable ● Boolean! non-null scalar​

True when asking again may succeed.

StaffDeliveryOptions.unavailable ● [CheckoutDeliveryUnavailable!]! non-null object​

The delivery partners that could not give an option, and why.

Returned By​

staffDeliveryOptions query