{% extends 'superuser/base_superuser.html' %} {% block title %}E-Commerce API Documentation | ChatLab{% endblock %} {% block documentation_active %}active{% endblock %} {% block workspace %}
Specification for developers to connect custom e-commerce stores to the Chatbot system.
All requests sent from our chatbot system to your e-commerce API will be authenticated using a Bearer Token. You will generate this token (API Key) in the chatbot settings and configure your server to validate it.
Used by the 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.