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

๐Ÿ“ Data Layout

This section defines the common patterns and conventions you will see across all the data models detailed below.
Understanding these standards will make the specific data structures easier to interpret.

Identifiers (IDs)#

All primary identifiers for our data records (e.g., for Merchants, Items, Customers) follow a consistent format: a prefix followed by a unique, URL-safe string.
Format: prefix_uniqueId
Examples: mer_AbCd1234, item_a1b2c3d4, ord_x1y2z3w4

Timestamp#

To ensure data versioning, all major data records include a timestamp of their last modification.
Field: updated_at
Purpose: The timestamp of the most recent change to the record.
Format: All timestamps are provided in ISO 8601 format and are in the UTC timezone (e.g., 2025-10-16T14:05:00Z).

Data Relationships#

Our data models are interconnected and inter-related. You will see fields ending in _id throughout the documentation.
These fields contain the unique identifiers of related data models, creating a clear and logical link between them.
For example, a Product record will contain an item_id to link it to the master Item record in our global catalog.
Previous
๐Ÿค The Approach / Model
Next
๐Ÿช Merchants
Built with