Sanal AI
  1. API Requirements
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. API Requirements

🔌 API Requirements

This section outlines the API endpoints that the Encore platform requires deepsense to build and host. Each endpoint is detailed on its own page.

API Endpoint Summary Table#

API EndpointDescription
POST /v1/syncMerchantsSynchronizes merchant records.
POST /v1/syncItemsSynchronizes the global Items catalog.
POST /v1/syncProductsSynchronizes merchant-specific Products/offers.
POST /v1/syncCategoriesSynchronizes the category tree.
POST /v1/syncInventorySynchronizes real-time stock levels.
POST /v1/syncCustomersSynchronizes customer profiles.
POST /v1/syncOrdersSynchronizes order records and their statuses.

API Request & Response Structure#

The request body for all sync APIs will be a JSON object containing a key (pluralized version of the data model name) which holds an array of action objects. Each action object must contain two keys:
command (string): The operation to perform. Values: "create", "update", or "delete".
info (object): The full data object for the item. For delete, the info object only needs to contain the id.
To ensure efficient and robust error handling, the API response should report by exception. If one or more operations fail, the response must return a list containing only the details of the failed operations.
Previous
🧾 Variants & Combinations
Next
API: `syncMerchants`
Built with