{% extends 'public/base.html' %} {% block title %}E-Commerce API Documentation | ChatLab - AI Sales Agent{% endblock %} {% block content %}
Specification for developers to connect custom e-commerce stores to our Chatbot system.
IMPORTANT: The API Key required for authorization must be generated and obtained from our dashboard by the company owner. All requests sent from our chatbot system to your e-commerce API will be authenticated using this Bearer Token.
The Chatbot will call your e-commerce system using the Base URL you provide. The endpoints below (/api/bot/test/, /api/bot/catalog/, etc.) should be implemented on your server.
Used by our chatbot dashboard to verify that the connection to your store is working correctly.
The chatbot will call this endpoint to fetch your store's live product catalog to recommend items to customers.
| Field | Type | Description |
|---|---|---|
id |
String / Int | Unique product identifier. |
name |
String | The name or title of the product. |
price |
Number | The regular price of the item. |
discount_price |
Number | The discounted price (if applicable). Send null or 0 if none. |
brand |
String | The brand name of the product. |
stock |
Boolean / Number | Whether the item is in stock. |
When a user confirms they want to buy a product, the chatbot will send a POST request to create the order in your system.
Return the created order ID and a confirmation message that the chatbot will relay to the user.
Test if your API is correctly configured. Enter your API Base URL (Authorized Domain) and the API Key provided by us.