OpenAPI 接口文档
OpenAPI 接口文档
查询静态代理购买订单
分页查询当前账号全部符合筛选条件的静态代理购买订单,不按订单创建入口过滤。
接口信息
| 项目 | 内容 |
|---|---|
| Method | GET |
| Path | /open-api/v1/static/purchase-orders |
| 认证 | X-API-Key |
| 处理方式 | 同步 |
Query 参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
order_no |
string | 否 | 订单号精确匹配;不能是空串 |
status |
string | 否 | PURCHASING、COMPLETED 或 FAILED |
create_time_start |
string | 否 | 创建时间下限,包含该时刻,带 Z 或显式偏移 |
create_time_end |
string | 否 | 创建时间上限,包含该时刻,带 Z 或显式偏移 |
page_no |
integer | 否 | 默认 1,大于等于 1 |
page_size |
integer | 否 | 默认 20,范围 1~100 |
开始时间不能晚于结束时间。
请求示例
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>'
响应参数
data 使用分页结构,list 元素如下:
| 字段 | 类型 | 可为空 | 说明 |
|---|---|---|---|
order_no |
string | 否 | 订单号 |
status |
string | 否 | PURCHASING、COMPLETED 或 FAILED |
static_type |
string | 否 | ISP 或 ISP_NATIVE |
region_code |
string | 否 | 地区编码 |
duration_days |
integer | 否 | 购买时长 |
quantity |
integer | 否 | 订单购买数量 |
fulfilled_quantity |
integer | 否 | 已完成数量;当前正常处理时只会是 0 或与 quantity 相同,不会出现中间值 |
order_amount |
string | 否 | 订单金额,USD |
currency |
string | 否 | 结算币种 |
create_time |
string | 否 | 创建时间,GMT+8 ISO-8601 |
finish_time |
string | 是 | 首次进入结束状态的时间;处理中为空 |
成功响应示例
{
"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
}
订单列表不返回连接账号和密码。只有详情接口在订单完整完成时返回资源数组。
静态采购按整单完成,不会出现部分采购成功。订单为 FAILED 时不会自动退款,请联系客户支持人工处理。
可能的错误码
code |
说明 |
|---|---|
400001 |
认证失败 |
400009 |
状态、时间、分页或其他参数不符合要求 |
500000 |
系统处理失败,请求未完成 |