Direct API
List Orders
Retrieve a paginated list of shipment orders
GET
/orders
Retrieve a paginated list of shipment orders with optional pagination parameters
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| page | number | No | Page number for pagination (default: 1) |
| per_page | number | No | Number of orders per page (options: 15, 50, 100, 200, default: 15) |
Response Codes
| Code | Status | Description |
|---|---|---|
| 200 | Success | Orders list retrieved successfully |
| 400 | Bad Request | Invalid pagination parameters |
| 401 | Unauthorized | Invalid or missing API key |
| 429 | Too Many Requests | Rate limit exceeded |
| 500 | Internal Server Error | Server error occurred |
Response Format
| Field | Type | Description |
|---|---|---|
| data | array | Array of order objects |
| pagination | object | Pagination metadata |
| data[].id | integer | Unique order identifier |
| data[].awb | string | Air Waybill tracking number |
| data[].status | string | Current order status |
| data[].created_at | string | Order creation timestamp (ISO 8601) |
| data[].carrier_name | string | Shipping carrier name |
| data[].service_name | string | Shipping service type |
| data[].total_price | number | Total shipping cost |
| pagination.current_page | integer | Current page number |
| pagination.per_page | integer | Items per page |
| pagination.total | integer | Total number of orders |
| pagination.last_page | integer | Last page number |
Response Example
RESPONSEJSON
{
"data": [
{
"id": 12345,
"awb": "EP123456789",
"status": "delivered",
"created_at": "2024-01-15T10:30:00Z",
"carrier_name": "FAN Courier",
"service_name": "Standard",
"total_price": 25.50
},
{
"id": 12346,
"awb": "EP123456790",
"status": "in_transit",
"created_at": "2024-01-16T14:20:00Z",
"carrier_name": "Cargus",
"service_name": "Express",
"total_price": 32.75
}
],
"pagination": {
"current_page": 1,
"per_page": 15,
"total": 150,
"last_page": 10
}
}Complete API Reference
For interactive testing and additional technical details, visit our complete Swagger documentation.
View in Swagger Documentation
