Site areas
An operational subdivision of a site, such as a warehouse zone or production line.
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Code | code | Text | Identifier of the zone within the site. Use 2 to 12 uppercase alphanumeric characters. Used as the prefix for its location codes. | |
| Role | role | Constant | Operational purpose of the zone, such as receiving, storage, issuing, or sales floor. Sales floor applies only on a store site. | |
| Plan X (m) | x | Decimal | Horizontal coordinate of the rectangle lower-left corner before rotation, in the site frame, in meters. Positive is to the right. Position only, no length or width: the renderer shows a point marker. | |
| Plan Y (m) | y | Decimal | Vertical coordinate of the rectangle lower-left corner before rotation, in the site frame, in meters. Positive is up. Position only, no length or width: the renderer shows a point marker. | |
| Rotation (°) | rotation | Whole Number | Counterclockwise angle in degrees about that corner, from site +X. Empty is read as 0. | |
| Length (m) | length | Decimal | Rectangle length in meters, along the area local +X. Length and width only, no position: the area is not placed on the plan. | |
| Width (m) | width | Decimal | Rectangle width in meters, along the area local +Y. Length and width only, no position: the area is not placed on the plan. | |
| 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 | |
| Published by | publishedBy | User | ||
| Published at | publishedAt | Date and Time | ||
| Disabled by | disabledBy | User | ||
| Disabled at | disabledAt | Date and Time | ||
| 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 |
|---|---|---|
Tags tagIds | Tags | reference |
Actions
What you can do with a record. Every action also sends the webhook event siteareas.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new area. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this area. | App · WebMCP · API · MCP · CLI |
| Disable | disable | Turn this area off for new use. Existing references stay. Enable it again to use it. | App · WebMCP · API · MCP · CLI |
| Enable | undisable | Turn this area back on for new use. | App · WebMCP · API · MCP · CLI |
| Publish | publish | Make this area available for use. | App · WebMCP · API · MCP · CLI |
| Block | block | Stop edits and deletion of this area. 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 area again. | App · WebMCP · API · MCP · CLI |
| Archive | archive | Retire this area 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 area to active lists and actions. | App · WebMCP · API · MCP · CLI |
| Delete | delete | Delete this area and the data that belongs with it. This cannot be undone. | App · WebMCP · API · MCP · CLI |
States
How a record moves from state to state. Archive and block can happen in any state.
| Action | API name |
|---|---|
| Publish | publish |