订单查询
通过接口查询指定范围的订单列表及订单详情:
1、查询指定状态的订单列表,用于对账或差异单最新状态确认;
2、查询指定用户的订单列表,用于积分计算、订单展示;
3、查询指定订单详情,用于接口补偿处理。
开票说明
尊敬的商家,依据税务规则与《抖音生活服务平台商户合作协议》的约定,如用户向商家申请开具发票,商家应按照用户实际支付金额向用户开具相应金额的发票。用户的实际支付金额可参考订单查询pay amount字段展示的具体金额(用户实际支付金额,不含平台等其他方补贴的金额)。
针对平台补贴需向平台开具增值税发票,请勿开具给用户。若商家向用户超额开具发票,由此导致的损失及税务风险需由商家自行承担
接口说明
- 服务商通过接口查询订单详情,支持三种查询方式(不支持查询酒店行业订单信息):
- 根据订单 ID 或第三方订单号,查询对应订单详情,入参:订单 ID/第三方订单号、商户 id;该接口为订单维度查询,不支持券维度查询。
- 根据订单状态和商户 id,查询指定时间内该商户下的订单列表,入参:商户 id、订单状态、创单起止时间/修改起止时间;
- 根据用户 id 和商户 id,查询某用户在该商户下的所有订单,入参:商户 id、用户 id、创单起止时间/修改起止时间;
- 支付后未发码/发码失败订单查询方式:限定订单状态为“已支付”,如用户下单后超过 10 分钟未发码会发起退款;
- 退款申请待审核订单查询方式:限定券状态为“退款中”,如退款状态未响应超过 72 小时会自动退款。
- 承载总qps:200 (单服务商应用默认:20)
- 订单查询接口不会透传券码明文code
- 查询时间和订单完成时间一致导致需要延长2-3秒查询或增加重试机制
使用限制
transfer_uid是条件性返回字段,仅在同时满足以下两个条件时才会返回:
订单的sale_role(销售角色)为“达人”“职人”或“店员”;
订单带有明确的room_id(直播间ID)或item_id(商品ID)等关联标识。若订单不满足上述条件(如sale_role为“商家”或“ 其他”,或无关联标识),则该字段不会出现在接口返回数据中。
SLA:支持的最大QPS:20;PCT99承诺值:2ms;基本信息
| 名称 | 描述 |
|---|---|
| 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),会优先使用cursor翻页,而不是page翻页;但page_size和page_num是必填项,不传会报错
ext_order_idString
开发者系统中的订单号
get_secret_numberBool
是否需要查询配送信息
open_idString
抖音内部用户的一种唯一标识
如果对接了会员通,可以通过接收会员入会SPI接口获取并保存
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/?order_id=3tytu73Y2y&page_size=3333360562180432634&create_order_start_time=2873242746129485131&update_order_start_time=6096218378959072888&ext_order_id=qYGhDWPI1D&open_id=1upFeITgt2&create_order_end_time=3389784284111241133&get_secret_number=false&order_status=9192673946613776478&update_order_end_time=9185211423131114171&account_id=JnnpPgNQ1g&page_num=3107832213748624696&cursor=[flBLxsEt4M]' \ --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": "202606261057476EE695DEBAD0CEF1FFD1", "now": 1782442670 }, "data": { "page": { "page_num": 8728800657300335000, "page_size": 2131212434625700600, "total": 1126800059382990700 }, "search_after": { "CursorValue": [ "gtBtUvS8yF" ], "AllCursorValue": [ [ "75j0N67TzY" ] ], "Size": 7001565040625239000 }, "orders": [ { "products": [ { "origin_amount": 26381271727084184, "snapshot_product": { "product_attr": { "dynamic_par_rule": { "dynamic_par_rule_item_list": [ { "deductible_amount": 756293343746161900, "day_of_week": [ 1 ], "time_period": { "use_end_time": "SwtdqeFm3d", "end_time_is_next_day": false, "use_start_time": "UdNzXSSYFY" } } ], "dynamic_par_rule_desc": "SKFeI0GDgN", "dynamic_par_min_amount": 7761046631525442000, "dynamic_par_max_amount": 4899764271705339000 }, "show_channel": 1, "advance_purchase_struct": { "time_detail": [ { "time_type": 1, "time": 5878536339097111000 } ], "purchase_type": 1 }, "combo_package_verify_limit_struct": { "type": 1, "product_id_index": { "7645666579326490350": 1264045061642322200 } }, "voucher_par_type": 1 }, "tag_info_list": [ { "TagKey": "pijeL20yhz", "TagName": "EEY8b6DrY2", "TagValue": "2Qk38axZpM" } ] }, "sku_id": "4c8Tz1YqsQ", "num": 6096238164578567000, "product_id": "sZozOKN4Pk", "product_name": "tQCKJblPYJ", "third_sku_id": "QCa8kIq6hu", "commodities": [ { "group_name": "sTLjkM2f7K", "total_count": 4811418468097121000, "option_count": 9070074681995945000, "items": [ { "attr_list": [ "HLr2FOc6QJ" ], "price": 2673620192028338000, "sku_attr_list": [ { "attr_name": "60t0ttmAaX", "num": 1516067535710544000 } ], "name": "jhSQSdZ6Im", "unit": "UOFvUJNVIo", "desc": "OoAYqCdeaY", "item_tag": "KC0QKEEDqu", "count": 8148029038676861000 } ] } ], "ext_product_id": "BqE3kTczwZ", "product_origin_amount": 2083440892662600000 } ], "pay_bill_info": { "total_pay_amount": 3618228375113504300, "is_timely_pay_bill": false, "order_source": 1 }, "sku_name": "zAZlmgEoDb", "create_order_time": 5408068344274741000, "merchant_info": { "account_id": "nj8efh3LbQ", "account_name": "ZvF4e9K8TS" }, "delivery_info": { "shop_number": "aaJWuPx07p", "is_book": false, "user_expect_time": "jEVfGW3ofM", "sys_expect_time": "Wb4bTiCzHC", "remark": "7zUNx6o3Hy", "table_ware": "5WW1SiYYLe", "deliver_model": 2230116393426867200 }, "certificate": [ { "certificate_id": "xVu0DMSeI0", "refund_amount": 7209161703177634000, "combination_id": "8065cKCnH2", "item_status": 7565896298612724000, "item_update_time": 6058502237619263000, "refund_time": 1185374935531469000, "fulfil_mode": 1, "order_item_id": "UFDxhKzsdu" } ], "pay_time": 8958562222219346000, "poi": { "poi_id": "cg8DQ6E8Ve", "poi_name": "GJ2So9srpj", "url": "MrEewQKiWm" }, "user_id": 746648857532311000, "discount_amount": 9151269650999434000, "order_sale_info": { "sale_channel": "FqFSzTXyvh", "transfer_nickName": "qHJkPlfZHz", "transfer_uid": "2MlJrFEhuR", "transfer_douyin_uid": "tP37YSdnzd", "sale_role": "STrCkp74Ro" }, "discounts": [ { "brand_discount_amount": 2473679995101046300, "discount_type": 6028617399953862000, "discount_amount": 6719078138504936000, "merchant_discount_amount": 9069034272059041000, "platform_discount_amount": 3149564868360001500, "provider_discount_amount": 6503040544599471000, "idle_time_info": { "idle_time_limit_type": 1, "WriteOffTimeLimit": { "RelativeTime": { "RelativeTime": 4691088847213494000, "RelativeTimeType": 1 }, "WeekDayList": [ 1 ], "WriteOffStartTime": 8133089789356830000, "WriteOffEndTime": 6447753395585998000, "DailyTimeRangeList": [ { "StartTime": "aY5AKFjn1Q", "EndTime": "0LpzRnLq58" } ] } } } ], "buyer_reserve_info": [ { "credential_type": 8681462274119552000, "enc_credential_numb": "PYH6lxLfqv", "enc_name": "5s2RfKw10S" } ], "sub_order_amount_infos": [ { "combination_id": "bH5hE6E3UH", "origin_amount": 5941079016942286000, "pay_amount": 4175488008657675300, "discount_amount": 5295024958877217000, "discounts": [ { "brand_discount_amount": 692731506878119000, "discount_type": 4796004065199631000, "discount_amount": 1514259071194296600, "merchant_discount_amount": 6268958941836004000, "platform_discount_amount": 7869236438782821000, "provider_discount_amount": 8401418325734265000, "idle_time_info": { "WriteOffTimeLimit": { "WriteOffStartTime": 8599659459900454000, "WriteOffEndTime": 4565089057277846500, "DailyTimeRangeList": [ { "StartTime": "0inv7zHQ7T", "EndTime": "xcv8T3eNOT" } ], "RelativeTime": { "RelativeTimeType": 1, "RelativeTime": 6403282101240331000 }, "WeekDayList": [ 1 ] }, "idle_time_limit_type": 1 } } ], "sub_order_id": "tZtegZUS24", "receipt_amount": 2909612489254177300, "sub_order_type": 7000183033790565000 } ], "room_id": "zbAFnFIctT", "amount_info": { "sale_price": 834227064386329000, "deduct_info_list": [ { "order_source": 1, "source_platform_discount_amount": 8021267155044487000, "source_provider_discount_amount": 4644773112749340000, "source_origin_amount": 7204316989718650000, "source_selling_price": 8289554776474477000, "source_pay_amount": 1422901955281816600, "source_certificate_id": "mK2hGf4zCo", "source_sku_id": 8184222416192762000, "source_product_name": "ZJS6l9o6XK", "source_product_id": 1965388863484624000, "groupon_type": 1, "source_payment_discount_amount": 8213577156927899000, "voucher_type": 1, "source_merchant_discount_amount": 1338405821776828000, "source_brand_discount_amount": 743989048459443700, "source_order_id": "Bt3gCcR98o", "source_sku_name": "KnCqdO79hW" } ], "platform_deliver_freight_fee": 5557521481918660000, "provider_discount_amount": 3178726364437629400, "brand_discount_amount": 1410967873411683000, "merchant_deliver_freight_fee": 7898282151015009000, "estimated_order_income": 4325784541001494000, "merchant_discount_amount": 5580852492662410000, "deduct_amount": 6930417043922863000, "product_origin_amount": 6497260802278488000, "platform_discount_amount": 5988762977730919000, "origin_amount": 7752055458040633000, "pay_discount_amount": 290284191711184450, "activities_fee_amount": 6577100987583163000, "commission_amount": 3208329758926860000, "freight_pay_amount": 3179746071174790000, "pay_amount": 4921202424928567000 }, "source_order_id": "dXPEwPrKT7", "pay_amount": 1706857421458779100, "buyer_info": { "buyer_phone": "hcbZEzCwsY", "buyer_secret_number": "2H5Cptcehf", "buyer_real_phone": "EDeEnherX3" }, "open_id": "JBluTE34BL", "reservation_gift": { "reserved_gift_quantity": "V4uFBunu3R", "reserved_gift_content": "isKrhq6CjT", "has_reserved_gift": false }, "order_status": 294817143420377100, "third_sku_id": "QPLKZhvGrA", "original_amount": 3413229613590894000, "receiver_info": { "receiver_real_phone": "P1eF05IBCH", "receiver_name": "QejXlgZW6O", "district": "VCYJJT1Bez", "location_address": "heabnjCAhu", "door_plate_num": "PFL8ZjziRM", "receiver_phone": "Y7HUr580O0", "secret_number": "4E1RjBrsrF", "town": "ipCm88PDnS", "lng": 0.8235910148160237, "location_name": "INlNaLoeQW", "lat": 0.3155415791236218, "province": "o26ujK6Gel", "city": "APb3CNaa0z" }, "anchor_id": 1984486235770166000, "poi_id": "RsUC9ZpuWD", "update_order_time": 1497266848358174700, "payment_discount": 2957275269754363000, "count": 2941392923466332700, "contacts": [ { "phone_encrypt": "AjR9fhg0PO", "name": "XhsiWUKMED", "phone": "thyDTCMQRf" } ], "receipt_amount": 7835648280293931000, "craftsman_uid": "SidbT4Emdw", "order_id": "Qx5U0IrP8L", "sku_id": "GQCSEkRYRL", "order_type": 5223913127192797000, "intention_poi_id": "tifXcJZfTJ", "is_deliver_later": false } ], "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 | 已履约 | 该商品完成履约 | 系统 |
