订单归因查询
接口说明
- 服务商通过接口查询订单归因详情,支持两种查询方式:
- 根据订单 ID 查询对应订单归因,入参:订单 IDs(查询数量限制最大50个)、商户 id;
- 根据商户 ID查询指定时间内该商户下的订单归因结果,入参:商户 ID、支付起始时间、支付结束时间;
- 只支持查询2024-01-01至前一天的数据
- 订单ID和支付起始时间、支付结束时间必须传一个
- 方式一:一批订单ID
- 方式二:支付起始时间、支付结束时间
- 查询指定时间的时候,必须分页(page_num和page_size参数)
使用限制
SLA:支持的最大QPS:100;PCT99承诺值:1000ms;
基本信息
| 名称 | 描述 |
|---|---|
| HTTP URL | https://open.douyin.com/goodlife/v1/homed/trade/ordersource/query/ |
| HTTP Method | GET |
| Scope | life.capacity.homed.trade.ordersource.query |
| 权限要求 |
|
请求参数
请求头
access-token必填String
示例:clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-type必填String
固定值"application/json"
Rpc-Transit-Life-AccountString
来客商户根账户ID
Query
account_id必填String
商户id
order_idsArray<String>
抖音生活服务一批订单ID
校验:数量限制最大50个
见抖音-团购频道-订单详情
page_numInt32
第几页(首页传1)
page_sizeInt32
页大小,取值范围1~100
pay_end_timeInt64
支付结束时间(秒时间戳,支付起止时间必须同时传入)
pay_start_timeInt64
支付起始时间 (秒时间戳,支付起止时间必须同时传入)
source_result_typeArray<Int32>
归因结果类型
1-带货角色归因 2-交易上翻激励流量归因
填写规则:
- 不传入或者传入[1,2],查询1和2两类归因结果
- 传入1,仅查询“带货角色归因 ”
- 传入2,仅查询“交易上翻激励流量归因”
激励流量归因数据只有20241101之后才有数据
请求示例
curl --location --request GET 'https://open.douyin.com/goodlife/v1/homed/trade/ordersource/query/?source_result_type=[5074156702976704554]&account_id=qkVNI05EBN&order_ids=[ykv1RXjrfv]&pay_start_time=1889807304440796926&pay_end_time=4908199613198182992&page_num=3026608564761721167&page_size=9191414690823956341' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \
响应参数
Body展开全部子属性
extra必填Struct
扩展信息
展开子属性
dataStruct
-
展开子属性
响应示例
正常响应示例异常响应示例
{ "extra": { "error_code": 0, "description": "", "sub_error_code": 0, "sub_description": "", "logid": "20250624143735C5A0D6739DE6CC370F5E", "now": 1750747056 }, "data": { "orders": [ { "nickname": "jaVbAZ2apY", "item_id": "sMAyFuwWhz", "video_incentive_traffic": 4874729018172554000, "source_role": 9089597453900780000, "commission_amount": 5530091592996751000, "pay_time": 2809020690983112000, "source_type": 964829425608709800, "open_id": "2yW87P5dXp", "live_incentive_traffic": 152674874194485700, "order_id": "EalQgcBmcQ" } ], "page": { "page_num": 4842932724496096000, "page_size": 8725754410904240000, "total": 206139873426323140 }, "search_after": { "cursor": [ "8F2wL6361E" ], "all_cursor": [ [ "fByhvPBJLW" ] ], "size": 3456801168278929000 }, "error_code": 0, "description": "" } }
错误码
| HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
|---|---|---|---|
| 200 | 2100001 | 未知错误 | 重试接口,重试3次仍报错联系抖音生活服务技术支持 |
| 200 | 2100004 | 系统繁忙,此时请开发者稍候再试 | 重试接口,重试3次仍报错联系抖音生活服务技术支持 |
| 200 | 2100005 | 参数不合法 | 更换参数 |
| 200 | 2190002 | access_token无效 | 调用接口重新生成access_token |
| 200 | 2190004 | 应用未获得该能力, 请去https://open.douyin.com/申请 | 应用申请接口权限 |
| 200 | 2190008 | access_token过期,请刷新或重新授权 | 规范token刷新机制,检查是否有测试环境在同步刷新token |
| 200 | 2119001 | 参数不合法 | 更换参数 |
| 200 | 2119002 | 系统繁忙,请稍候再试 | 重试 |
| 200 | 2119003 | 请求太过频繁,请稍后再试 | 重试 |
| 200 | 2119005 | 应用未获商家授权 | 联系合作商家在商家后台发起授权,并在服务商后台同意授权 |
| 200 | 3000001 | 根据实际业务错误返回 | 对照接口文档规范参数并重试 |
| 200 | 4000001 | 根据实际业务错误返回 | 补充参数 |
| 200 | 4000002 | 根据实际业务错误返回 | 对照接口文档规范参数并重试 |
| 200 | 5000001 | 根据实际业务错误返回 | 联系抖音处理 |
| 200 | 3000001 | 以实际错误信息为准 | 详见错误描述信息 |
| 200 | 5000001 | 系统错误,请重试 | 多次重试失败请联系抖音处理 |
