Skip to main content

ShipmentRatesGql

The prices delivery partners quoted for a shipment.

type ShipmentRatesGql {
  customerChoice: ShipmentCustomerChoice
  options: [ShipmentRateOptionGql!]!
  orderShippingCharge: OrderShippingCharge
  suggestedParcels: [PackedBox!]
  unavailable: [UnavailableDeliveryPartnerGql!]!
}

Fields​

ShipmentRatesGql.customerChoice ● ShipmentCustomerChoice object​

The delivery option the customer chose at checkout. Only set for live-quoted orders.

ShipmentRatesGql.options ● [ShipmentRateOptionGql!]! non-null object​

The prices on offer.

ShipmentRatesGql.orderShippingCharge ● OrderShippingCharge object​

The order's own shipping charge. Set for an order's outbound rates, empty for a return pickup.

ShipmentRatesGql.suggestedParcels ● [PackedBox!] list object​

What is left to ship (a return: its items) packed into the tenant's boxes, with box names and contents — pre-fill the parcels from these. With no box enabled it is the default parcel. Null when the request gave its own parcels.

ShipmentRatesGql.unavailable ● [UnavailableDeliveryPartnerGql!]! non-null object​

The delivery partners that could not give a price, and why.

Returned By​

shipmentRates query