OpenAPI Documentation
OpenAPI Documentation

Get Dynamic Traffic Order Details

Returns a dynamic traffic purchase order by order number. A completed order also includes full information about its corresponding traffic lot.

API Information

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

Path Parameters

Parameter Type Required Description
order_no string Yes Dynamic traffic order number

Query parameters are not accepted.

Request Example

curl --request GET \
  --url 'https://api-test.puraroute.com/gin/open-api/v1/dynamic/traffic/orders/PO1912345678901234567' \
  --header 'Accept: application/json' \
  --header 'X-API-Key: <YOUR_API_KEY>'

Response Fields

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
valid_days integer Yes Product validity in days; null means the product never expires
traffic_lot object Yes Traffic lot for a completed order; null for other statuses

traffic_lot is a historical traffic-lot snapshot with the following fields:

Field Type Nullable Description
id string No Traffic lot ID
purchased_traffic_gb string No Traffic purchased in this lot
consumed_traffic_gb string No Traffic consumed from this lot
expired_traffic_gb string No Traffic expired from this lot
remaining_traffic_gb string No Traffic remaining in this lot
status string No ACTIVE, DEPLETED, or EXPIRED
effective_time string No Effective time in GMT+8 ISO-8601 format
expire_time string Yes Expiration time in GMT+8 ISO-8601 format; null means the lot never expires
create_time string No Creation time in GMT+8 ISO-8601 format

When valid_days is null, the product never expires; expire_time in the completed traffic lot is also null.

Order details may return a historical lot that is depleted or expired. In contrast, List Active Traffic Lots returns only ACTIVE lots.

Successful Response Example

{
  "code": 0,
  "msg": "success",
  "data": {
    "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",
    "valid_days": 30,
    "traffic_lot": {
      "id": "1912345678901234568",
      "purchased_traffic_gb": "1.000000",
      "consumed_traffic_gb": "0.000000",
      "expired_traffic_gb": "0.000000",
      "remaining_traffic_gb": "1.000000",
      "status": "ACTIVE",
      "effective_time": "2026-08-24T15:30:01.000+08:00",
      "expire_time": "2026-09-23T15:30:01.000+08:00",
      "create_time": "2026-08-24T15:30:01.000+08:00"
    }
  },
  "next": null
}

Possible Error Codes

code Description
300001 The order does not exist or is not accessible
400001 Authentication failed
400009 The path or request parameters do not meet the requirements
500000 System processing failed and the request was not completed

On this page