Skip to main content

ShipmentCustomerChoice

The delivery option the customer chose at checkout, as saved on the order, so the ship dialog can preselect it. It never carries the provider's quote reference or keys.

type ShipmentCustomerChoice {
  amount: String!
  carrierName: String!
  choiceMode: DeliveryChoiceMode
  currency: String!
  deliveryPartnerConfigId: String!
  parcels: [DeliveryParcelGql!]
  partnerDisplayName: String
  quotedAt: DateTime!
  serviceLevelCode: String!
  serviceLevelName: String!
  speedId: String
  speedName: String
}

Fields

`ShipmentCustomerChoice.amount` ● `String!` non-null scalar

What the customer agreed to at checkout, as a decimal string exactly as saved on the order.

`ShipmentCustomerChoice.carrierName` ● `String!` non-null scalar

The courier the customer chose.

`ShipmentCustomerChoice.choiceMode` ● `DeliveryChoiceMode` enum

How the customer chose: LIST, SPEEDS or AUTO. Empty on orders placed before the setting existed.

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

ISO 4217 currency code.

`ShipmentCustomerChoice.deliveryPartnerConfigId` ● `String!` non-null scalar

The ID of the delivery partner the customer's option came from.

`ShipmentCustomerChoice.parcels` ● `[DeliveryParcelGql!]` list object

The parcels the customer's price was quoted for (cm / kg) — book these with the customer's choice. Null on orders quoted before box packing.

`ShipmentCustomerChoice.partnerDisplayName` ● `String` scalar

The partner's name now. Empty when the partner no longer exists.

`ShipmentCustomerChoice.quotedAt` ● `DateTime!` non-null scalar

When the customer's price was quoted.

`ShipmentCustomerChoice.serviceLevelCode` ● `String!` non-null scalar

The code of the service level the customer chose.

`ShipmentCustomerChoice.serviceLevelName` ● `String!` non-null scalar

The name of the service level the customer chose.

`ShipmentCustomerChoice.speedId` ● `String` scalar

The ID of the speed the customer picked, in SPEEDS mode.

`ShipmentCustomerChoice.speedName` ● `String` scalar

The name of the speed as the customer saw it.

Member Of

SalesOrder object ● ShipmentRatesGql object

Fields
Member Of