查询CPS信息
接口说明
查询订单 CPS 信息。可用于判断订单是否为 CPS 订单。返回数据包含订单的支付、CPS、退款(不包含退款中和退款失败记录)、核销等信息。
该接口可能存在延迟,为了确保数据准确性,可以在订单支付完成后1h再进行查询。
基本信息
| 名称 | 描述 |
|---|---|
| HTTP URL | https://open.douyin.com/api/apps/trade/v2/order/query_cps/ |
| HTTP Method | POST |
| Scope | industry_open.trade.cps |
请求参数
请求头
access-token必填String
示例:clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-type必填String
固定值"application/json"
Rpc-Transit-Life-AccountString
来客商户根账户ID
Body
order_idString
示例:mock_order_id
抖音开平内部交易订单号,长度 < 64byte,该单号通过预下单回调传给开发者服务
out_order_noString
示例:mock_out_order_no
开发者系统生成的订单号, 长度 < 64byte,与唯一order_id关联
请求示例
curl --location --request POST 'https://open.douyin.com/api/apps/trade/v2/order/query_cps/' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \ --data '{"order_id":"mock_order_id","out_order_no":"mock_out_order_no"}'
响应参数
Body展开全部子属性
data必填Struct
返回数据信息
展开子属性
extra必填Struct
展开子属性
响应示例
正常响应示例异常响应示例
{ "data": { "cps_info": { "total_commission_amount": 5252828709024977000, "cps_item_list": [ { "commission_user_douyinid": "28376271", "item_id": 8167975321795827000, "sell_amount": 3177289124363034600, "source_type": 4899120181535219000, "commission_user_nickname": "alice", "status": 1604924597393436200, "commission_rate": 83114504614100720, "task_id": "123456", "commission_amount": 4051760327280599600, "item_order_id": "ot12323123123" } ] }, "refund_info": { "total_refund_amount": 4181801412182199300, "refund_items": [ { "refund_status": "已退款", "refund_at": 7111818559075269000, "item_order_id": "ot7073664578173061416", "out_refund_no": "12894412389749193299", "refund_amount": 7468050089687574000 } ] }, "delivery_info": { "total_delivery_amount": 1959691346233795000, "delivery_items": [ { "delivery_at": 2916111336494972000, "item_order_id": "\"ot7073664578173045032\"", "delivery_amount": 9047521047297419000, "delivery_status": "已核销" } ] }, "order_id": "mock_order_id", "out_order_no": "mock_out_order_no", "payment_info": { "item_id": "xxx", "cp_extra": "xxx", "message": "SUCCESS", "channel_pay_id": "2iu208bfi2897r9hflquf", "seller_uid": "287484783", "total_fee": 6551996162590184000, "order_status": "INIT", "pay_time": "2021-12-12 00:00:00", "pay_channel": 3059055552849289000 }, "error_code": 0, "description": "" }, "extra": { "error_code": 0, "description": "", "sub_error_code": 0, "sub_description": "", "logid": "202501091759336DD882345D93F74F8AD9", "now": 1736416774 } }
错误码
| HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
|---|---|---|---|
| 200 | 2100001 | 未知错误 | 重试接口,重试3次仍报错联系抖音生活服务技术支持 |
| 200 | 2100004 | 系统繁忙,此时请开发者稍候再试 | 重试接口,重试3次仍报错联系抖音生活服务技术支持 |
| 200 | 2100005 | 参数不合法 | 更换参数 |
| 200 | 2119001 | 参数不合法 | 更换参数 |
| 200 | 2119002 | 系统繁忙,请稍候再试 | 重试 |
| 200 | 2119003 | 请求太过频繁,请稍后再试 | 重试 |
| 200 | 2119005 | 应用未获商家授权 | 联系合作商家在商家后台发起授权,并在服务商后台同意授权 |
| 200 | 2190002 | access_token无效 | 调用接口重新生成access_token |
| 200 | 2190004 | 应用未获得该能力, 请去https://open.douyin.com/申请 | 应用申请接口权限 |
| 200 | 2190008 | access_token过期,请刷新或重新授权 | 规范token刷新机制,检查是否有测试环境在同步刷新token |
| 200 | 3000001 | 根据实际业务错误返回 | 对照接口文档规范参数并重试 |
| 200 | 5000001 | 根据实际业务错误返回 | 联系抖音处理 |
