抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台

接口说明

买单订单列表(含加密实名信息)查询

此接口数据会有一定的延迟,可用于如搜索、数据核验、界面视图等场景;不建议用于业务逻辑判断,业务逻辑判断请使用单订单查询的实时接口

  1. 此接口将会返回全量买单订单,包含商家收银和用户买单的数据
  2. 可通过此接口查询支付成功未退款订单的加密实名信息,方便比对是否用户信息一致
  3. 必传入订单号或三方订单号,支持批量查询,最大一次20个
  4. 出于安全性考虑,每一批订单ids最多只允许传入20个订单id
  5. 买单收银能力开放过程中,商家系统在国补报销中,需要核对内部系统中购买人信息和抖音购买人是否一致可以使用本接口中identity_name_code字段,该字段是 支付单用户姓名+用户证件号码经过SHA256加密之后的结果,只能用于信息比对
  6. 出于安全考虑,只有国补订单会返回identity_type(用户证件类型)、identity_name_code(支付单用户姓名+用户证件号码加密结果)字段

使用限制

SLA:支持的最大QPS:50;PCT99承诺值:1000ms;

基本信息

名称描述
HTTP URL
https://open.douyin.com/goodlife/v1/homed/trade/payment/order/user_info/query/
HTTP Method
POST
Scope
life.capacity.homed.trade.payment.order.user_info.query
权限要求
  • 开发者需要申请权限:商家买单能力
    • 开放平台路径:抖音开放平台 > 控制台 > 应用详情 > 解决方案
    • 商家授权路径:抖音来客 > 店铺管理 > 第三方应用授权

请求参数

请求头
access-token必填String
示例:clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-type必填String
固定值"application/json"
Rpc-Transit-Life-AccountString

来客商户根账户ID

Body展开全部子属性
account_id必填String
商家账户id
filterStruct
订单筛选信息
展开子属性
请求示例
curl --location --request POST 'https://open.douyin.com/goodlife/v1/homed/trade/payment/order/user_info/query/' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \ --data '{"account_id":"jjf5IRwo0s","filter":{"order_ids":["bLwKEP31XO"],"out_order_ids":["sfsBWWKJP3"]}}'

响应参数

Body展开全部子属性
extra必填Struct
扩展信息
展开子属性
dataStruct
订单列表数据
展开子属性
响应示例
正常响应示例异常响应示例
{ "data": { "error_code": 0, "description": "", "orders": [ { "identity_name_code": "Y3pzx5uR37", "identity_type": 4584790849980178400, "order_id": "kzOinSKXet", "order_type": 1, "out_order_id": "PWDDbDq5lB", "status": 1 } ] }, "extra": { "description": "OP6UHRXqgT", "error_code": 3990968690951856600, "logid": "wOO5JygayD", "now": 4470003471499000300, "sub_description": "cXsb7nAY52", "sub_error_code": 6536427495727153000 } }
切换单列布局

错误码

HTTP 状态码错误码错误码描述排查建议
2002100001
未知错误
重试接口,重试3次仍报错联系抖音生活服务技术支持
2002100004
系统繁忙,此时请开发者稍候再试
重试接口,重试3次仍报错联系抖音生活服务技术支持
2002100005
参数不合法
请根据接口错误返回信息调整参数
2002119001
参数不合法
请根据接口错误返回信息调整参数
2002119002
系统繁忙,请稍候再试
重试
2002119003
请求太过频繁,请稍后再试
重试
2002119005
应用未获商家授权
联系合作商家在商家后台发起授权,并在服务商后台同意授权
2002119010
接口已下线
接口已下线
2002190002
access_token无效
调用接口重新生成access_token
2002190004
应用未获得该能力, 请去https://open.douyin.com/申请
应用申请接口权限
2002190008
access_token过期,请刷新或重新授权
规范token刷新机制,检查是否有测试环境在同步刷新token
2003000001
根据实际业务错误返回
对照接口文档规范参数并重试
2005000001
根据实际业务错误返回
联系抖音处理
2003000002
以实际错误信息为准
详见错误描述信息
2005000001
系统错误,请重试
多次重试失败请联系抖音处理
2003000001
以实际错误信息为准
详见错误描述信息
2005000001
系统错误,请重试
多次重试失败请联系抖音处理