Product items
A published sellable item of a product or package, with codes and image copied from its source.
- API name:
productitems - Domain: Catalog
- Modules: Sales, Stores, Services, 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 | Computed display name. For individual items: product name only. For packaged items: product name plus package name. Maintained by the system when the product or package changes — not editable on the item. | |
| Product item SKU | sku | Text | Internal code used to identify this product item in operations. | |
| GTIN barcode | gtin | GTIN barcode | ||
| Family | productgroupId | Reference | Family inherited from the product. Maintained by the system. | |
| Quantity | quantity | Decimal | Number of base units contained in one package. Present only on packaged items. | |
| Product | productId | Reference | Yes | Parent product this item materializes. Set by the system when the product or package is created. |
| Base unit | baseunit | Constant | Yes | Primary unit of measure. All inventory quantities and valuations use this unit. The unit measures quantity; it does not mean physical identities are interchangeable. |
| Traceability | tracking | Constant | Yes | Defines how inventory is tracked: by quantity, by lot, or by serial number. |
| Package | productpackageId | Reference | Package this item materializes. Present only on packaged items. | |
| Discrete quantity | isDiscrete | Boolean | Yes | When enabled, quantities must be whole numbers in the base unit of measure. When disabled, fractional quantities are allowed. |
| Item type | class | Constant | Yes | Whether this item is sold or stocked per unit or as a package. |
| Shelf life control | hasShelfLife | Boolean | Yes | Requires recording an expiration or best-before date upon receipt. |
| Shelf life (days) | shelfLifeDays | Whole Number | Standard shelf life in days from receipt or manufacturing. | |
| Image | image | Image | Image copied from the product, or from the package when the package has its own image. | |
| Family tags | productgroupTagIds | Tags | Tags inherited from the product family. | |
| Product tags | productTagIds | Tags | Tags inherited from the product. | |
| Package tags | productpackageTagIds | Tags | Tags inherited from the package. Present only for packaged items. | |
| Description | description | Text Area I18n | Localized description copied from the parent product. Maintained by the system — not editable on the item. | |
| 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 |
|---|---|---|
Family productgroupId | Product families | reference |
Product productId | Products | reference |
Package productpackageId | Product packages | reference |