Shipments

Dispatch shipment

Records the shipment dispatch, in a job.

POST/v1/shipments/{shipmentId}/dispatches

Coming soon

This route is not in the API yet. This page shows what it will do. Fields, examples and the playground arrive when it ships.

Tells the marketplace the package has left. The body accepts optionId (from Get dispatch options), carrier, trackingNumber and dispatchedAt. It answers 202 with a shipment.dispatch job; the shipment moves to shipped and shipment.updated arrives.

The label rule applies here too: with the invoice pending, the answer is 409 invoice_required. Once shipped, the order moves to shipped and the reserved stock is written off.