OpenAPI 接口文档
OpenAPI 接口文档

查询动态流量订单详情

按订单号查询一笔动态流量购买订单。完成订单同时返回对应流量批次的完整信息。

接口信息

项目 内容
Method GET
Path /open-api/v1/dynamic/traffic/orders/{order_no}
认证 X-API-Key
处理方式 同步

路径参数

参数 类型 必填 说明
order_no string 动态流量订单号

不接受 Query 参数。

请求示例

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

响应参数

字段 类型 可为空 说明
order_no string 订单号
status string PROCESSINGCOMPLETEDFAILED
product_code string 产品编码
traffic_gb string 购买流量,GB
order_amount string 订单金额,USD
currency string 结算币种
traffic_lot_id string 完成后生成的流量批次 ID
finish_time string 完成时间,GMT+8 ISO-8601
create_time string 创建时间,GMT+8 ISO-8601
valid_days integer 产品有效天数;null 表示永久有效
traffic_lot object 完成态对应的流量批次;其他状态为 null

traffic_lot 是历史流量批次快照,字段如下:

字段 类型 可为空 说明
id string 流量批次 ID
purchased_traffic_gb string 本批次购买流量
consumed_traffic_gb string 本批次已使用流量
expired_traffic_gb string 本批次已过期流量
remaining_traffic_gb string 本批次剩余流量
status string ACTIVEDEPLETEDEXPIRED
effective_time string 生效时间,GMT+8 ISO-8601
expire_time string 到期时间,GMT+8 ISO-8601;null 表示永久有效
create_time string 创建时间,GMT+8 ISO-8601

valid_daysnull 时,该产品永久有效;完成态批次中的 expire_time 也为 null

订单详情可能返回已用尽或已过期的历史批次。相比之下,查询有效流量批次只返回 ACTIVE 批次。

成功响应示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "order_no": "PO1912345678901234567",
    "status": "COMPLETED",
    "product_code": "DYNAMIC_1GB",
    "traffic_gb": "1.000000",
    "order_amount": "0.8500",
    "currency": "USD",
    "traffic_lot_id": "1912345678901234568",
    "finish_time": "2026-08-24T15:30:01.000+08:00",
    "create_time": "2026-08-24T15:30:00.000+08:00",
    "valid_days": 30,
    "traffic_lot": {
      "id": "1912345678901234568",
      "purchased_traffic_gb": "1.000000",
      "consumed_traffic_gb": "0.000000",
      "expired_traffic_gb": "0.000000",
      "remaining_traffic_gb": "1.000000",
      "status": "ACTIVE",
      "effective_time": "2026-08-24T15:30:01.000+08:00",
      "expire_time": "2026-09-23T15:30:01.000+08:00",
      "create_time": "2026-08-24T15:30:01.000+08:00"
    }
  },
  "next": null
}

可能的错误码

code 说明
300001 订单不存在或不可访问
400001 认证失败
400009 路径或请求参数不符合要求
500000 系统处理失败,请求未完成

On this page

查询动态流量订单详情