Skip to main content

ShipmentRateOptionGql

A price a delivery partner quoted for a shipment.

type ShipmentRateOptionGql {
  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​

ShipmentRateOptionGql.amount ● String! non-null scalar​

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

ShipmentRateOptionGql.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.

ShipmentRateOptionGql.boxCount ● Int scalar​

How many parcels this price is for; null when the parcels were given with the request.

ShipmentRateOptionGql.candidate ● PackingCandidate enum​

Which packing won this service (the cheaper of the two candidates); null when the parcels were given with the request.

ShipmentRateOptionGql.carrierName ● String! non-null scalar​

The courier that would carry the shipment.

ShipmentRateOptionGql.currency ● String! non-null scalar​

ISO 4217 currency code.

ShipmentRateOptionGql.deliveryPartnerConfigId ● String! non-null scalar​

The ID of the delivery partner the rate comes from.

ShipmentRateOptionGql.etaFrom ● DateTime scalar​

The earliest expected delivery.

ShipmentRateOptionGql.etaTo ● DateTime scalar​

The latest expected delivery.

ShipmentRateOptionGql.expiresAt ● DateTime scalar​

When the price stops being valid.

ShipmentRateOptionGql.parcels ● [DeliveryParcelGql!] list object​

The parcels this price is for (cm / kg) — send them as the booking's parcels to book what was priced. Null when the parcels were given with the request.

ShipmentRateOptionGql.partnerDisplayName ● String! non-null scalar​

The name of the delivery partner.

ShipmentRateOptionGql.partnerLogoUrl ● String scalar​

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

ShipmentRateOptionGql.providerQuoteRef ● String scalar​

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

ShipmentRateOptionGql.serviceLevelCode ● String! non-null scalar​

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

ShipmentRateOptionGql.serviceLevelName ● String! non-null scalar​

The name of the service level.

Member Of​

ShipmentRatesGql object