OpenAPI Documentation
OpenAPI Documentation

List Dynamic Traffic Orders

Returns a paginated list of dynamic traffic purchase orders for the current caller identity.

API Information

Item Value
Method GET
Path /open-api/v1/dynamic/traffic/orders
Authentication X-API-Key
Processing Synchronous

Query Parameters

Parameter Type Required Description
order_no string No Exact order number match
status string No PROCESSING, COMPLETED, or FAILED
create_time_start string No Inclusive lower bound for creation time, with Z or an explicit offset
create_time_end string No Inclusive upper bound for creation time, with Z or an explicit offset
page_no integer No Defaults to 1; must be at least 1
page_size integer No Defaults to 20; range: 1100

The start time must not be later than the end time.

Request Example

curl --request GET \
  --url 'https://api-test.puraroute.com/gin/open-api/v1/dynamic/traffic/orders?status=COMPLETED&create_time_start=2026-08-01T00%3A00%3A00%2B08%3A00&page_no=1&page_size=20' \
  --header 'Accept: application/json' \
  --header 'X-API-Key: <YOUR_API_KEY>'

Response Fields

data uses the pagination structure. Each element in list contains:

Field Type Nullable Description
order_no string No Order number
status string No PROCESSING, COMPLETED, or FAILED
product_code string No Product code
traffic_gb string No Purchased traffic in GB
order_amount string No Order amount in USD
currency string No Settlement currency
traffic_lot_id string Yes ID of the traffic lot generated after completion
finish_time string Yes Completion time in GMT+8 ISO-8601 format
create_time string No Creation time in GMT+8 ISO-8601 format

Successful Response Example

{
  "code": 0,
  "msg": "success",
  "data": {
    "list": [
      {
        "order_no": "PO1912345678901234567",
        "status": "COMPLETED",
        "product_code": "DYNAMIC_1GB",
        "traffic_gb": "1.000000",
        "order_amount": "0.8500",
        "currency": "USD",
        "traffic_lot_id": "1912345678901234568",
        "finish_time": "2026-08-24T15:30:01.000+08:00",
        "create_time": "2026-08-24T15:30:00.000+08:00"
      }
    ],
    "total": 1,
    "page_no": 1,
    "page_size": 20
  },
  "next": null
}

Possible Error Codes

code Description
400001 Authentication failed
400009 The status, time range, pagination, or another parameter does not meet the requirements
500000 System processing failed and the request was not completed

On this page

List Dynamic Traffic Orders