Inventory alert rules
A minimum or maximum stock level that raises an alert.
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 | |
| Minimum threshold (available) | quantityMin | Quantity | Opens an alert when available stock falls below this value. Equality with the threshold is not a breach. | |
| Maximum threshold (available) | quantityMax | Quantity | Opens an alert when available stock rises above this value. Equality with the threshold is not a breach. | |
| Unit | catalogunit | Unit | ||
| Tags | tagIds | Tags | ||
| Data | data | Data | ||
| 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 |
|---|---|---|
Item productitemId | Product items | grouped by |
Tags tagIds | Tags | reference |
Actions
What you can do with a record. Every action also sends the webhook event inventoryalertrules.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add an new alert rule. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this alert rule. | App · WebMCP · API · MCP · CLI |
| Block | block | Stop edits and deletion of this alert rule. It stays visible and can still appear on existing documents. Unblock to edit again. | App · WebMCP · API · MCP · CLI |
| Unblock | unblock | Allow edits and deletion of this alert rule again. | App · WebMCP · API · MCP · CLI |
| Archive | archive | Retire this alert rule from daily use. It leaves active lists and pickers, and most actions stop. Unarchive to restore it. | App · WebMCP · API · MCP · CLI |
| Restore | unarchive | Return this alert rule to active lists and actions. | App · WebMCP · API · MCP · CLI |
| Delete | delete | Delete this alert rule and the data that belongs with it. This cannot be undone. | App · WebMCP · API · MCP · CLI |