Get shipping order
Shipping
Get shipping order
Returns the full details of a shipping order created via /api/v1/ship/request.
GET
Get shipping order
Returns the full details of a shipping order created via
/api/v1/ship/request. Use this to poll for status updates, retrieve tracking info, and reconcile billing.
Path parameters
The
order_id returned by /api/v1/ship/request.Example request
Response
Order identifier.
One of:
queued, processing, label_created, shipped, delivered, cancelled, failed. In sandbox, the only status ever returned is queued. Production cycles through the full set above.Carrier tracking number.
null until a label is created.Carrier tracking URL.
null until a label is created.Shipping cost in USD. Billed B2B to the partner.
Items included in this shipment. Each entry includes
item_id, name, image, and back_image (or null when not available).ISO timestamp when the shipment left fulfillment.
null until reached.ISO timestamp when the shipment was delivered.
null until reached.Populated if
status is failed or cancelled.Echoes back exactly what was submitted to
/api/v1/ship/quote. Sandbox does not normalize keys. If a partner submitted zip instead of postal_code, it round-trips as zip. Production may normalize.Errors
| Status | Body | Cause |
|---|---|---|
404 | { "error": "Order not found" } | Unknown order_id or order does not belong to this partner |
500 | { "error": "An unexpected error occurred" } | Internal server error |