Skip to content

Calculate available shipping options​

POST
/rest/v1/checkout/shipping

Returns the transporter price list for a destination. Every cost is THRESHOLD-AWARE — the free-shipping threshold (TRANS_COST_LIMIT), TRANS_FREE_ALL, and the overweight per-kg surcharge are all applied, against the current cart's gross total (coupon already deducted) and weight. It is the same figure POST /rest/checkout/totals quotes and POST /rest/checkout/place-order charges.

Parameters​

Header Parameters

X-Cart-Token

Guest cart token (when not authenticated)

Type
string

Request Body​

application/json
JSON
{
  
"countryAlpha2": "string",
  
"countyAlpha": "string",
  
"postalCode": "string",
  
"payWay": "delivery"
}

Responses​

Available shipping transporters. Per transporter: cost is the charged, threshold-aware shipping figure (the overweight surcharge is already inside it); overweightCost is a READ-ONLY display duplicate of that surcharge — render it as an "includes €X overweight" line, never add it to a total; deliveryCost is a separate cash-on-delivery surcharge line.

application/json
JSON
{
  
"availableTransporters": [
  
  
{
  
  
  
"transporterId": 5,
  
  
  
"name": "acs",
  
  
  
"cost": 3,
  
  
  
"overweightCost": 0,
  
  
  
"deliveryCost": 0,
  
  
  
"options": [
  
  
  
  
{
  
  
  
  
}
  
  
  
],
  
  
  
"className": "string",
  
  
  
"deliveryOptionType": "0",
  
  
  
"requiresCarrierData": true,
  
  
  
"codAllowed": true
  
  
}
  
]
}

Playground​

Headers
Body

Samples​

Powered by VitePress OpenAPI