Aloha POS · Schema
Item
A catalog item managed through the NCR Voyix Catalog API.
POSRestaurantHospitalityNCR
Properties
| Name | Type | Description |
|---|---|---|
| version | integer | Optimistic-concurrency version; must increase on each update. |
| shortDescription | object | Locale-specific short description. |
| status | string | Item lifecycle status. |
| merchandiseCategory | string | Merchandise category the item belongs to. |
| departmentId | string | Department the item is assigned to. |
| itemId | object | Map of item identifier types to values. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/aloha-pos/refs/heads/main/json-schema/ncr-voyix-platform-item-schema.json",
"title": "Item",
"description": "A catalog item managed through the NCR Voyix Catalog API.",
"type": "object",
"properties": {
"version": {
"type": "integer",
"description": "Optimistic-concurrency version; must increase on each update."
},
"shortDescription": {
"type": "object",
"description": "Locale-specific short description.",
"properties": {
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"locale": { "type": "string" },
"value": { "type": "string" }
}
}
}
}
},
"status": {
"type": "string",
"description": "Item lifecycle status.",
"enum": ["ACTIVE", "INACTIVE"]
},
"merchandiseCategory": {
"type": "string",
"description": "Merchandise category the item belongs to."
},
"departmentId": {
"type": "string",
"description": "Department the item is assigned to."
},
"itemId": {
"type": "object",
"description": "Map of item identifier types to values.",
"additionalProperties": { "type": "string" }
}
},
"required": ["version", "status"]
}