OpenAPI Documentation
OpenAPI Documentation

List Static Proxy Purchase Orders

Returns a paginated list of all static proxy purchase orders under the current account that match the filters, regardless of the channel through which the order was created.

API Information

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

Query Parameters

Parameter Type Required Description
order_no string No Exact order number match; must not be an empty string
status string No PURCHASING, 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/static/purchase-orders?status=PURCHASING&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 PURCHASING, COMPLETED, or FAILED
static_type string No ISP or ISP_NATIVE
region_code string No Region code
duration_days integer No Purchase duration
quantity integer No Quantity purchased in the order
fulfilled_quantity integer No Completed quantity; during normal processing, this is currently either 0 or equal to quantity, never an intermediate value
order_amount string No Order amount in USD
currency string No Settlement currency
create_time string No Creation time in GMT+8 ISO-8601 format
finish_time string Yes Time when the order first entered a terminal status; null while processing

Successful Response Example

{
  "code": 0,
  "msg": "success",
  "data": {
    "list": [
      {
        "order_no": "PO1912345678901234567",
        "status": "PURCHASING",
        "static_type": "ISP",
        "region_code": "107",
        "duration_days": 30,
        "quantity": 2,
        "fulfilled_quantity": 0,
        "order_amount": "20.0000",
        "currency": "USD",
        "create_time": "2026-08-24T15:30:00.000+08:00",
        "finish_time": null
      }
    ],
    "total": 1,
    "page_no": 1,
    "page_size": 20
  },
  "next": null
}

The order list does not return proxy account credentials or passwords. Only the order-details endpoint returns the resource array after the entire order is completed.

Static proxy purchases are completed as a whole; partial purchase success does not occur. A FAILED order is not refunded automatically. Contact customer support for manual handling.

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