Lyro Product Recommendations

Upsert products

Upload or update products for Lyro AI recommendations using batch processing.

Processing

  • Products are processed in an all-or-nothing manner: if any product in the batch is invalid, the entire request fails.
  • Processing is asynchronous; products become available after a short delay.
  • Maximum 100 products per request.

Data Management

  • A source becomes active after the first product upload.
  • Push-only model: Tidio does not pull or sync product data from your website automatically.
  • To update a product, re-send its complete data with the same id.
  • Product entries should represent specific variants (e.g., "Red T-shirt Size M", "Red T-shirt Size S" etc.).

Requirements

  • updated_at must follow ISO 8601 (e.g., "2023-06-01T10:00:00+00:00").
  • Field length limits:
    • url: 512 chars
    • image_url: 512 chars
    • title: 512 chars
    • vendor: 255 chars
    • product_type: 255 chars
    • sku: 255 chars
    • barcode: 255 chars
    • features (keys/values): 255 chars each

Usage Limits

  • Calling delete on a source in Tidio Panel, removes all its products and requires reupload. This can be done at most 2 times per 24 hours.
  • Deleting individual products over API does not affect this limit.
put/products/batch

Request

  • Base URL
    https://api.tidio.com
  • URL
    https://api.tidio.com/products/batch
  • Auth
    API key in header X-Tidio-Openapi-Client-Id and API key in header X-Tidio-Openapi-Client-Secret

Request body

Example request

{
  "products": [
    {
      "id": 123,
      "url": "https://example.com/products/1",
      "image_url": "https://example.com/products/1/image.jpg",
      "title": "White T-shirt",
      "description": "White T-shirt 100% cotton",
      "default_currency": "USD",
      "vendor": "ACME",
      "product_type": "clothes",
      "price": 10,
      "sku": "FW25-DRS-M-W-203",
      "barcode": "0799439112766",
      "features": {
        "color": "red",
        "size": "M",
        "material": "cotton",
        "waterproof": true,
        "available_sizes": "S, M, L",
        "weight": 0.5
      },
      "updated_at": "2023-06-01T10:00:00+00:00"
    }
  ]
}

Response

Request succeeded but no content returned

Changes

No recorded changes to this operation across all 1 revision of this API.