买单订单列表查询
接口说明
用于批量查询买单订单
此接口数据会有一定的延迟(5s以内),可用于如搜索、界面视图等场景;不建议用于业务逻辑判断,业务逻辑判断请使用买单订单详情接口
- 此接口将会返回全量买单订单,包含商家收银和用户买单的数据
- 预下单时间为「商家收银」类型订单的创建时间,支付时间为用户支付成功时间
- 使用支付时间查询,会丢失「商家收银」类型但用户未支付或取消支付的订单;建议针对上述订单可使用预下单时间查询
- 支持根据订单 id 、预下单id、第三方订单id查询,同时支持根据支付时间等参数进行查询
- 如果传入了订单 id 、预下单 id、第三方订单 id 的任意一个,同时也传入了其他查询参数,会优先使用 id 进行查询
- 普通订单:消费总额-代金券抵扣金额-平台补贴优惠-支付渠道优惠=订单单实付金额(pay_amount) 国补订单:消费总额-代金券抵扣金额-平台补贴优惠-支付渠道优惠-国补补贴金额=订单实付金额(pay_amount) 企补订单:消费总额-企补优惠-平台补贴优惠-支付渠道优惠=订单实付金额(pay_amount)
使用限制
SLA:支持的最大QPS:50;PCT99承诺值:1000ms;
基本信息
| 名称 | 描述 |
|---|---|
| HTTP URL | https://open.douyin.com/goodlife/v1/homed/trade/payment/order/query/ |
| HTTP Method | POST |
| Scope | life.capacity.homed.trade.payment.order.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/query/' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \ --data '{"account_id":"K7kw2SZjZy","filter":{"pre_order_ids":["aTZk397DGk"],"open_id":"ZGUa0tHjZO","out_order_ids":["IXpUQuJRFq"],"order_type":1,"pay_start_time":4020770415561930672,"order_ids":["8vaqslJAMq"],"page":{"page_size":8475175417015698225,"page_num":26817150882960308},"create_time_end":7580777929023181551,"create_type":1,"pay_end_time":6681383508151431491,"poi_ids":[187533512975173591],"status":1,"create_time_start":9065198486197349418}}'
响应参数
Body展开全部子属性
extra必填Struct
扩展信息
展开子属性
dataStruct
订单列表数据
展开子属性
响应示例
正常响应示例异常响应示例
{ "data": { "error_code": 0, "description": "", "orders": [ { "amount": { "discount_amount": 3462784347052524000, "enterprise_subsidy_discount_amount": 4487903701423245300, "non_disaccountable_amount": 5798725857051475000, "pay_amount": 4040281455256758300, "payment_coupon_amount": 5041247707465673000, "platform_subsidy_discount_amount": 8511726896705043000, "total_amount": 3626987851771054000 }, "applet_jump_url": "xfvlEJYMJk", "cancel_reason": "uZ5oylYXZL", "create_type": 1, "external_jump_url": "tD3qcbLB5v", "gov_subsidy_payment_order_info": { "shop_info": { "corp_company_name": "La33JZNM6j", "corp_unisc_id": "UWwJCqn2Wy" }, "subsidy_amount": "eFggFAmAV4", "unionpay_trade_no": "KwSym0OdWA" }, "job_number": "A9UpB6Yebz", "not_pay_cancel_time": 8283759624542823000, "open_id": "RHwi3ZYBDU", "order_detail_short_url": "EERk6777Cm", "order_id": "VnJ1yHNMLy", "order_type": 1, "out_order_id": "RQAXS5jml0", "pay_time": 7748970316594184000, "poi_id": "RcZREZyqaO", "pre_order_create_time": 1694641049454870500, "pre_order_id": "2I8PvITSx5", "remark": "pY8di2gaAp", "salesperson_info": "6TYWLq2RwZ", "sku_list": [ { "count": 2799362602177057300, "government_subsidy_info": "jJGYh4Omnu", "product_title": "5h4DLRia0P", "unit_amount": 462144540781674300 } ], "status": 1, "verify_record_list": [ { "discount_amount": 4215748475427053600, "product_name": "1vjDeS0uYZ", "relation_order_id": "9idGk2Dxr7", "verify_id": "VpAkcAkOaI", "verify_time": 6226560793277793000, "voucher_code_type": 7803856504553098000 } ] } ], "page": { "total": 7049431955035969000 } }, "extra": { "description": "Y1Vxvc9aHc", "error_code": 2210441390485569800, "logid": "tOPpDKsBoW", "now": 1955516065516648200, "sub_description": "gItx9SXsTk", "sub_error_code": 1408629756547736000 } }
错误码
| 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 | 根据实际业务错误返回 | 联系抖音处理 |
| 200 | 5000001 | 系统错误,请重试 | 多次重试失败请联系抖音处理 |
| 200 | 3000001 | 系统错误,请重试 | 多次重试失败请联系抖音处理 |
| 200 | 3000001 | 以实际错误信息为准 | 详见错误描述信息 |
| 200 | 3000002 | 以实际错误信息为准 | 详见错误描述信息 |
