Shipments
Price a parcel at every configured courier in parallel and compare (cheapest real tariff first). Creates nothing. Heavy rate tier. (scope: shipping:read)
POST
bearerAuthheader
AuthorizationBearer <token>API key as Bearer token
application/json- body
recipient*parcel*cod_amount?numberRange
0 <= valueDefault
0declared_value?numberRange
0 <= valuepickup_point_id?stringNarrows the comparison to that point's courier
Format
uuidcouriers?array<>OK
application/json- response
data*error*nullcurl -X POST "https://example.com/shipments/quote" \ -H "Content-Type: application/json" \ -d '{ "recipient": { "name": "string", "phone": "string", "city": "string" }, "parcel": { "weight_kg": 1 } }'{ "data": { "quotes": [ { "courier": "sameday", "service_code": "string", "service_name": "string", "cost": 0, "currency": "string", "eta_days": 0, "estimated": true, "cheapest": true } ], "couriers": [ { "courier": "sameday", "status": "ok" } ] }, "error": null}