🏷️ Items
Fields
| Name | Type | Description |
|---|---|---|
id | string | The unique identifier for this global item (e.g., item_...). |
upc / ean | string | Optional. The universal barcode for a retail product. Crucial for matching identical items across merchants. |
brand | string | Optional. The brand name (e.g., "Almarai", "Riyadh Burger House"). |
name | string | The official, universal name of the item (e.g., "Fresh Full Fat Milk - 1L", "Classic Riyadh Burger"). |
description | string | A detailed, neutral description of the item. Can include ingredients, materials, etc. |
category_ids | array | An array of IDs linking to one or more Categories model records. |
is_active | boolean | When false, the item should not be avaialable. |
updated_at | string | The timestamp of the last modification (ISO 8601 UTC). |
Sample JSON
Retail (Branded) Example
{
"id": "item_almarai_milk_1l",
"upc": "6281007041077",
"brand": "Almarai",
"name": "Fresh Full Fat Milk - 1L",
"description": "Fresh cow's milk, pasteurized and homogenized. Enriched with Vitamins A & D. Keep refrigerated.",
"category_ids": ["cat_milk", "cat_dairy"],
"is_active": true,
"updated_at": "2025-08-01T12:00:00Z"
}Retail (Generic) Example
{
"id": "item_banana_each",
"upc": null,
"brand": null,
"name": "Banana (Single)",
"description": "Fresh, ripe banana, sold individually.",
"category_ids": ["cat_fresh_produce", "cat_fruits"],
"is_active": true,
"updated_at": "2025-07-15T09:00:00Z"
}Restaurant (Unique Item) Example
{
"id": "item_rbh_classic_burger",
"brand": "Riyadh Burger House",
"name": "Classic Riyadh Burger",
"description": "A 100% Wagyu beef patty, special spices, melted cheese, and fresh greens on a toasted bun. Halal.",
"category_ids": ["cat_burgers", "cat_main_courses"],
"is_active": true,
"updated_at": "2025-10-15T22:10:00Z"
}