API Static proxies
API Static proxies

List Static Proxy Purchase Orders

List static proxy purchase orders for the current account using pagination and optional filters. Each item includes an order-level summary and fulfillment summaries for its regions.

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 blank
status string No UNFULFILLED, PROCESSING, SUCCESS, PARTIAL_SUCCESS, or FAILED
create_time_start string No Inclusive creation-time lower bound with Z or an explicit offset
create_time_end string No Inclusive creation-time upper bound 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 1–100

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

Request example

curl --request GET \
  --url 'https://api.puraroute.com/gin/open-api/v1/static/purchase-orders?status=PROCESSING&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 list item contains:

Field Type Nullable Description
order_no string No Order number
status string No One of the five order-level statuses
static_type string No ISP or ISP_NATIVE
duration_days integer No Purchase duration
quantity integer No Total quantity across all regions
fulfilled_quantity integer No Number of resources fulfilled successfully
order_amount string No Total 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 final status; null while processing
regions object[] No Regional fulfillment summaries
regions[].region_code string No Region code
regions[].quantity integer No Quantity purchased for this region
regions[].fulfilled_quantity integer No Number fulfilled successfully in this region
regions[].order_amount string No Amount for this region in USD
regions[].status string No WAIT_PAY, PROCESSING, SUCCESS, or FAILED

Success response example

{
  "code": 0,
  "msg": "success",
  "data": {
    "list": [
      {
        "order_no": "PO1912345678901234567",
        "status": "PARTIAL_SUCCESS",
        "static_type": "ISP",
        "duration_days": 30,
        "quantity": 3,
        "fulfilled_quantity": 2,
        "order_amount": "30.0000",
        "currency": "USD",
        "create_time": "2026-08-24T15:30:00.000+08:00",
        "finish_time": "2026-08-24T15:35:00.000+08:00",
        "regions": [
          {"region_code": "US_CA", "quantity": 2, "fulfilled_quantity": 2, "order_amount": "20.0000", "status": "SUCCESS"},
          {"region_code": "JP_TK", "quantity": 1, "fulfilled_quantity": 0, "order_amount": "10.0000", "status": "FAILED"}
        ]
      }
    ],
    "total": 1,
    "page_no": 1,
    "page_size": 20
  },
  "next": null
}

The list does not return connection accounts, passwords, or failure reasons. For SUCCESS and PARTIAL_SUCCESS orders, obtain successfully fulfilled resources through List static proxy resources. FAILED and PARTIAL_SUCCESS results are not refunded automatically; contact customer support.

Possible error codes

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

On this page

List Static Proxy Purchase Orders