Skip to main content

PackingRateOption

A live price with the packing it was priced with.

type PackingRateOption {
  amount: String!
  amountExclTax: String
  boxCount: Int!
  candidate: PackingCandidate!
  carrierName: String!
  currency: String!
  deliveryPartnerConfigId: String!
  etaFrom: DateTime
  etaTo: DateTime
  expiresAt: DateTime
  parcels: [DeliveryParcelGql!]!
  partnerDisplayName: String!
  partnerLogoUrl: String
  providerQuoteRef: String
  serviceLevelCode: String!
  serviceLevelName: String!
}

Fields

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

The price, as a decimal string in the rate's currency.

`PackingRateOption.amountExclTax` ● `String` scalar

The price before the carrier's tax, as a decimal string. Only set when the partner reports it in the same currency.

`PackingRateOption.boxCount` ● `Int!` non-null scalar

How many boxes the price is for.

`PackingRateOption.candidate` ● `PackingCandidate!` non-null enum

Which packing candidate the price was worked out for.

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

The courier that would carry the shipment.

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

ISO 4217 currency code.

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

The ID of the delivery partner the rate comes from.

`PackingRateOption.etaFrom` ● `DateTime` scalar

The earliest expected delivery.

`PackingRateOption.etaTo` ● `DateTime` scalar

The latest expected delivery.

`PackingRateOption.expiresAt` ● `DateTime` scalar

When the price stops being valid.

`PackingRateOption.parcels` ● `[DeliveryParcelGql!]!` non-null object

The parcels priced (cm / kg).

`PackingRateOption.partnerDisplayName` ● `String!` non-null scalar

The name of the delivery partner.

`PackingRateOption.partnerLogoUrl` ● `String` scalar

The partner's logo, or empty to show a monogram.

`PackingRateOption.providerQuoteRef` ● `String` scalar

The partner's reference for the quote, used when booking at this price.

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

The code of the service level, as the partner names it.

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

The name of the service level.

Member Of

PackingRatePreview object

Fields
Member Of