List Orders
View all orders with filtering by status and date
Reading time: 1 minute
List Orders
View all orders with filtering support by status and date.
GET
{{base_url}}/ordersQuery Parameters
| Parameter | Type | Required | Description | Default |
|---|---|---|---|---|
phone_number_id | string | Yes | Phone number ID of the sender | - |
page | integer | No | Page number | 1 |
limit | integer | No | Number of results per page | 10 |
status | string | No | Filter by order status | - |
from_date | string | No | Start date (YYYY-MM-DD) | - |
to_date | string | No | End date (YYYY-MM-DD) | - |
searchTerm | string | No | Search in orders (order number, customer name) | - |
branch_id | string | No | Branch ID | - |
customer_id | string | No | Customer ID | - |
Example Request
Example Requestbash
curl -X GET "{{base_url}}/orders?phone_number_id=123456&status=pending&from_date=2024-01-01&to_date=2024-01-31" \
-H "Accept: application/json" \
-H "X-Awal-Signature-256: sha256=abc..." \
-H "X-Timestamp: 1704124800" \
-H "X-Domain: your-workspace" \
-H "X-Client-ID: your-client-id"Example Response
Response200 OK
{
"status": true,
"data": [
{
"id": 1,
"order_number": "ORD-2024-001",
"customer_name": "Ahmed Mohammed",
"customer_phone": "96650000000",
"total": 1250.00,
"currency": "SAR",
"status": "pending",
"payment_status": "unpaid",
"shipping_date": null,
"delivery_date": null,
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}
],
"meta": {
"current_page": 1,
"per_page": 10,
"total": 50,
"last_page": 5
}
}Related
ā Back to Orders
View Guide