例如:当开发者需要查看前一天的付款和退款订单时,可以将开始时间设为前一天的零点,结束时间设为当天的零点,然后调用此接口查询相关的订单记录。
由于当天的订单信息可能还会发生变动,因此不建议使用此接口查询当天的实时订单数据,建议延迟一天查询。
当前仅支持查询180天内的订单数据。
当前不支持查询沙盒订单和0元订单。
承载协议: HTTPS POST
接口方向: 开发者服务器 -> IAP服务器
接口URL: {rootUrl}/order/harmony/v1/application/trade/orders/query
说明:rootUrl具体请参见站点信息。
数据格式:
请求消息:Content-Type: application/json; charset=UTF-8
响应消息:Content-Type: application/json; charset=UTF-8
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Content-Type | 是 | String | 取值为:application/json;charset=UTF-8 |
| Authorization | 是 | String | 认证信息,使用JWT进行鉴权,具体请参见Authorization说明。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| startTime | 是 | Long | 指定查询范围的开始时间,UTC时间戳,以毫秒为单位。 startTime不能大于当前时间。 |
| endTime | 是 | Long | 指定查询范围的结束时间,UTC时间戳,以毫秒为单位。 - 结束时间endTime与开始时间startTime的时间差为48小时或者48小时内。 - 结束时间endTime必须大于开始时间startTime。 |
| continuationToken | 否 | String | 支持分页查询的数据定位标志。 - 初始请求时无需输入,当响应结果返回continuationToken时,下一次查询时需要输入上次查询返回的continuationToken才可以查询下一页数据。 |
POST /order/harmony/v1/application/trade/orders/query
Content-Type: application/json; charset=UTF-8
Authorization: Bearer ***.***.***
Accept: application/json
{
"startTime": 1739548800000,
"endTime": 1739721600000
} HTTP/1.2 200 OK
Content-Type: application/json; charset=UTF-8
{
"responseCode": "0",
"orderInfoList": [
{
"requestId": "***",
"country": "CN",
"merchantId": "***",
"applicationId": "***",
"orderTime": 1739602800000,
"tradeTime": 1739602800000,
"productId": "***",
"productName": "test",
"payMoney": "10.00",
"couponAmt": "0.10",
"currency": "CNY",
"tradeState": 0,
"tradeType": "REFUND",
"refundTime": 1739620800000,
"refundMoney": "0.02"
},
{
"requestId": "***",
"country": "CN",
"merchantId": "***",
"applicationId": "***",
"orderTime": 1739602800000,
"tradeTime": 1739602800000,
"productId": "***",
"productName": "测试商品",
"payMoney": "0.01",
"currency": "CNY",
"tradeState": 0,
"tradeType": "PURCHASE"
},
],
"continuationToken": "***"
} | 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| requestId | 是 | String | 具体一笔订单中对应的购买订单号ID,同purchaseOrderId。最大长度256。 |
| country | 是 | String | 国家/地区码,用于区分国家/地区信息,请参见ISO 3166标准。 |
| merchantId | 是 | String | 商户ID。 |
| applicationId | 是 | String | 应用ID。 |
| orderTime | 是 | Long | 下单时间,UTC时间戳,以毫秒为单位。 |
| tradeTime | 是 | Long | 支付时间,UTC时间戳,以毫秒为单位。 说明: 支付时间(tradeTime)在[startTime,endTime)范围内的订单将被查询出来。 |
| productId | 是 | String | 商品ID。 |
| productName | 是 | String | 商品名称。 |
| payMoney | 是 | String | 支付金额,单位为元。 |
| couponAmt | 否 | String | 优惠券金额,单位为元。 |
| currency | 是 | String | 币种。 |
| tradeState | 是 | Integer | 订单状态。 0:成功。 |
| tradeType | 是 | String | 交易类型。 - PURCHASE:支付。 - REFUND:退款。 |
| refundTime | 否 | Long | 退款时间,UTC时间戳,以毫秒为单位。 |
| refundMoney | 否 | String | 退款金额,单位为元。 |