Shipment stops
Ordered pickup or delivery attempt on a shipment with a concrete location and time window.
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Shipment | logisticsshipmentId | Reference | Yes | |
| Sequence | sequence | Whole Number | Yes | Whole number without fractional part. |
| Branch | customerbranchId | Reference | ||
| Branch | supplierbranchId | Reference | ||
| Address | address | Address | ||
| Prior stop | logisticsshipmentstopIdPrior | Reference | ||
| Location kind | locationKind | Constant | Yes | Fixed option from the allowed set for this field. |
| Window start | datetimeWindowStart | Date and Time | ||
| Window end | datetimeWindowEnd | Date and Time | ||
| Signer name | signerName | Text | ||
| POD at | podAt | Date and Time | ||
| 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 | ||
| 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 |
|---|---|---|
Shipment logisticsshipmentId | Shipments | owned by |
Prior stop logisticsshipmentstopIdPrior | Shipment stops | reference |
Actions
What you can do with a record. Every action also sends the webhook event logisticsshipmentstops.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new stop. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this stop. | App · API · MCP · CLI |
| Arrive | start | Record that the vehicle reached this stop. | App · API · MCP · CLI |
| Complete | end | Record that the work at this stop is done. | App · API · MCP · CLI |
| Mark as failed | cancel | Record that this stop could not be completed. | App · API · MCP · CLI |
| Delete | delete | Delete this stop 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 |
|---|---|
| Arrive | start |
| Mark as failed | cancel |
| Complete | end |