Skip to main content

StaffDeliveryOption

One live delivery option for a staff draft order. Pass id as the order's delivery option; the server re-validates it and charges the quoted fee, never a client figure.

type StaffDeliveryOption {
  autoSelected: Boolean!
  boxCount: Int
  carrierName: String
  currency: String!
  deliveryPartnerConfigId: ID!
  estimatedDelivery: DateTime
  estimatedDeliveryFrom: DateTime
  expiresAt: DateTime!
  fee: Float!
  feeExclTax: Float
  id: ID!
  kind: DeliveryOptionKind!
  label: String!
  partnerDisplayName: String
  partnerLogoUrl: String
  serviceLevelCode: String
  serviceLevelName: String
  speedId: String
}

Fields

`StaffDeliveryOption.autoSelected` ● `Boolean!` non-null scalar

True when the option was picked by the automatic rule.

`StaffDeliveryOption.boxCount` ● `Int` scalar

How many boxes this price is for, when the order was packed into the store's boxes; null for the default parcel.

`StaffDeliveryOption.carrierName` ● `String` scalar

Null when reps see the customer view and courier names are hidden.

`StaffDeliveryOption.currency` ● `String!` non-null scalar

ISO-4217 currency of fee.

`StaffDeliveryOption.deliveryPartnerConfigId` ● `ID!` non-null scalar

The ID of the delivery partner the option comes from.

`StaffDeliveryOption.estimatedDelivery` ● `DateTime` scalar

The latest expected delivery.

`StaffDeliveryOption.estimatedDeliveryFrom` ● `DateTime` scalar

The earliest expected delivery.

`StaffDeliveryOption.expiresAt` ● `DateTime!` non-null scalar

When the price stops being valid.

`StaffDeliveryOption.fee` ● `Float!` non-null scalar

The order's shipping charge when picked: the carrier's quoted price as-is (no threshold, no tax on top), in currency.

`StaffDeliveryOption.feeExclTax` ● `Float` scalar

The carrier's price before tax when it breaks it out, else null.

`StaffDeliveryOption.id` ● `ID!` non-null scalar

Opaque option id (expires at expiresAt).

`StaffDeliveryOption.kind` ● `DeliveryOptionKind!` non-null enum

SERVICE, SPEED or AUTO — only other than SERVICE when the store shows reps the customer view.

`StaffDeliveryOption.label` ● `String!` non-null scalar

The row title: speed name (SPEED), "Delivery" (AUTO / all hidden — translate by kind), else "courier · service".

`StaffDeliveryOption.partnerDisplayName` ● `String` scalar

Null when reps see the customer view and courier names are hidden.

`StaffDeliveryOption.partnerLogoUrl` ● `String` scalar

The partner's logo (an image URL or PNG data URI), or null.

`StaffDeliveryOption.serviceLevelCode` ● `String` scalar

Null when reps see the customer view and the courier or service name is hidden.

`StaffDeliveryOption.serviceLevelName` ● `String` scalar

Null when reps see the customer view and service names are hidden.

`StaffDeliveryOption.speedId` ● `String` scalar

The ID of the delivery speed the option stands for, in SPEEDS mode.

Member Of

StaffDeliveryOptions object

Fields
Member Of