Shipments
A transport operation that coordinates stops, freight and delivery outcomes without owning the inventory.
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Name | label | Text | ||
| Shipment number | uid | Text | The number is a human-readable, unique identifier for the record. | |
| Shipment date | date | Date | Yes | The day this shipment is scheduled. |
| Carrier | carrierId | Reference | ||
| User | userId | User | ||
| Vehicle | vehicleId | Reference | ||
| Driver | logisticsdriverId | Reference | ||
| Mode | mode | Constant | Yes | Fixed option from the allowed set for this field. |
| Tracking number | trackingNumber | Text | ||
| Service level | serviceLevel | Constant | Fixed option from the allowed set for this field. | |
| Planned departure | dateDeparturePlanned | Date | Calendar date without time of date. | |
| Actual departure | dateDepartureActual | Date | Calendar date without time of date. | |
| Planned arrival | dateArrivalPlanned | Date | Calendar date without time of date. | |
| Actual arrival | dateArrivalActual | Date | Calendar date without time of date. | |
| Total weight | weight | Decimal | Yes | Numeric value stored with decimal precision. |
| Weight unit | weightunit | Constant | Yes | Unit used for the shipment total weight. |
| Total volume | volume | Decimal | Yes | Numeric value stored with decimal precision. |
| Total pallets | palletCountTotal | Whole Number | Yes | Whole number without fractional part. |
| Status | status | Constant | Yes | Lifecycle or processing state from the allowed values for this record. |
| Tags | tagIds | Tags | ||
| Description | description | Text Area | ||
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Started by | startedBy | User | ||
| Started at | startedAt | Date and Time | ||
| Ended by | endedBy | User | ||
| Ended at | endedAt | Date and Time | ||
| Confirmed by | confirmedBy | User | ||
| Confirmed at | confirmedAt | Date and Time | ||
| Canceled by | canceledBy | User | ||
| Canceled at | canceledAt | Date and Time | ||
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Relations
Owned records (solid line) are deleted with their owner. Grouped records (dashed line) can exist alone.
| Field | Points to | Kind |
|---|---|---|
Carrier carrierId | Carriers | reference |
User userId | Users | reference |
Vehicle vehicleId | Vehicles | reference |
Driver logisticsdriverId | Drivers | reference |
Tags tagIds | Tags | reference |
Actions
What you can do with a record. Every action also sends the webhook event logisticsshipments.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new shipment. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this shipment. | App · WebMCP · API · MCP · CLI |
| Dispatch | start | Send the shipment out for delivery. | App · WebMCP · API · MCP · CLI |
| End | end | End this action. The work stops. This cannot be undone. | App · WebMCP · API · MCP · CLI |
| Cancel | cancel | Reverse the posted effect of this shipment. | App · WebMCP · API · MCP · CLI |
| Plan | confirm | Mark the shipment plan as ready. | App · API · MCP · CLI |
| Block | block | Stop edits and deletion of this shipment. It stays visible and can still appear on existing documents. Unblock to edit again. | App · WebMCP · API · MCP · CLI |
| Unblock | unblock | Allow edits and deletion of this shipment again. | App · WebMCP · API · MCP · CLI |
| Archive | archive | Retire this shipment from daily use. It leaves active lists and pickers, and most actions stop. Unarchive to restore it. | App · WebMCP · API · MCP · CLI |
| Restore | unarchive | Return this shipment to active lists and actions. | App · WebMCP · API · MCP · CLI |
| Delete | delete | Delete this shipment and the data that belongs with it. This cannot be undone. | App · WebMCP · API · MCP · CLI |
States
How a record moves from state to state. Archive and block can happen in any state.
| Action | API name |
|---|---|
| Cancel | cancel |
| Plan | confirm |
| Dispatch | start |
| End | end |