Sync products via the API

If you run a shop on a custom stack, you can push your catalogue straight to the bot. Once products are synced, it answers shopping questions with real product cards, complete with price, image and a link.

Send your catalogue

POST to /api/v1/chat/sync-products with your sync key in the X-Sync-Key header (this endpoint does not use the Bearer key). The body is JSON: your bot_id and a products array. Only a title is required per product; the rest make the card richer.

POST/api/v1/chat/sync-productsX-Sync-Key: awsk_YOUR_SYNC_KEY{ "bot_id": "YOUR_BOT_ID", "products": [{ "title": "Blue Wool Scarf", "price": "€39.00", "sale_price": "€29.00", "badge": "Sale", "url": "…/scarf" }]}SaleBlue Wool Scarf€29.00€39.00
Your JSON becomes a shoppable card.
POST /api/v1/chat/sync-products
X-Sync-Key: awsk_YOUR_SYNC_KEY

{
  "bot_id": "YOUR_BOT_ID",
  "products": [
    {
      "title": "Blue Wool Scarf",
      "price": "€39.00",
      "sale_price": "€29.00",
      "badge": "Sale",
      "url": "https://shop.example.com/scarf",
      "image_url": "https://shop.example.com/scarf.jpg"
    }
  ]
}

It replaces the whole catalogue

Each call is a full replace, not an update, so always send your complete list. You can include up to 500 products per call and make up to 6 calls a minute. A successful sync returns { "ok": true, "synced": 128, "indexed": true }.

Cards show on Pro and up

Synced products power the bot's text answers on every plan, but the visual product cards appear on the Pro plan and above. Our WordPress, Shopify and Magento apps also call this endpoint for you automatically, so you only script it yourself on a custom platform.

Still need a hand?Email our team and we answer within one business day.
Sync products via the API | ovellan