OpenAPI 接口文档
OpenAPI 接口文档
查询静态代理购买订单详情
按订单号查询当前账号的静态代理购买结果,不按订单创建入口过滤。只有 COMPLETED 订单返回完整资源数组。
接口信息
| 项目 | 内容 |
|---|---|
| Method | GET |
| Path | /open-api/v1/static/purchase-orders/{order_no} |
| 认证 | X-API-Key |
| 处理方式 | 同步 |
路径参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
order_no |
string | 是 | 静态代理购买订单号,不能是空串 |
不接受 Query 参数。
请求示例
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>'
响应参数
响应包含购买订单列表项的全部字段,并增加:
| 字段 | 类型 | 说明 |
|---|---|---|
resources |
array | COMPLETED 时返回完整资源;PURCHASING 或 FAILED 时固定为空数组 |
资源元素字段与查询静态代理资源相同,并遵循该表中的空值规则。由于本接口不按订单创建入口过滤,查询结果中资源的 protocol 可能为 HTTP 或 SOCKS5;通过本 Open API 创建的购买订单资源固定为 HTTP。
静态采购按整单完成。fulfilled_quantity 当前只会是 0 或与 quantity 相同,不会出现部分采购成功。订单为 FAILED 时不会自动退款,请联系客户支持人工处理。
成功响应示例
{
"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
}
可能的错误码
code |
说明 |
|---|---|
300001 |
订单不存在或不可访问 |
400001 |
认证失败 |
400009 |
路径或请求参数不符合要求 |
500000 |
系统处理失败,请求未完成 |
资源包含连接账号和密码,请按敏感信息处理。