订单查询
通过接口查询指定范围的订单列表及订单详情:
1、查询指定状态的订单列表,用于对账或差异单最新状态确认;
2、查询指定用户的订单列表,用于积分计算、订单展示;
3、查询指定订单详情,用于接口补偿处理。
开票说明
尊敬的商家,依据税务规则与《抖音生活服务平台商户合作协议》的约定,如用户向商家申请开具发票,商家应按照用户实际支付金额向用户开具相应金额的发票。用户的实际支付金额可参考订单查询pay amount字段展示的具体金额(用户实际支付金额,不含平台等其他方补贴的金额)。
针对平台补贴需向平台开具增值税发票,请勿开具给用户。若商家向用户超额开具发票,由此导致的损失及税务风险需由商家自行承担
接口 SLA
指标 | 数值 |
可承载最大qps | 500 |
响应耗时pct99 | 1s |
服务目标可用性 | 99.9% |
接口说明
- 服务商通过接口查询订单详情,支持三种查询方式:
- 根据订单 ID 或第三方订单号,查询对应订单详情,入参:订单 ID/第三方订单号、商户 id;
- 根据订单状态和商户 id,查询指定时间内该商户下的订单列表,入参:商户 id、订单状态、创单起止时间/修改起止时间;
- 根据用户 id 和商户 id,查询某用户在该商户下的所有订单,入参:商户 id、用户 id、创单起止时间/修改起止时间;
- 支付后未发码/发码失败订单查询方式:限定订单状态为“已支付”,如用户下单后超过 10 分钟未发码会发起退款;
- 退款申请待审核订单查询方式:限定券状态为“退款中”,如退款状态未响应超过 72 小时会自动退款。
使用限制
SLA:支持的最大QPS:20;
基本信息
| 名称 | 描述 |
|---|---|
| HTTP URL | https://open.douyin.com/goodlife/v1/trade/order/query/ |
| HTTP Method | GET |
| Scope | life.capacity.order.query |
| 权限要求 |
|
请求参数
请求头
access-token必填String
示例:clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-type必填String
固定值"application/json"
Rpc-Transit-Life-AccountString
来客商户根账户ID
Query
account_id必填String
来客商户根账户ID
page_num必填Int32
页数从1开始,如果使用page分页,页数*大小不能超过10000
page_size必填Int32
页大小,取值范围1~100
create_order_end_timeInt64
创单结束时间(秒时间戳,创单起止时间必须同时传入)
create_order_start_timeInt64
创单起始时间 (秒时间戳,创单 起止时间必须同时传入)
cursorArray<String>
根据游标滚动请求,直到返回结果数量小于请求的size或未返回search_after结束;首页传"0",之后传返回参数中的CursorValue string数组拼接的string,如CursorValue返回参数["0","1"],则传"0,1";如果传入此参数,会优先使用cursor翻页,而不是page翻页
ext_order_idString
开发者系统中的订单号
get_secret_numberBool
是否需要查询配送信息
open_idString
抖音内部用户的一种唯一标识
order_idString
抖音生活服务订单ID
见抖音-团购频道-订单详情
order_statusInt32
订单状态
update_order_end_timeInt64
修改结束时间(秒时间戳,修改起止时间必须同时传入)
update_order_start_timeInt64
修改起始时间 (秒时间戳,修改起止时间必须同时传入)
请求示例
curl --location --request GET 'https://open.douyin.com/goodlife/v1/trade/order/query/?page_size=5141232560769604146&ext_order_id=Q2yPt8iO8K&create_order_start_time=3053754253470185908&page_num=1858301533688665833&update_order_end_time=273742677600599368&order_status=1873689641868769903&update_order_start_time=8231097561038235688&open_id=cJRLPF0dc9&get_secret_number=false&cursor=[mL44Atm5cu]&order_id=RLvQZe4K6U&create_order_end_time=666170424449542401&account_id=zV4AIYjnuj' \ --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": "20260204111655765F3F6B9389D0BF8E7C", "now": 1770175015 }, "data": { "search_after": { "AllCursorValue": [ [ "TsKFNI2Bol" ] ], "Size": 2665555918682515000, "CursorValue": [ "spYxtW2Thz" ] }, "orders": [ { "source_order_id": "jv2ur6w6XO", "user_id": 3751364334242874000, "room_id": "LoqHx57uH3", "merchant_info": { "account_name": "2751BsZ2IY", "account_id": "kB2mBCSAgi" }, "pay_time": 6834979254700041000, "contacts": [ { "name": "67PA962TaR", "phone": "rzs0GM7xS6", "phone_encrypt": "Ohl9Bgsp18" } ], "poi": { "poi_id": "DVzAMPoUij", "poi_name": "YLerTj19ys", "url": "trYTS5aOMA" }, "discount_amount": 8719852287872607000, "is_deliver_later": false, "payment_discount": 8979796804524984000, "create_order_time": 3649237583524954600, "third_sku_id": "oqsigbaXw1", "intention_poi_id": "uE33y71VBq", "pay_amount": 7551439817703541000, "sku_name": "pKKNLCLClr", "receiver_info": { "lat": 0.807051241434395, "receiver_phone": "yZUMgjFBZr", "city": "motAeIhLxs", "secret_number": "l47A58KOys", "province": "urJEnawcSi", "district": "bzO7tGL0MJ", "receiver_name": "9joOt1UNaC", "receiver_real_phone": "HAfMfoNtMM", "location_address": "N7FDsMlKP0", "town": "DnrCi8fKa0", "lng": 0.5372395736673196, "location_name": "hQ4NV16lbj", "door_plate_num": "p7aWJgCA8u" }, "sku_id": "eztLhx3vAe", "count": 5261999382438910000, "order_type": 8992366643911804000, "craftsman_uid": "8nCcNhYQQg", "order_sale_info": { "transfer_uid": "1Lno1mybE4", "sale_role": "NOAhNdgAeW", "sale_channel": "FsRdA5GeC6", "transfer_nickName": "FigoKmFiaP" }, "buyer_info": { "buyer_secret_number": "SJKNyMkKct", "buyer_real_phone": "YIU5Y7qFTc", "buyer_phone": "gVbIdnWQoY" }, "order_id": "6eBXCTEzrc", "update_order_time": 1003800777640802600, "poi_id": "LKIPIzYcVp", "certificate": [ { "order_item_id": "RbDSqwPi1T", "refund_amount": 1759274477601627000, "fulfil_mode": 1, "certificate_id": "lOTAr1OUDl", "item_status": 2224544700601917200, "item_update_time": 1376706654636491500, "combination_id": "ZzkNbZB3Iw", "refund_time": 6404980568717877000 } ], "original_amount": 4225030488206393000, "amount_info": { "commission_amount": 842888305647161300, "pay_amount": 348572563144307300, "estimated_order_income": 2570426551511151600, "activities_fee_amount": 9021991420609758000, "platform_deliver_freight_fee": 9027467671419995000, "origin_amount": 1539701390760587300, "brand_discount_amount": 7510641194542120000, "sale_price": 6160069951283448000, "freight_pay_amount": 7674314239437619000, "platform_discount_amount": 2784360255814778400, "provider_discount_amount": 1833164728064175600, "product_origin_amount": 7379614162480773000, "merchant_discount_amount": 3014117224800238600, "pay_discount_amount": 4219735479096740400, "merchant_deliver_freight_fee": 3840061366929587000, "deduct_info_list": [ { "source_provider_discount_amount": 1678058146503140400, "source_order_id": "AkBsCaWXov", "source_sku_id": 3712548795779472000, "voucher_type": 1, "source_product_name": "t51UOIoP11", "source_certificate_id": "r6WX22blwD", "source_merchant_discount_amount": 5688236133134095000, "source_brand_discount_amount": 5172640198685690000, "source_platform_discount_amount": 2115102068060029400, "source_sku_name": "AtC93J8EAC", "groupon_type": 1, "source_pay_amount": 6809806846336668000, "source_selling_price": 1486009247007948500, "source_product_id": 4659340263285305000, "source_payment_discount_amount": 4171578016762386400, "source_origin_amount": 3732642890320891400 } ], "deduct_amount": 885518577124783100 }, "products": [ { "num": 3454611424147749400, "ext_product_id": "qqiljogjcA", "snapshot_product": { "tag_info_list": [ { "TagName": "jzsuhTvqBA", "TagValue": "zqB8oP98HF", "TagKey": "6ndlWAlhxj" } ], "product_attr": { "voucher_par_type": 1, "dynamic_par_rule": { "dynamic_par_rule_desc": "TKk5tTIbyf", "dynamic_par_min_amount": 5487644509958985000, "dynamic_par_max_amount": 5513316940130031000, "dynamic_par_rule_item_list": [ { "time_period": { "use_end_time": "bMn7hTMGG0", "end_time_is_next_day": false, "use_start_time": "eZJxaS4gmV" }, "deductible_amount": 7132273104508710000, "day_of_week": [ 1 ] } ] }, "show_channel": 1, "advance_purchase_struct": { "purchase_type": 1, "time_detail": [ { "time_type": 1, "time": 1468270363191644200 } ] }, "combo_package_verify_limit_struct": { "type": 1, "product_id_index": { "3758993876978427182": 6071650595776486000 } } } }, "product_name": "wY6gMW3OJb", "sku_id": "vTdv8BjJff", "origin_amount": 3091488548578129400, "product_origin_amount": 1238307057637109800, "third_sku_id": "Ik4jksTPx2", "product_id": "rn1b76JClK", "commodities": [ { "items": [ { "item_tag": "IKfPLARc9P", "sku_attr_list": [ { "attr_name": "Ik3UkJDqKk", "num": 596793400497523300 } ], "name": "VDigaVHc4j", "price": 6547063892172498000, "desc": "dwWODt2lKA", "attr_list": [ "wB4ktjMNvG" ], "unit": "LKxGbG03Jk", "count": 8770406864837561000 } ], "group_name": "REkwgi1Hpl", "total_count": 4883180500355039000, "option_count": 6910137481818204000 } ] } ], "open_id": "azJE18ug8t", "discounts": [ { "idle_time_info": { "idle_time_limit_type": 1, "WriteOffTimeLimit": { "WriteOffEndTime": 7703026861204081000, "DailyTimeRangeList": [ { "StartTime": "msn7wOSDCt", "EndTime": "6z2kIqojjj" } ], "RelativeTime": { "RelativeTimeType": 1, "RelativeTime": 3318915294156969000 }, "WeekDayList": [ 1 ], "WriteOffStartTime": 968088863849601900 } }, "brand_discount_amount": 5920668555449570000, "discount_type": 831422869013544100, "discount_amount": 5474513944979352000, "merchant_discount_amount": 7926713117297512000, "platform_discount_amount": 1865638516494248400, "provider_discount_amount": 3884614815642863600 } ], "receipt_amount": 2433690503959338000, "delivery_info": { "shop_number": "IYOxYwcrpg", "is_book": false, "user_expect_time": "3gc0Lk3EEX", "sys_expect_time": "TW8pwpxMnp", "remark": "tmxyxSDk4O", "table_ware": "ZpYflggSXp", "deliver_model": 5974621839737880000 }, "anchor_id": 5621379591957688000, "sub_order_amount_infos": [ { "sub_order_id": "EBvU3LdwtP", "discount_amount": 5404959544691850000, "sub_order_type": 7283548191494540000, "discounts": [ { "brand_discount_amount": 2782144682894421000, "discount_type": 2594599882026261000, "discount_amount": 6697705731647289000, "merchant_discount_amount": 5475486355347226000, "platform_discount_amount": 876597176910584300, "provider_discount_amount": 3560551465505175000, "idle_time_info": { "idle_time_limit_type": 1, "WriteOffTimeLimit": { "RelativeTime": { "RelativeTimeType": 1, "RelativeTime": 7415848184152354000 }, "WeekDayList": [ 1 ], "WriteOffStartTime": 7756316740607409000, "WriteOffEndTime": 1597115272971901700, "DailyTimeRangeList": [ { "EndTime": "LSFFIG1yEg", "StartTime": "4xnnaEqZw6" } ] } } } ], "pay_amount": 8142482571276453000, "receipt_amount": 5968450773774750000, "combination_id": "yHmEjeZbBw", "origin_amount": 8286901962762242000 } ], "order_status": 8165006094586098000 } ], "page": { "page_num": 8985748951263764000, "page_size": 2369339059659794000, "total": 2619332382699135500 }, "error_code": 0, "description": "" } }
错误码
| HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
|---|---|---|---|
| 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 | 2100001 | 未知错误 | 重试接口,重试3次仍报错联系抖音生活服务技术支持 |
| 200 | 2100004 | 系统繁忙,此时请开发者稍候再试 | 重试接口,重试3次仍报错联系抖音生活服务技术支持 |
| 200 | 2100005 | 参数不合法 | 更换参数 |
| 200 | 3000001 | 以实际错误信息为准 | |
| 200 | 5000001 | 服务器打瞌睡了,请稍后再试。 |
附录
(1)订单维度订单状态
order | 状态 | 状态定义 |
0 | 初始化 | 创单初始值 |
100 | 待支付 | 创单成功,未完成支付,15min待支付等待期 |
101 | 支付取消 | 用户取消支付或超时未支付 |
200 | 已支付 | 用户完成支付 |
201 | 待使用 | 发码成功,商品还未使用或完成预约 |
1 | 已完成 | 订单完成履约或者全部退款 |
(2)预售-券维度的订单状态
value | B端 | 状态语义 | 驱动角色 |
0 | 初始化 | 创单初始值 | - |
100 | 待使用 | 该商品未发生预约、预订失败回滚 | 系统 |
200 | 预订中 | 用户正在确认该商品的预订单 | 商户 |
201 | 已预订 | 用户已确认预约信息,契约达成 | 用户 |
300 | 退款中 | 发起退款流程 | 用户/商户/系统/客服 |
301 | 已退款 | 退款成功 | 系统 |
400 | 履约中 | 已到履约时间,订单开始履约 | 系统 |
401 | 已履约 | 该商品完成履约 | 系统 |
(3)团购-券维度的订单状态
value | B端 | 状态语义 | 驱动角色 |
0 | 初始化 | 创单初始值 | - |
100 | 待使用 | 该商品未发生预约、预订失败回滚 | 系统 |
300 | 退款中 | 发起退款流程 | 用户/商户/系统/客服 |
301 | 已退款 | 退款成功 | 系统 |
400 | 履约中 | 已到履约时间,订单开始履约 | 系统 |
401 | 已履约 | 该商品完成履约 | 系统 |
