Skip to main content

CheckoutDeliveryOption

One live delivery option for the buyer's cart and address. Pass id back as deliveryOptionId on the bill and on placement; the server re-validates it and never trusts a client fee.

type CheckoutDeliveryOption {
  autoSelected: Boolean!
  boxCount: Int
  carrierLogoUrl: String
  carrierName: String
  currency: String!
  estimatedDelivery: DateTime
  estimatedDeliveryFrom: DateTime
  expiresAt: DateTime!
  fee: Float!
  id: ID!
  kind: DeliveryOptionKind!
  label: String!
  partnerName: String
  serviceLevelName: String
  speedId: String
}

Fields​

CheckoutDeliveryOption.autoSelected ● Boolean! non-null scalar​

True on the AUTO option: already chosen, nothing to pick.

CheckoutDeliveryOption.boxCount ● Int scalar​

How many boxes the delivery ships in ("Ships in N boxes") — only when the store chooses to show it; null otherwise.

CheckoutDeliveryOption.carrierLogoUrl ● String scalar​

The courier's logo (an image URL or PNG data URI), or null — show the carrier name alone.

CheckoutDeliveryOption.carrierName ● String scalar​

The courier, or null when the store hides courier names — show label.

CheckoutDeliveryOption.currency ● String! non-null scalar​

ISO-4217 currency of fee.

CheckoutDeliveryOption.estimatedDelivery ● DateTime scalar​

Latest estimated delivery, when the carrier gives one.

CheckoutDeliveryOption.estimatedDeliveryFrom ● DateTime scalar​

Earliest estimated delivery, when the carrier gives one and the store shows estimates.

CheckoutDeliveryOption.expiresAt ● DateTime! non-null scalar​

When the price stops being valid.

CheckoutDeliveryOption.fee ● Float! non-null scalar​

What the buyer pays for delivery (the carrier's quoted price as-is, or 0 over the free-delivery threshold), in currency. No tax is added on top.

CheckoutDeliveryOption.id ● ID! non-null scalar​

Opaque option id (expires at expiresAt).

CheckoutDeliveryOption.kind ● DeliveryOptionKind! non-null enum​

SERVICE: one partner service. SPEED: a named speed (label is its name). AUTO: the one price the store picked — show it selected, with no picker.

CheckoutDeliveryOption.label ● String! non-null scalar​

The row title to show: the speed name (SPEED), "Delivery" (AUTO, or when the store hides courier and service — translate by kind), else "courier · service" from what is shown.

CheckoutDeliveryOption.partnerName ● String scalar​

The delivery partner the courier is booked through (e.g. an aggregator), or null (also when courier names are hidden).

CheckoutDeliveryOption.serviceLevelName ● String scalar​

The service level, or null when the store hides it.

CheckoutDeliveryOption.speedId ● String scalar​

The SPEED option's speed id; null otherwise.

Member Of​

CheckoutDeliveryOptions object