Skip to main content

shippingRates

Returns the shipping rates available for a shipment: the carrier services that can deliver the given parcels from a warehouse to a recipient address, each with its price. An empty list means no carrier serves the shipment; an unknown channel or warehouse code fails with the error code NOT_FOUND.

shippingRates(
channelCode: String!
parcels: [ShippingRatesParcelInput!]!
recipientAddress: ShippingRatesRecipientAddressInput!
value: ShippingRatesValueInput!
warehouseCode: String!
): [ShippingRate!]

Arguments​

shippingRates.channelCode ● String! non-null scalar​

The sales channel code.

shippingRates.parcels ● [ShippingRatesParcelInput!]! non-null input​

The parcels to ship: kind, dimensions in centimeters and net weight in grams.

shippingRates.recipientAddress ● ShippingRatesRecipientAddressInput! non-null input​

The recipient address. address1, city, isoCountry and zipCode are required.

shippingRates.value ● ShippingRatesValueInput! non-null input​

The declared value of the shipment: amount and currency.

shippingRates.warehouseCode ● String! non-null scalar​

The code of the origin warehouse (see the warehouses query).

Type​

ShippingRate object​

A shipping rate returned by shippingRates: a carrier service with its price.