Shipments
Create an AWB at a courier — a real cost. Sender is the organisation; the pickup point is re-validated; the label is stored. 409 COURIER_NOT_CONFIGURED / SENDER_MISSING; 422 POINT_*. Requires Idempotency-Key. (scope: shipping:write)
POST
bearerAuthheader
AuthorizationBearer <token>API key as Bearer token
Idempotency-Key*stringRequired. Retries with the same key replay the first response instead of starting a second job (24 h).
Length
length <= 200application/json- body
courier*stringValue in
"sameday""cargus""fancourier""dpd""gls"service_code?stringFrom a quote
Length
length <= 40reference*stringYour order number, printed on the label
Length
length <= 80recipient*parcel*cod_amount?numberRange
0 <= valueDefault
0declared_value?numberRange
0 <= valuepickup_point_id?stringRe-validated: active, same courier, accepts COD, fits the weight
Format
uuidorder_id?stringFormat
uuidinvoice_id?stringFormat
uuidchannel_order_id?stringFormat
uuidOK
application/json- response
data*error*nullcurl -X POST "https://example.com/shipments" \ -H "Idempotency-Key: string" \ -H "Content-Type: application/json" \ -d '{ "courier": "sameday", "reference": "string", "recipient": { "name": "string", "phone": "string", "city": "string" }, "parcel": { "weight_kg": 1 } }'{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "courier": "sameday", "status": "draft", "awb_number": "string", "service_code": "string", "pickup_point_id": "4352e09f-57a9-4156-87bd-8d0c7a09f40e", "order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe", "invoice_id": "f4c4edb8-11e0-4b33-bcc1-482dc59ebb32", "channel_order_id": "6152d25d-e5b5-4319-af08-d2371c6540e8", "is_return": true, "parcel_count": 0, "weight_kg": 0, "cod_amount": 0, "cost": 0, "has_label": true, "sender": {}, "tracking_events": [ { "status": "string", "description": "string", "at": "2019-08-24T14:15:22Z", "location": "string" } ], "last_tracked_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }, "error": null}