Site locations
A physical position inside an area, such as an aisle, rack, or bin.
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Area | siteareaId | Reference | Yes | |
| Position | position | Text | ||
| Code | code | Text | Production codes are entered manually. Storage codes follow the coordinates; single-location areas use the area code. | |
| Caption | caption | Text | ||
| Coordinates | coordinate | Constant | Addressing depth of this location. | |
| Aisle | aisle | Text | ||
| Bay | bay | Text | ||
| Level | level | Text | Fixed option from the allowed set for this field. | |
| Plan X (m) | x | Decimal | Horizontal site-frame coordinate of this point, in meters. Positive is to the right. | |
| Plan Y (m) | y | Decimal | Vertical site-frame coordinate of this point, in meters. Positive is up. | |
| Rotation (°) | rotation | Whole Number | Counterclockwise angle in degrees from site +X. Empty is read as 0. | |
| Max. weight | weight | Decimal | Maximum permitted load. Empty means the limit is not recorded. | |
| Weight unit | weightunit | Constant | Fixed option from the allowed set for this field. | |
| Max. length | length | Decimal | Maximum permitted size on this axis. The unit is base unit. Empty means the limit is not recorded. | |
| Max. width | width | Decimal | Maximum permitted size on this axis. The unit is base unit. Empty means the limit is not recorded. | |
| Max. height | height | Decimal | Maximum permitted size on this axis. The unit is base unit. Empty means the limit is not recorded. | |
| Base unit | baseunit | Constant | Unit used for this location’s length, width, and height limits. | |
| 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 |
|---|---|---|
Area siteareaId | Site areas | grouped by |
Tags tagIds | Tags | reference |
Actions
What you can do with a record. Every action also sends the webhook event sitelocations.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new location. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this location. | App · WebMCP · API · MCP · CLI |
| Disable | disable | Turn this location off for new use. Existing references stay. Enable it again to use it. | App · WebMCP · API · MCP · CLI |
| Enable | undisable | Enable this location to be used | App · WebMCP · API · MCP · CLI |
| Publish | publish | Make this location available for use. | App · WebMCP · API · MCP · CLI |
| Block | block | Stop edits and deletion of this location. 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 location again. | App · WebMCP · API · MCP · CLI |
| Archive | archive | Retire this location 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 location to active lists and actions. | App · WebMCP · API · MCP · CLI |
| Delete | delete | Delete this location 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.