Shipment line items
A line of a shipment: the quantity of an outgoing inventory movement or receipt allocated between shipment stops.
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 | |
| Source | source | Constant | Yes | Fixed option from the allowed set for this field. |
| Quantity allocated | quantityAllocated | Quantity | Yes | Quantity of the source line placed on this shipment. |
| Removal | inventoryissuenoteitemId | Reference | ||
| Line item | inventoryreceiptitemId | Reference | ||
| Pickup stop | logisticsshipmentstopIdPickup | Reference | Yes | |
| Delivery stop | logisticsshipmentstopIdDelivery | Reference | Yes | |
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| 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 |
Pickup stop logisticsshipmentstopIdPickup | Shipment stops | reference |
Delivery stop logisticsshipmentstopIdDelivery | Shipment stops | reference |
Actions
What you can do with a record. Every action also sends the webhook event logisticsshipmentitems.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new line item. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this line item. | App · API · MCP · CLI |
| Delete | delete | Delete this line item and the data that belongs with it. This cannot be undone. | App · WebMCP · API · MCP · CLI |