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
pagenumberNoPage number for pagination (default: 1)
per_pagenumberNoNumber of orders per page (options: 15, 50, 100, 200, default: 15)

Response Codes

Code Status Description
200SuccessOrders list retrieved successfully
400Bad RequestInvalid pagination parameters
401UnauthorizedInvalid or missing API key
429Too Many RequestsRate limit exceeded
500Internal Server ErrorServer error occurred

Response Format

Field Type Description
dataarrayArray of order objects
paginationobjectPagination metadata
data[].idintegerUnique order identifier
data[].awbstringAir Waybill tracking number
data[].statusstringCurrent order status
data[].created_atstringOrder creation timestamp (ISO 8601)
data[].carrier_namestringShipping carrier name
data[].service_namestringShipping service type
data[].total_pricenumberTotal shipping cost
pagination.current_pageintegerCurrent page number
pagination.per_pageintegerItems per page
pagination.totalintegerTotal number of orders
pagination.last_pageintegerLast 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