API Reference
All endpoints are available at https://api.bazex.co/app-api. Authenticate with your access token in the Authorization header.
Base URL & authentication
curl https://api.bazex.co/app-api/products \
-H "Authorization: Bearer fbat_your_access_token"Rate limits
Each app installation is limited to 60 requests per minute. Rate limit info is included in every response:
| Header | Description |
|---|---|
| X-RateLimit-Limit | Maximum requests per window (60) |
| X-RateLimit-Remaining | Requests remaining in current window |
| X-RateLimit-Reset | Unix timestamp when the window resets |
When the limit is exceeded, the API returns 429 Too Many Requests with a Retry-After header.
Pagination
List endpoints return paginated results. Pass page and limit as query parameters:
Query Parameters
| Name | Type | Description |
|---|---|---|
| page | number | Page number (default: 1) |
| limit | number | Items per page (defaults vary per endpoint — see below) |
| Endpoint | Default limit | Max limit |
|---|---|---|
| /app-api/products | 50 | 100 |
| /app-api/orders | 20 | 50 |
| /app-api/reviews | 10 | 50 |
{
"data": [ ... ],
"total": 42,
"page": 1,
"limit": 20
}Error format
{
"statusCode": 404,
"message": "Product not found",
"error": "Not Found"
}Products
Access the merchant's product catalog.
/app-api/productsList all products (paginated)
/app-api/products/:idGet a product by ID
/app-api/products/slug/:slugGet a product by slug
List products
curl https://api.bazex.co/app-api/products?page=1&limit=20 \
-H "Authorization: Bearer fbat_..."{
"data": [
{
"id": "clx1abc2def3",
"name": "Margherita Pizza",
"description": "Classic Italian pizza",
"price": 590,
"category": "Pizza",
"isAvailable": true,
"imageUrl": "/uploads/products/pizza.jpg",
"slug": "margherita-pizza",
"status": "ACTIVE",
"createdAt": "2026-01-15T10:30:00.000Z"
}
],
"total": 42,
"page": 1,
"limit": 20
}Orders
View and manage merchant orders.
/app-api/ordersList all orders (paginated)
/app-api/orders/:idGet an order by ID
/app-api/orders/:id/statusUpdate order status
/app-api/ordersCreate a guest order
Update order status
curl -X PATCH https://api.bazex.co/app-api/orders/ORDER_ID/status \
-H "Authorization: Bearer fbat_..." \
-H "Content-Type: application/json" \
-d '{ "status": "CONFIRMED" }'Valid statuses
| Name | Type | Description |
|---|---|---|
| PENDING | string | Order received, awaiting confirmation |
| CONFIRMED | string | Order confirmed by the business |
| PREPARING | string | Order is being prepared |
| READY | string | Order is ready for pickup/delivery |
| IN_DELIVERY | string | Order is being delivered |
| DELIVERED | string | Order has been delivered |
| CANCELLED | string | Order has been cancelled |
Reviews
Access merchant's store reviews.
/app-api/reviewsList reviews (paginated)
/app-api/reviews/statsGet aggregated review statistics
Analytics
/app-api/analytics/dashboardGet dashboard analytics data
Business
/app-api/businessGet business information (name, address, type, etc.)
Pages
/app-api/pagesList site pages
/app-api/pages/:slugGet a page by slug
Cross-tenant safety