OpenAPI Documentation
OpenAPI Documentation

Get Static Proxy Purchase Order Details

Returns the purchase result for a static proxy order under the current account by order number, regardless of the channel through which the order was created. Only a COMPLETED order returns the full resource array.

API Information

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

Path Parameters

Parameter Type Required Description
order_no string Yes Static proxy purchase order number; must not be an empty string

Query parameters are not accepted.

Request Example

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

Response Fields

The response contains all fields from a purchase-order list item, plus:

Field Type Description
resources array Full resource data when the order is COMPLETED; always an empty array when it is PURCHASING or FAILED

Resource fields are the same as those in List Static Proxy Resources, including the nullability rules in that table. Because this endpoint does not filter by order-creation channel, a returned resource may have a protocol of HTTP or SOCKS5. Resources purchased through this Open API always use HTTP.

Static proxy purchases are completed as a whole. fulfilled_quantity is currently either 0 or equal to quantity; partial purchase success does not occur. A FAILED order is not refunded automatically. Contact customer support for manual handling.

Successful Response Example

{
  "code": 0,
  "msg": "success",
  "data": {
    "order_no": "PO1912345678901234567",
    "status": "COMPLETED",
    "static_type": "ISP",
    "region_code": "107",
    "duration_days": 30,
    "quantity": 1,
    "fulfilled_quantity": 1,
    "order_amount": "10.0000",
    "currency": "USD",
    "create_time": "2026-08-24T15:30:00.000+08:00",
    "finish_time": "2026-08-24T15:35:00.000+08:00",
    "resources": [
      {
        "id": "1912345678901234568",
        "static_type": "ISP",
        "region_code": "107",
        "region_name": "United States",
        "host": "203.0.113.10",
        "ip": "203.0.113.10",
        "port": 8000,
        "account": "proxy_user",
        "password": "example-secret",
        "protocol": "HTTP",
        "resource_status": "ACTIVE",
        "buy_time": "2026-08-24T15:30:00.000+08:00",
        "expire_time": "2026-09-23T15:30:00.000+08:00",
        "create_time": "2026-08-24T15:35:00.000+08:00",
        "update_time": "2026-08-24T15:35:00.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

Resources include proxy account credentials and passwords. Treat them as sensitive information.

On this page