Inventory holds
A hold or release of inventory at one position, which sets the quantity aside from use.
- API name:
inventoryholds - 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 | |
| Item | productitemId | Reference | ||
| Quantity | quantity | Quantity | Yes | Quantity in the catalog unit after any unit conversion on the line. |
| Item | customitemId | Reference | ||
| Identifier | inventoryidentifierId | Reference | ||
| Catalog | catalog | Constant | Fixed option from the allowed set for this field. | |
| Unit | catalogunit | Unit | ||
| Operation | operation | Constant | Yes | Hold moves quantity into on hold. Release moves it back to available. |
| Location | sitelocationId | Reference | Yes | |
| Zone | siteareaId | Reference | Yes | |
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| 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
| Field | Points to | Kind |
|---|---|---|
Identifier inventoryidentifierId | Inventory identifiers | reference |
Location sitelocationId | Site locations | reference |
Zone siteareaId | Site areas | reference |
Actions
What you can do with a record. Every action also sends the webhook event inventoryholds.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new hold. | App · API · MCP · CLI |
| Edit | update | Save changes to this hold. | App · API · MCP · CLI |
| Cancel | cancel | Reverse the posted effect of this hold. | App · API · MCP · CLI |
| Block | block | Stop edits and deletion of this hold. It stays visible and can still appear on existing documents. Unblock to edit again. | App · API · MCP · CLI |
| Unblock | unblock | Allow edits and deletion of this hold again. | App · API · MCP · CLI |
| Archive | archive | Retire this hold from daily use. It leaves active lists and pickers, and most actions stop. Unarchive to restore it. | App · API · MCP · CLI |
| Restore | unarchive | Return this hold to active lists and actions. | App · API · MCP · CLI |
| Delete | delete | Delete this hold and the data that belongs with it. This cannot be undone. | App · API · CLI |
States
How a record moves from state to state. Archive and block can happen in any state.