Inventory identifiers
A lot or serial that identifies one physical unit of a catalog item.
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Product | productId | Reference | ||
| Batch / serial number | code | Text | Unique traceability identity for this product. When left empty, one is assigned on create. | |
| Customer | customerId | Reference | Customer that owns consigned or maquila stock. Empty when ownership is Company. | |
| Item | customitemId | Reference | ||
| Catalog | catalog | Constant | Yes | Fixed option from the allowed set for this field. |
| Predecessor | inventoryidentifierIdPredecessor | Reference | Identity this unit was created from, when it results from a split or transformation. | |
| Manufacturer | productmanufacturerId | Reference | ||
| Manufacturer code | manufacturerCode | Text | Batch code or serial number from the manufacturer (may differ from the internal code). | |
| Ownership | ownership | Constant | Yes | Beneficial owner of the stock. The custodial company remains the record's company. |
| Nominal | isNominal | Boolean | Yes | Whether the physical identity matches the product nominal geometry. Applies only with batch or serial tracking when the product has a dimensional envelope. |
| Dimensions | dimensions | Dimensions | Nominal geometric envelope — parametric physical extent of the product. | |
| Available weight | weightAvailable | Decimal | Numeric value stored with decimal precision. | |
| Available weight unit | weightAvailableUnit | Constant | Fixed option from the allowed set for this field. | |
| Origin document | tableUid | Constant | The optional header document that created or introduced this identifier in an operational transaction. | |
| Origin record | recordId | Reference | The header document record that created or introduced this identifier. | |
| Expiration date | dateExpiration | Date | Last calendar date this lot or serial number remains fit for use. | |
| Non-nominal reason | nonNominalReason | Constant | Geometric variance reason versus nominal (remnant, overlength, underlength, supplier variance). Requires actual dimensions on the identifier. | |
| 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
| Field | Points to | Kind |
|---|---|---|
Customer customerId | Customers | reference |
Predecessor inventoryidentifierIdPredecessor | Inventory identifiers | reference |
Manufacturer productmanufacturerId | Product manufacturers | reference |
Actions
What you can do with a record. Every action also sends the webhook event inventoryidentifiers.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add an new identifier. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this identifier. | App · WebMCP · API · MCP · CLI |
| Block | block | Stop edits and deletion of this identifier. 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 identifier again. | App · WebMCP · API · MCP · CLI |
| Archive | archive | Retire this identifier 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 identifier to active lists and actions. | App · WebMCP · API · MCP · CLI |
| Delete | delete | Delete this identifier and the data that belongs with it. This cannot be undone. | App · WebMCP · API · MCP · CLI |