This section provides details on the available API endpoints for retrieving and managing orders.
- GET /orders_list
Retrieve a list of orders.
Endpoint Description
The /orders_list endpoint allows you to fetch a list of all orders available in the system. Here's a quick summary:
- Path:
/orders_list - Method:
GET - Query Parameters:
status: Filter orders by their status (e.g., "pending", "shipped", "delivered").page: Page number for pagination.limit: Number of records per page.
Example Request
GET /orders_list?status=shipped&page=1&limit=10
Response
The response will be a JSON object containing the list of orders. Here's an example of what the response might look like:
{
"orders": [
{
"order_id": "12345",
"customer_id": "67890",
"total_amount": 150.00,
"status": "shipped",
"created_at": "2023-04-01T12:00:00Z"
},
{
"order_id": "12346",
"customer_id": "67891",
"total_amount": 200.00,
"status": "delivered",
"created_at": "2023-04-02T12:00:00Z"
}
]
}
For more information on how to use the API, please visit our Developer Documentation.