Shipping

GET /v1/account/profile tells you how shipping works for your account: shipping.mode is one of three values. This page does not say which one applies to you: read it from your profile.

`shipping.mode`	Meaning
`included`	Shipping is included in the price; `flat_fee` is `null`. In live you do not create an AWB.
`own_awb`	You create the air waybill (AWB) with your own carrier account, for every parcel we register for you. `flat_fee` is `null`.
`flat_fee`	A fixed shipping amount per order, given in `shipping.flat_fee` (in `shipping.currency`). In live you do not create an AWB.

Parcels

In live, parcels, tracking_number and the shipped status are provided through the API only when your mode is own_awb. In live with included and flat_fee the API does not move a line beyond confirmed: shipments is an empty list, the order does not go beyond in_progress, and tracking reaches you outside the API. The sandbox (test key) always simulates parcels, AWB and shipped, whatever your mode is.

In live with own_awb, each order lists its parcels in shipments[], one entry per parcel, with its lines and a status:

awaiting_awb: the parcel is ready and we give you weight_kg, dimensions_cm, ready_date, the shipper and the pickup_address where the carrier collects it (our hub or a partner boutique; the shipper field gives the shipper to put on the air waybill), so you can create the AWB;
awb_received: your AWB was uploaded;
shipped: handed to the carrier, with shipped_at.

carrier is the carrier of your account, shown on every parcel. tracking_number is the AWB number: it is present from awb_received on.

Multi-supplier orders are consolidated at our hub; single-supplier orders may leave from a partner boutique, so an order may still leave in more than one parcel. Delivery is tracked on the carrier's side with tracking_number.

Upload the AWB

Upload the AWB for every parcel we register for you (when your mode is own_awb):

PUT /v1/orders/{order_id}/shipments/{shipment_id}/awb

{ "awb_number": "...", "label_pdf_base64": "..." }

awb_number: letters, digits, spaces and dashes, starting with a letter or digit, at most 64 characters.
label_pdf_base64 is a PDF, at most 2 MB decoded, in standard base64 with = padding (RFC 4648 section 4, not base64url): anything else gives 400. The request can be up to 4 MB.
Response 200: { "shipment_id", "status": "awb_received", "awb_number" }.
The same call can replace an AWB until the parcel is shipped; after that it answers 409 already_shipped. A parcel of another account gives 404; not a PDF gives 400; over 2 MB gives 413.
shipped is the status of our parcel only.

A commercial invoice with the country of origin of each item travels with every parcel.