Inventory alerts
An exception raised when stock crosses a minimum or maximum threshold, kept until it is resolved.
- API name:
inventoryalerts - 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 | Yes | |
| Threshold | quantityThreshold | Quantity | Yes | Threshold quantity frozen when the breach opened. |
| Quantity at breach | quantityAtBreach | Quantity | Yes | Available inventory quantity when the breach episode opened. |
| Quantity at resolve | quantityAtResolve | Quantity | Available inventory quantity when inventory returned to the safe range. | |
| Unit | catalogunit | Unit | ||
| Alert rule | inventoryalertruleId | Reference | Yes | |
| Condition | condition | Constant | Yes | Snapshot of the condition (Low inventory or High inventory) when the breach opened. |
| Breached at | breachedAt | Date and Time | ||
| Resolved at | resolvedAt | Date and Time |
Relations
| Field | Points to | Kind |
|---|---|---|
Item productitemId | Product items | reference |
Alert rule inventoryalertruleId | Inventory alert rules | reference |
Events
Moments the record reaches on its own. Subscribe to them with a webhook.
| Name | Webhook event | Description |
|---|---|---|
| Below minimum | inventoryalerts.minThresholdCrossed | Available quantity fell below the alert rule minimum. |
| Above maximum | inventoryalerts.maxThresholdCrossed | Available quantity rose above the alert rule maximum. |