查询订单列表

API文档最后更新: 2026-08-31

7.2 查询订单列表

请求方式：GET
请求地址：/orders

查询参数：

请求字段：

字段	位置	JSON 类型	必填	含义
`page`	Query	integer	否	页码，从 1 开始，默认第 1 页
`pageSize`	Query	integer	否	每页条数，默认 20 条，最多 100 条
`clientOrderRef`	Query	string	否	按第三方订单号精确查询
`platformOrderRef`	Query	string	否	按平台订单号精确查询
`orderState`	Query	string	否	按平台订单状态筛选：`pending`、`processing`、`success`、`canceled`、`partially_refunded` 或 `refunded`
`startedAt`	Query	integer	否	创建时间范围的开始时间，10 位 Unix 秒级时间戳
`endedAt`	Query	integer	否	创建时间范围的结束时间，10 位 Unix 秒级时间戳

返回字段：

字段	JSON 类型	必填	含义
`code`	integer	是	固定为 `0`，表示请求成功
`message`	string	是	本次请求的处理说明
`data`	object	是	订单分页查询结果
`data.total`	integer	是	符合条件的订单总数
`data.page`	integer	是	当前页码
`data.pageSize`	integer	是	当前每页条数
`data.list`	object[]	是	当前页订单数组
`data.list[].clientOrderRef`	string	是	第三方订单号
`data.list[].platformOrderRef`	string	是	平台订单号
`data.list[].productRef`	integer	是	购买的商品编号
`data.list[].variantRef`	integer	是	购买的规格编号
`data.list[].units`	integer	是	购买数量
`data.list[].amount`	number	是	实际扣款金额，单位为人民币元，最多保留两位小数
`data.list[].orderState`	string	是	平台订单状态：`pending` 等待处理；`processing` 处理中；`success` 已完成；`canceled` 已取消；`partially_refunded` 部分退款；`refunded` 已退款
`requestId`	string	是	本次请求编号，排查问题时提供给平台

返回示例：

{
  "code": 0,
  "message": "success",
  "data": {
    "total": 1,
    "page": 1,
    "pageSize": 20,
    "list": [
      {
        "clientOrderRef": "PO-20260728-0001",
        "platformOrderRef": "202607280001",
        "productRef": 1001,
        "variantRef": 0,
        "units": 1,
        "amount": 100.00,
        "orderState": "pending"
      }
    ]
  },
  "requestId": "req_01K0EXAMPLE"
}

列表不返回卡密和充值输入。