Shipments
List shipments
Credential: a company's API key or OAuth token.
Required Scope
shipments-read
query Parameters
pageDeprecated: page with cursor instead. Page number (1-indexed). From 2026-12-31, a page past the first of a list with more than 10,000 matching rows is refused.
limitcursorOpaque cursor from the previous response's nextCursor. Returns the rows after it, in the same order. Send the same filters and sort as the request that produced it, and do not send page. The preferred way to page through a list.
statusList shipments › Responses
totallimitnextCursorCursor for the next page; pass it as cursor. null on the last page, and on every page of a sort that cannot page by cursor — hasMore then says whether another page follows by page number.
hasMoreWhether more rows follow this page.
pageDeprecated: page with nextCursor instead. Current page number.
Create a shipment from an order
Credential: a company's API key or OAuth token.
Takes an ORDER — buyer, currency, lines — and produces a draft invoice plus the shipment that ships against it. Nothing posts here: cost of goods sold posts when the shipment is dispatched.
Pass taxTotal to have your own tax figure checked against the draft's VAT.
A difference larger than rounding is refused rather than posted, because the
figures disagreeing means a VAT code is unmapped.
Send an x-api-idempotency-key header to make a retried call return the
first call's shipment instead of creating a second one.
Required Scope
shipments-write
Headers
x-api-idempotency-keyOptional idempotency key for safely retrying mutating requests.
Create a shipment from an order › Request Body
warehouseIdThe warehouse the goods leave from.
customerEmailThe buyer's email. Matched against your customers; created when new.
currencyISO 4217 alpha-3 currency code.
customerNameThe buyer's name, used when the customer has to be created.
customerCountryCodeISO 3166-1 alpha-2 country the goods go to. Used when the customer has to be created: outside the EU the buyer is placed abroad and billed without VAT; inside the EU, or when omitted, in your company's domestic VAT zone.
externalOrderIdYour own order reference. Quoted back on any refusal this request answers with.
orderDateOrder date (YYYY-MM-DD). Defaults to today.
taxTotalYour own tax total for the order. Compared against the draft's VAT; a difference larger than rounding is refused rather than posted.
Create a shipment from an order › Responses
Shipment created
idshipmentNoAllocated at dispatch; null while the shipment is a draft.
statuswarehouseIdcustomerIdinvoiceIdThe draft invoice this shipment ships against.
dispatchedAtcreatedAtGet a shipment
Credential: a company's API key or OAuth token.
Required Scope
shipments-read
path Parameters
shipmentIdShipment ID
Get a shipment › Responses
idshipmentNoAllocated at dispatch; null while the shipment is a draft.
statuswarehouseIdcustomerIdinvoiceIdThe draft invoice this shipment ships against.
dispatchedAtcreatedAtCancel a shipment
Credential: a company's API key or OAuth token.
A draft cancels free. A dispatched shipment unwinds: reversal movements and mirrored entries, so the books show both the dispatch and its reversal.
Required Scope
shipments-write
path Parameters
shipmentIdShipment ID
Headers
x-api-idempotency-keyOptional idempotency key for safely retrying mutating requests.
Cancel a shipment › Responses
idshipmentNoAllocated at dispatch; null while the shipment is a draft.
statuswarehouseIdcustomerIdinvoiceIdThe draft invoice this shipment ships against.
dispatchedAtcreatedAtDispatch a shipment
Credential: a company's API key or OAuth token.
The goods leave the warehouse: stock moves and cost of goods sold posts. This is the irreversible half — a dispatched shipment is cancelled by unwinding it, never by editing it.
Required Scope
shipments-write
path Parameters
shipmentIdShipment ID
Headers
x-api-idempotency-keyOptional idempotency key for safely retrying mutating requests.
Dispatch a shipment › Request Body
accountingDateAccounting date for the cost posting (YYYY-MM-DD). Defaults to today.
trackingNumberThe carrier's tracking number for the parcel. Recorded on the shipment, and reported back to the shop when this shipment came from a sales-channel order.
Dispatch a shipment › Responses
idshipmentNoAllocated at dispatch; null while the shipment is a draft.
statuswarehouseIdcustomerIdinvoiceIdThe draft invoice this shipment ships against.
dispatchedAtcreatedAt