Inventory reservations
A quantity of site stock committed to an issue line.
- API name:
inventoryreservations - Domain: Inventory
- Modules: Inventory analytics, 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 | |
| Line item | inventoryissueitemId | Reference | Yes | |
| Reserved quantity | quantity | Quantity | Yes | Quantity in the catalog unit after any unit conversion on the line. |
| Consumed quantity | quantityConsumed | Quantity | Yes | Quantity in the catalog unit after any unit conversion on the line. |
| Unit | catalogunit | Unit | ||
| Location | sitelocationId | Reference | ||
| Status | status | Constant | Lifecycle or processing state from the allowed values for this record. | |
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Processed by | processedBy | User | ||
| Processed at | processedAt | Date and Time | ||
| Relocated by | relocatedBy | User | ||
| Relocated at | relocatedAt | Date and Time | ||
| Canceled by | canceledBy | User | ||
| Canceled at | canceledAt | Date and Time |
Relations
Owned records (solid line) are deleted with their owner. Grouped records (dashed line) can exist alone.
| Field | Points to | Kind |
|---|---|---|
Line item inventoryissueitemId | Goods issue line items | owned by |
Location sitelocationId | Site locations | reference |
Actions
What you can do with a record. Every action also sends the webhook event inventoryreservations.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Cancel | cancel | Reverse the posted effect of this reservation. | App · API · CLI |
States
How a record moves from state to state. Archive and block can happen in any state.