orderCarrierRates Query

Description

Fetches live carrier rates for an order from the connected aggregator (Sendcloud/Shippo), used at fulfilment time to pick a service and buy a label.

query orderCarrierRates($orderRef: ID!) {
  orderCarrierRates(orderRef: $orderRef) {
    rateId
    provider
    carrier
    service
    total
    currency
    estimatedDays
    contractId
  }
}

Variables

{
    "orderRef": "37f704e343e1de9ee3177cdf"
}

Response

{
    "orderCarrierRates": [
        {
            "rateId": "example",
            "provider": "example",
            "carrier": "example",
            "service": "example",
            "total": 29.99,
            "currency": "example",
            "estimatedDays": 42,
            "contractId": 42
        }
    ]
}

Arguments

Name	Type	Description
orderRef	ID!	Reference ID of the order to quote.

Returns

[OrderCarrierRate!]!