订单查询
通过接口查询指定范围的订单列表及订单详情:
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
(page_num×page_size 不得超过 10000,超过一万使用 Cursor 参数查询)
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
订单状态
(0=初始化、100=待支付、101=支付取消、200=已支付、201=待使用、1=已完成、150=部分支付)
update_order_end_timeInt64
修改结束时间(秒时间戳,修改起止时间必须同时传入)
update_order_start_timeInt64
修改起始时间 (秒时间戳,修改起止时间必须同时传入)
请求示例
curl --location --request GET 'https://open.douyin.com/goodlife/v1/trade/order/query/?get_secret_number=false&cursor=[0OvqLUV2SA]&account_id=vfPhSh1xJ4&order_id=q4JNjcABLi&create_order_end_time=1137546788858444460&page_num=1106237796929787570&open_id=fS8SA2CqMQ&create_order_start_time=7364669164601456398&order_status=2764989303192481307&update_order_start_time=4535184137004079739&update_order_end_time=3051697080543511645&page_size=4465966140782205118&ext_order_id=9qnHe8dhvI' \ --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": "20260901193940A2000B32F6E0567FB478", "now": 1788262784 }, "data": { "search_after": { "CursorValue": [ "2R6WHWNvDw" ], "AllCursorValue": [ [ "ulX9zOQv0D" ] ], "Size": 5866435591241761000 }, "orders": [ { "poi_id": "NoZQSaO9Ar", "pay_time": 8522987852008819000, "pay_bill_info": { "order_source": 1, "total_pay_amount": 4091314568784370000, "is_timely_pay_bill": false }, "certificate": [ { "refund_amount": 8630861409160426000, "item_update_time": 4951163483224218000, "refund_time": 2879318421341451300, "certificate_id": "I85lykpBaf", "combination_id": "4kwMAW86mL", "order_item_id": "3TYLRlkeEa", "fulfil_mode": 1, "item_status": 5318972742329004000 } ], "sku_name": "COj3SZM0pS", "update_order_time": 7202306054554537000, "products": [ { "product_id": "YNv48pkPbn", "product_origin_amount": 3667986676465097000, "num": 3986385627559973400, "snapshot_product": { "product_attr": { "combo_package_verify_limit_struct": { "type": 1, "product_id_index": { "4531926114628044091": 3682967761243907000 } }, "voucher_par_type": 1, "dynamic_par_rule": { "dynamic_par_min_amount": 4842129852669536000, "dynamic_par_max_amount": 5980606864283187000, "dynamic_par_rule_item_list": [ { "deductible_amount": 4355105509149013500, "day_of_week": [ 1 ], "time_period": { "use_start_time": "1GIZGobe7l", "use_end_time": "60B4jfSpAP", "end_time_is_next_day": false } } ], "dynamic_par_rule_desc": "iAhil3lY5d" }, "show_channel": 1, "advance_purchase_struct": { "purchase_type": 1, "time_detail": [ { "time": 3564151513297603000, "time_type": 1 } ] } }, "tag_info_list": [ { "TagKey": "J6PDTbZW4s", "TagName": "U8kVqMwRB5", "TagValue": "hdLo4OKX9e" } ] }, "product_name": "XEJwFr3Cgb", "commodities": [ { "group_name": "mX0gLs24Wn", "total_count": 4615829466719469000, "option_count": 4627170879451196000, "items": [ { "price": 7245509434242213000, "attr_list": [ "9MUNc3ITwt" ], "sku_attr_list": [ { "num": 2983754275440963000, "attr_name": "VF3WHigrWx" } ], "item_tag": "u1SDwbHIaG", "name": "df9rHPMR8Z", "unit": "PLVwTgbgPu", "count": 8504925390411613000, "desc": "xXOdC7oRFO" } ] } ], "origin_amount": 3964417754395131400, "ext_product_id": "LREHAzUk7a", "sku_sale_specs": [ { "spec_value": "IeKz3DL8n2", "spec_name": "gFaNbLjoV8" } ], "sku_id": "GN6PGBhM33", "third_sku_id": "H8HoNOjXN7" } ], "open_id": "zHnQ0D8mhn", "source_order_id": "U6GYzE9amW", "buyer_reserve_info": [ { "credential_type": 4591446808825174000, "enc_credential_numb": "a9HX24bzY2", "enc_name": "0beiinS104" } ], "discounts": [ { "discount_amount": 6161032348127026000, "merchant_discount_amount": 7049945170447323000, "platform_discount_amount": 3814595391492209700, "provider_discount_amount": 3969331906469948400, "idle_time_info": { "WriteOffTimeLimit": { "WriteOffEndTime": 2295050181185436000, "DailyTimeRangeList": [ { "StartTime": "wYWuzpIbsm", "EndTime": "dBhadbhrHH" } ], "RelativeTime": { "RelativeTimeType": 1, "RelativeTime": 8982991328491697000 }, "WeekDayList": [ 1 ], "WriteOffStartTime": 96398397499285020 }, "idle_time_limit_type": 1 }, "brand_discount_amount": 6115115646684887000, "discount_type": 3772133826425078300 } ], "original_amount": 1463245011221224000, "receiver_info": { "province": "0561wNAKcF", "receiver_name": "ia8OyFXurs", "city": "euHDajadJN", "district": "8I6M29inci", "location_name": "ztyDEmzd6Y", "lat": 0.7412307213139534, "location_address": "oz2dQIjxDr", "town": "4uTffKzm75", "lng": 0.3953381244798439, "receiver_real_phone": "GdLnWbtN7m", "secret_number": "DuJFg0eG8h", "receiver_phone": "iDHbrYxNfS", "door_plate_num": "9hSL7N763M" }, "anchor_id": 4036498626306694700, "discount_amount": 4568839120906114000, "order_id": "8WCqzEDkpL", "merchant_info": { "account_id": "8cnFv9U8o1", "account_name": "7WQly3JTHT" }, "order_status": 8079978269430417000, "contacts": [ { "name": "GWZZ9wSlk2", "phone": "LPWB6svKcX", "phone_encrypt": "sReZX5QH9Z" } ], "room_id": "hxclvu344R", "create_order_time": 7923166281752735000, "sub_order_amount_infos": [ { "discounts": [ { "discount_amount": 3429082388821445000, "merchant_discount_amount": 2249045311979696600, "platform_discount_amount": 1411398972060330500, "provider_discount_amount": 7583388579976073000, "idle_time_info": { "idle_time_limit_type": 1, "WriteOffTimeLimit": { "WeekDayList": [ 1 ], "WriteOffStartTime": 2115401601239333000, "WriteOffEndTime": 104921815810962820, "DailyTimeRangeList": [ { "StartTime": "zoA3QsfO7V", "EndTime": "aOtMoO321p" } ], "RelativeTime": { "RelativeTimeType": 1, "RelativeTime": 538797011324142000 } } }, "brand_discount_amount": 6689452772187519000, "discount_type": 8948730607398054000 } ], "discount_amount": 2102639622776629800, "sub_order_type": 3990843523214904300, "sub_order_id": "mNO9Dnj7Oy", "combination_id": "rsIDUjAnjq", "origin_amount": 3602091366974731000, "receipt_amount": 4081035336556532000, "pay_amount": 16351576522323560 } ], "order_sale_info": { "order_source": 1, "sale_role": "WA2LYbPCZA", "sale_channel": "NGZPfPULFs", "transfer_nickName": "Bt1QVzUNwK", "transfer_uid": "n4HkvacYXd", "transfer_douyin_uid": "aXjSwM6bSd" }, "poi": { "poi_name": "uHTvaV5heq", "url": "t7HVPOe8HP", "poi_id": "jeEcMVfd8k" }, "count": 1019708357426894300, "craftsman_uid": "Raw83kejlk", "payment_discount": 378277767064709060, "third_sku_id": "Dk2VkFo759", "is_deliver_later": false, "delivery_info": { "user_expect_time": "YUYptKJE7b", "sys_expect_time": "bMByE7NXOa", "remark": "bv4ZEC8ZPJ", "table_ware": "VOoL1LmncQ", "deliver_model": 2954910047103728600, "shop_number": "4fMvAQ8M9t", "is_book": false }, "amount_info": { "pay_amount": 7475796624181055000, "deduct_amount": 3879165549604013000, "activities_fee_amount": 496857610231237800, "provider_discount_amount": 3805176867802534400, "estimated_order_income": 8049470725812873000, "freight_pay_amount": 5089739067201612000, "merchant_deliver_freight_fee": 7920161041660740000, "brand_discount_amount": 4458152250733222000, "product_origin_amount": 2555054213883983000, "origin_amount": 749260614428116000, "merchant_discount_amount": 3170724545003856400, "pay_discount_amount": 8348607257969005000, "platform_discount_amount": 2181603641139575600, "sale_price": 7859786342962877000, "deduct_info_list": [ { "source_payment_discount_amount": 2684557403568142300, "source_brand_discount_amount": 1934513526520225300, "source_certificate_id": "xej3BnxGr7", "voucher_type": 1, "groupon_type": 1, "source_order_id": "hUfdlu5ycK", "source_product_name": "AvOIZXllQk", "source_sku_id": 7157643741502588000, "source_merchant_discount_amount": 851477033029423900, "source_platform_discount_amount": 40439599051918344, "source_origin_amount": 7565448477144863000, "source_selling_price": 7631174984811675000, "order_source": 1, "source_pay_amount": 6709869372719134000, "source_sku_name": "nuEMDr6nH3", "source_product_id": 8040510494261151000, "source_provider_discount_amount": 4335822629640683000 } ], "commission_amount": 1382359555568815900, "platform_deliver_freight_fee": 3651488777058953000 }, "buyer_info": { "buyer_phone": "4imdTuIC3m", "buyer_secret_number": "PByu0IxKSB", "buyer_real_phone": "mmIE6YR09j" }, "sku_id": "TPcbt2gKz0", "user_id": 6913176135142318000, "order_type": 6418088186360579000, "receipt_amount": 6326312057753339000, "pay_amount": 4108804629177345500, "intention_poi_id": "TYyNY4XiVz", "reservation_gift": { "has_reserved_gift": false, "reserved_gift_quantity": "Uq83AEsxY3", "reserved_gift_content": "umdFGapf1q" } } ], "page": { "page_size": 3453084309462647000, "total": 7361102277951456000, "page_num": 3083643762708176000 }, "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 | 已履约 | 该商品完成履约 | 系统 |
