查询CPS信息
接口说明
可用于判断订单是否为 CPS 订单,查询订单的佣金等信息
使用限制
无
基本信息
名称 | 描述 |
---|---|
HTTP URL | https://open.douyin.com/api/trade_basic/v1/developer/query_cps/ |
HTTP Method | POST |
Scope | trade_basic.developer.trade_buy |
权限要求 | 不需要用户授权 |
请求参数
请求头
access-token必填String
示例:clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-type必填String
示例:application/json
固定值"application/json"
Body
order_idString
示例:motb52726742593307630520652
交易订单号,order_id 与 out_order_no 二选一
out_order_noString
示例:ext_order_123
开发者的单号,order_id 与 out_order_no 二选一
请求示例
curl --location --request POST 'https://open.douyin.com/api/trade_basic/v1/developer/query_cps/' \ --header 'access-token: 0801121846735352506a356a6' \ --header 'content-type: application/json' \ --data '{"order_id":"4kLRt6sr38","out_order_no":"S28IAfHiE5"}'
响应参数
Body展开全部子属性
err_msg必填String
示例:success
错误提示
err_no必填Int32
示例:0
错误码
log_id必填String
示例:2023010128382726
抖音开平统一日志id
dataStruct
返回的数据信息,err_no为0 必填
展开子属性
响应示例
正常响应示例异常响应示例
{ "log_id": "2022092115392201020812109511046", "data": { "order_id": "motb76541234875648", "out_order_no": "S7dyiECO4T", "total_commission_amount": 100, "cps_item_list": [ { "commission_amount": 100, "commission_user_nickname": "owxulioyCe", "source_type": 1, "commission_rate": 10, "sell_amount": 1000, "commission_user_douyinid": "87652435209845", "task_id": "cclOwkyvq6", "item_order_id": "motb9473837748737748", "status": 2, "item_id": 3102676463474216000 } ] }, "err_no": 0, "err_msg": "success" }
错误码
HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
---|---|---|---|
200 | 10000 | 参数错误 | 对照错误提示和接口字段定义,检查对应的参数 |
200 | 11001 | 访问未授权 | 1. 订单不属于该小程序,无法查询到该订单信息,检查订单是否属于该小程序
2. 没有该接口的请求权限,需要接入通用交易解决方案开通接口权限 |
200 | 13000 | 系统错误 | 请重试,若多次重试仍然报错,请联系oncall |
200 | 20000 | 订单不存在 | 查不到该订单,请检查订单号是否传错,是否把order_id 当 out_order_no 传入 |
200 | 20004 | 订单不属于cps订单 | 不是CPS订单的原因,请查看是否有设置CPS |