📄️ Flow Overview
A "shipment" in this system is called an Order internally, and it is always created against
📄️ Save Order (create a draft shipment)
Creates an order record in DRAFTORDER status against one or more Purchase Orders. This does
📄️ Get Shipping Rates (optional)
Returns live rates from every carrier onboarded on the account for the given PO/weight/carton
📄️ Create Draft Order (book the shipment with the carrier)
This is the step that actually creates the shipment — it calls the chosen carrier's API, gets
📄️ Get Order / Shipment
Fetch shipment(s) by exactly one of orderid, cartonid (internal carton UUID/AWB
📄️ Update Order
Partially updates a shipment — only pass the fields you want to change. Body is a superset of the
📄️ Cancel Order
Request body
📄️ Order Status Codes
currentstatus / currentstatus_code on an Order move through this lifecycle: