Custom items
A catalog item created by sales for made-to-order or customer-specific offers.
- API name:
customitems - Domain: Catalog
- Modules: Sales, Stores, Finances, Inventory, Manufacturing, Purchasing, Logistics, Master data
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Name | label | Text I18n | ||
| SKU | sku | Text | ||
| GTIN barcode | gtin | GTIN barcode | ||
| Group | customitemgroupId | Reference | ||
| Base unit | baseunit | Constant | Yes | Base unit of measure used for inventory, valuation, and internal reporting. |
| Traceability | tracking | Constant | Yes | Defines how inventory is tracked: by quantity (no individual tracking), by lot/batch number (for perishable or lot-controlled products), or by serial number (for assets or uniquely identified items). |
| Discrete quantity | isDiscrete | Boolean | Yes | Always on for custom items: a custom item is a single whole piece (base unit H87), so quantities are always whole numbers. |
| Procurement | procurement | Constant | Yes | How the item is sourced: made in-house, bought from a supplier, or either. |
| Dimensions | dimensions | Dimensions | Geometry of this made-to-order design. Optional. | |
| Links | links | Link | Links | ||
| Image | image | Image | ||
| Tags | tagIds | Tags | ||
| Description | description | Text Area I18n | ||
| Data | data | Data | ||
| External identifiers | identifiers | External identifier | External identifiers | Remote system keys and optional id types. One value per system and type pair on this record. | |
| 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 |
|---|---|---|
Group customitemgroupId | Custom item groups | reference |
Tags tagIds | Tags | reference |
Actions
What you can do with a record. Every action also sends the webhook event customitems.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new item. | App · API · CLI |
| Edit | update | Save changes to this item. | App · API · MCP · CLI |
| Disable | disable | Turn this item off for new use. Existing references stay. Enable it again to use it. | App · API · MCP · CLI |
| Enable | undisable | Turn this item back on for new use. | App · API · MCP · CLI |
| Publish | publish | Make this item available for use. | App · API · MCP · CLI |
| Block | block | Stop edits and deletion of this item. It stays visible and can still appear on existing documents. Unblock to edit again. | App · API · CLI |
| Unblock | unblock | Allow edits and deletion of this item again. | App · API · CLI |
| Archive | archive | Retire this item from daily use. It leaves active lists and pickers, and most actions stop. Unarchive to restore it. | App · API · MCP · CLI |
| Restore | unarchive | Return this item to active lists and actions. | App · API · MCP · CLI |
| Delete | delete | Delete this item and the data that belongs with it. This cannot be undone. | App · API · MCP · CLI |
States
How a record moves from state to state. Archive and block can happen in any state.