Sanal AI
  1. Data Structures
Sanal AI
  • Introduction
    • ๐Ÿš€ Sanal AI - Encore Data
    • ๐Ÿ› ๏ธ Getting Started
    • ๐Ÿค The Approach / Model
  • Data Structures
    • ๐Ÿ“ Data Layout
    • ๐Ÿช Merchants
    • ๐Ÿ“‚ Categories
    • ๐Ÿท๏ธ Items
    • ๐Ÿ›’ Products
    • ๐Ÿ“ฆ Inventory
    • ๐Ÿ‘ค Customers
    • ๐Ÿงพ Orders
    • ๐Ÿงพ Variants & Combinations
  • API Requirements
    • ๐Ÿ”Œ API Requirements
    • API: `syncMerchants`
    • API: `syncCategories`
    • API: `syncItems`
    • API: `syncProducts`
    • API: `syncInventory`
    • API: `syncCustomers`
    • API: `syncOrders`
  1. Data Structures

๐Ÿ›’ Products

This object represents a specific merchant's offer to sell an Item. This is where price, customizations, and merchant-specific details live. It uses the robust "Variant Combinations" model.

Fields#

NameTypeDescription
idstringUnique ID for this specific product listing (e.g., prod_...).
item_idstringLink to the Items (Global Catalog) record.
merchant_idstringID of the Merchant selling this product.
pricenumberBase price set by merchant. Can be overridden by variant_combinations.
currencystringCurrency code (e.g., "SAR", "AED"). Based on merchant's country.
skustringMandatory. Merchant's internal SKU for the base product or default variant.
variant_groupsarrayOptional. Defines available options (e.g., Size, Color). See Variants & Combinations for details.
variant_combinationsarrayOptional. Crucial. Explicitly lists all purchasable combinations, each with its final sku and price. See Variants & Combinations for details.
modifier_groupsarrayOptional. Defines optional customizations (e.g., Toppings). See Variants & Combinations for details.
is_activebooleanWhen false, the product should not be purchasable, regardless of merchant availability.
updated_atstringTimestamp of the last modification (ISO 8601 UTC).

Understanding Variants & Combinations#

For a detailed explanation of how variant_groups, variant_combinations, modifier_groups, SKUs, and pricing work together, please refer to the dedicated page Variants & Combinations page.

Sample JSON#

Simple Retail Product (No Variants) Example#
{
  "id": "prod_tm_55667",
  "item_id": "item_almarai_milk_1l",
  "merchant_id": "mer_tamimi_riyadh",
  "price": 5.75,
  "currency": "SAR",
  "sku": "TM-DA-101",
  "variant_groups": [],
  "variant_combinations": [],
  "modifier_groups": [],
  "is_active": true,
  "updated_at": "2025-10-16T09:00:00Z"
}
Simple Restaurant Product (No Variants) Example#
{
  "id": "prod_rbh_fries",
  "item_id": "item_rbh_fries",
  "merchant_id": "mer_riyadh_burger_house",
  "price": 10.00,
  "currency": "SAR",
  "sku": "RBH-FRIES-REG",
  "variant_groups": [],
  "variant_combinations": [],
  "modifier_groups": [],
  "is_active": true,
  "updated_at": "2025-10-17T11:00:00Z"
}

For complex examples with variants, see the "Variants & Combinations" page.

Previous
๐Ÿท๏ธ Items
Next
๐Ÿ“ฆ Inventory
Built with