Skip to main content

OrderCarrierRate Object

Description

A live carrier rate option for fulfilling an order (Sendcloud/Shippo).

Declaration

type OrderCarrierRate {
rateId: String!
provider: String
carrier: String
service: String
total: Float!
currency: String
estimatedDays: Int
contractId: Int
}

Fields

NameTypeDescription
rateIdString!Provider rate identifier — pass back to buy the label.
providerStringAggregator the quote came from. Valid values are "sendcloud" or "shippo".
carrierStringCarrier name (e.g. "PostNL", "Colissimo").
serviceStringService level name shown to the merchant.
totalFloat!Price including the handling surcharge.
currencyStringISO 4217 currency of the price.
estimatedDaysIntEstimated delivery time in days.
contractIdIntSendcloud contract identifier required when buying the label.