REST API
The Vendu API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
Authentication
Authenticate your account via Bearer Token. You must pass your secret key (`vk_live_...`) in the Authorization header.
Authorization: Bearer vk_live_YOUR_API_KEY
Endpoints
GET
/api/v1/orders
List Orders
Returns a paginated list of orders from your store.
Parameters
- limit (optional)
- offset (optional)
- status (optional)
// Response Example
{
"object": "list",
"has_more": false,
"data": [
{
"id": "uuid",
"status": "paid",
"total_amount": 1200,
"currency": "UAH"
}
]
}GET
/api/v1/orders/:id
Retrieve Order
Retrieves the details of a specific order including items and customer contact.
// Response Example
{
"object": "order",
"data": {
"id": "uuid",
"items": [],
"customer": {}
}
}GET
/api/v1/products
List Products
Returns a paginated list of products.
Parameters
- limit (optional)
- offset (optional)
// Response Example
{
"object": "list",
"data": [
{
"id": "uuid",
"name": "Coffee Maker",
"price": 1500
}
]
}POST
/api/v1/products
Create Product
Creates a new product in your catalog.
Parameters
- name (required)
- price (required)
- sku
- stock_quantity
// Response Example
{
"object": "product",
"data": {
"id": "uuid",
"name": "New Product"
}
}GET
/api/v1/conversations
List Conversations
Export AI chat logs and analytics for your data warehouse.
Parameters
- limit (optional)
- offset (optional)
// Response Example
{
"object": "list",
"data": [
{
"id": "uuid",
"platform": "telegram",
"status": "resolved"
}
]
}