Orders API Overview
The Orders API allows you to retrieve order information programmatically.
Base URL
Base URL: https://api.cekat.ai/api/orders
All Orders endpoints are prefixed with /api/orders.
List Orders
GET/api/orders
Retrieve orders with pagination.
Query Parameters
limitinteger
Results per page
pageinteger
Page number
bash
curl -X GET "https://api.cekat.ai/api/orders?limit=5" \
-H "Authorization: Bearer YOUR_API_KEY"
Response
200 OK
{
"message": "success",
"data": {
"orders": [
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"order_number": 2292,
"order_status": "pending",
"subtotal": 178000,
"discount": 0,
"shipping_fee": 95500,
"grand_total": 273500,
"payment_type": "one_time_payment",
"payment_method": "xendit",
"contact_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"contact": {
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"display_name": "Customer Name",
"phone_number": "6281578326419"
},
"conversation_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"created_at": "2026-04-08T09:29:07.444755+00:00"
}
]
}
}
Order Object
| Field | Type | Description |
|---|---|---|
id | string | Unique order identifier |
order_number | integer | Sequential order number |
order_status | string | Status: pending, paid, processing, etc. |
subtotal | number | Subtotal amount |
discount | number | Discount amount |
shipping_fee | number | Shipping fee |
grand_total | number | Grand total |
payment_type | string | Payment type |
payment_method | string | Payment provider |
contact_id | string | Contact ID |
contact | object | Contact information |
invoices | array | Invoice details |
created_at | string | Creation timestamp |
Order Statuses
| Status | Description |
|---|---|
pending | Order created, awaiting payment |
paid | Payment received |
processing | Order being processed |
shipped | Order shipped |
delivered | Order delivered |
cancelled | Order cancelled |
refunded | Order refunded |
Code Examples
javascript
const getOrders = async (filters = {}) => {
const params = new URLSearchParams(filters);
const response = await fetch(
`https://api.cekat.ai/api/orders?${params}`,
{ headers: { 'Authorization': 'Bearer YOUR_API_KEY' } }
);
return response.json();
};
// Get recent orders
const orders = await getOrders({ limit: 10 });
orders.data.orders.forEach(order => {
console.log(`Order #${order.order_number}: ${order.grand_total}`);
});