查询劵状态信息收藏我的收藏
批量查询一个订单中的券的相关状态信息,比如已核销、已退款等状态。
使用限制
单次查询不能超过 20 个。
接口说明
- 如果在券码核销的流程中因为某种异常无法确认当前券码的核销状态,则可以通过这个接口查询券的相关状态信息。
- 只能传入同一个订单下的券列表,不能跨订单查询。
基本信息
基本信息 | |
---|---|
HTTP URL |
|
HTTP Method | POST |
权限要求 | 无 |
请求头
名称 | 类型 | 是否必填 | 描述 |
---|---|---|---|
Content-Type | string | 是 | 固定值 "application/json" |
Byte-Authorization | string | 是 | 请参见签名算法 |
请求参数
名称 | 类型 | 是否必填 | 描述 | 示例值 |
---|---|---|---|---|
order_id | string | 是 | 抖音开平内部交易订单号,通过预下单回调传给开发者服务,长度 < 64byte | ot123456 |
item_order_id_list | array(string) | 否 | 交易系统订单号下的商品单号列表。 | ["ot123", "ot456"] |
请求示例
curl --location --request POST 'https://developer.toutiao.com/api/apps/trade/v2/query_item_order_info' \ --header 'Content-Type: application/json' \ --data-raw='{ "order_id": "ot123456", "item_order_id_list": [ "ot123", "ot456" ] }'
响应参数
名称 | 类型 | 是否必填 | 描述 | 示例值 |
---|---|---|---|---|
err_no | number | 是 | 错误码,0 为成功 | 0 |
err_tips | string | 是 | 错误提示信息 | success |
data | array(object) | 是 | 返回数据 | success |
data 信息
名称 | 类型 | 是否必填 | 描述 | 示例 |
---|---|---|---|---|
item_order_id | string | 是 | 交易系统商品单号 | ot123 |
item_order_status | number | 是 | 商品单的状态:
| 0 |
valid_start_time | number | 是 | 商品单的有效开始时间,毫秒级的 Unix 时间戳 | 1658398122000 |
valid_end_time | number | 是 | 商品 单的有效截止时间,毫秒级的 Unix 时间戳 | 1658398122000 |
delivery_time | number | 是 | 商品单的核销时间,毫秒级的 Unix 时间戳 | 1658398122000 |
响应示例
正常示例
{ "err_no": 0, "err_tips": "success", "data": [ { "item_order_id": "item_order_id_example_1", "item_order_status": 1, "valid_start_time": 1642491214992, "valid_end_time": 1642491231992, "delivery_time": 1642493214992 }, { "item_order_id": "item_order_id_example_2", "item_order_status": 2, "valid_start_time": 1642491214992, "valid_end_time": 1623491214992, "delivery_time": 1642231214992 } ] }
异常示例
{ "err_no": 13000, "err_tips": "系统错误" }
错误码
HTTP 状态码 | 错误码 | 描述 | 排查建议 |
---|---|---|---|
200 | 10000 | 参数错误 | 参数不符合规范。请根据提示检查参数。 |
200 | 13000 | 系统错误,请重试 | 内部错误,重试可解决。 |
200 | 21047 | 商品单 id 不合法 | 检查 item_order_id 是否正确。 |