Create a shipment
A shipment is the execution unit of an order. It supports status, tracking, assignment to a trip, and linking to a carrier or own vehicle. Shipments exist only on orders — never on quotations.
URL: /shipments · create /shipments/create
When do you create a shipment?
- One order can have one or more shipments. Split on partial deliveries, multiple vehicles or multiple drivers.
- Shipments inherit customer, stops and cargo from the order. You can pick a subset of stops per shipment when splitting across multiple shipments.
Key fields
| Field | Notes |
|---|---|
| Shipment number | Auto via sequence |
| Order | Required — link to source order |
| Stops | Subset of the order stops in correct sequence |
| Vehicle / driver | Own resource from Vehicles and Staff |
| Carrier | Optional — when subcontracted, from Carriers |
| Tracking number / URL | External tracking |
| Planned start/end | Drives placement in dispatch |
Statuses
draft → confirmed → in_transit → delivered → cancelled
| Status | Meaning |
|---|---|
| draft | Concept, or auto-created from order |
| confirmed | Planned in dispatch, ready for execution |
| in_transit | First pickup has an actual departure time |
| delivered | Last delivery has POD/arrival |
| cancelled | Not executed; reverts on order |
Related
Last updated on
