订单查询
通过接口查询指定范围的订单列表及订单详情:
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/?order_id=wkUNJaeJ0Y&create_order_end_time=1095557867974606068&order_status=8937665584161041164&create_order_start_time=9171262930615859463&cursor=[E7VW4bA3c7]&ext_order_id=68UY4bjryF&update_order_end_time=7734017721704374812&page_num=3310269698050152386&page_size=4172347116147079883&account_id=lmUGvUFChv&update_order_start_time=908677001407367423&open_id=iMKHsv3dLt&get_secret_number=false' \ --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": "2025101515555849669AAA5C01DCA7C0AE", "now": 1760514958 }, "data": { "orders": [ { "create_order_time": 7232940854893751000, "sub_order_amount_infos": [ { "origin_amount": 7463111500764682000, "discount_amount": 9005953065312638000, "discounts": [ { "merchant_discount_amount": 4667212883572247000, "platform_discount_amount": 8100811962848582000, "provider_discount_amount": 1058457484691217200, "idle_time_info": { "idle_time_limit_type": 1, "WriteOffTimeLimit": { "WeekDayList": [ 1 ], "WriteOffStartTime": 2695575918285732000, "WriteOffEndTime": 3690871755921854000, "DailyTimeRangeList": [ { "StartTime": "NOq3zEoeFa", "EndTime": "lfxaGDvfJb" } ], "RelativeTime": { "RelativeTime": 8357041122791288000, "RelativeTimeType": 1 } } }, "brand_discount_amount": 4600360489266783000, "discount_type": 1109725268525572900, "discount_amount": 7887785543112734000 } ], "receipt_amount": 7263834604384099000, "combination_id": "12U6I7P6Um", "sub_order_type": 5828083083214256000, "sub_order_id": "93UsTQmNMc", "pay_amount": 6336665913276393000 } ], "pay_amount": 3646196735822933500, "count": 988019160674447400, "receiver_info": { "lat": 0.6220951997016828, "door_plate_num": "5uQ9y3pf4g", "receiver_name": "3NwSH4eUQi", "province": "YEesY6LIGr", "receiver_real_phone": "HU4TwFp9PS", "district": "4mtsH8Cr5O", "location_name": "sbxhVoJsZr", "lng": 0.4136577133439795, "town": "JJ13WTXraW", "receiver_phone": "ZDjX8fg7yA", "location_address": "xAbXnjKGpX", "secret_number": "vLeVqR28pr", "city": "XBj3rLb5SS" }, "room_id": "Awx8NcvAEs", "delivery_info": { "remark": "DtZN3rL46E", "table_ware": "EwkrV6srW2", "deliver_model": 3666740855747320000, "shop_number": "33TbhNkJU6", "is_book": false, "user_expect_time": "NFcNxDbu8a", "sys_expect_time": "jEVKdyWhkQ" }, "original_amount": 5885352677450020000, "buyer_info": { "buyer_real_phone": "mQFVK15XYe", "buyer_phone": "ukzsNaIjaT", "buyer_secret_number": "sAnh15TVcI" }, "poi": { "poi_name": "QQ2KWoR0im", "url": "PWIzQIamxO", "poi_id": "2YdQE6rYBQ" }, "products": [ { "product_id": "HcFqKjUrSv", "num": 6183173913459755000, "product_origin_amount": 883974294919154000, "product_name": "rVbPP8km5W", "ext_product_id": "fWRIjgmE8d", "sku_id": "wzRghNEBBw", "commodities": [ { "total_count": 4962006004265880000, "option_count": 1624338820908728800, "items": [ { "desc": "8t92MuXNHc", "item_tag": "kMXETJvS1O", "attr_list": [ "2XyvwAKQOl" ], "sku_attr_list": [ { "attr_name": "EVvuZs8Jg1", "num": 6278334186236559000 } ], "name": "MbUQY7j47Y", "price": 3461266296663107600, "count": 1772891389891575300, "unit": "CjtDgdelzo" } ], "group_name": "sy7r8ZZ4YH" } ], "origin_amount": 2141733929103619000, "snapshot_product": { "product_attr": { "voucher_par_type": 1, "dynamic_par_rule": { "dynamic_par_rule_item_list": [ { "day_of_week": [ 1 ], "time_period": { "end_time_is_next_day": false, "use_start_time": "1eaU3UCJ0P", "use_end_time": "WNfCCLohN7" }, "deductible_amount": 7672235772754307000 } ], "dynamic_par_rule_desc": "SIP0nZsoPU", "dynamic_par_min_amount": 5388149081464816000, "dynamic_par_max_amount": 7699091578273636000 }, "show_channel": 1, "advance_purchase_struct": { "purchase_type": 1, "time_detail": [ { "time": 6555888695027279000, "time_type": 1 } ] }, "combo_package_verify_limit_struct": { "product_id_index": { "668613209049438324": 1887904416140271900 }, "type": 1 } }, "tag_info_list": [ { "TagName": "2zLTaZJ2YS", "TagValue": "po1AfAWizr", "TagKey": "QAekUVHGxb" } ] } } ], "certificate": [ { "combination_id": "mypATbxeus", "fulfil_mode": 1, "order_item_id": "XbSthBBCTk", "certificate_id": "MbmXW8yHCU", "item_status": 8946098913045523000, "item_update_time": 3209600491449738000, "refund_amount": 5945310261659471000, "refund_time": 3026332867809811000 } ], "sku_name": "qIFvpiZIyY", "order_status": 7289419527081031000, "order_type": 2353884338427122000, "is_deliver_later": false, "craftsman_uid": "yPM3vsfWuZ", "contacts": [ { "name": "rNdeDgeNfZ", "phone": "phR3TCESVh", "phone_encrypt": "w0K52qfvbo" } ], "merchant_info": { "account_id": "cReXhAVTpa", "account_name": "hpHdc9J01R" }, "amount_info": { "estimated_order_income": 3872154518146375000, "product_origin_amount": 3492810627251390500, "provider_discount_amount": 4861528463361737000, "pay_amount": 3978396787532434000, "origin_amount": 3681764569768619500, "brand_discount_amount": 6482104199370644000, "platform_deliver_freight_fee": 412576616861833900, "merchant_deliver_freight_fee": 5108163566308973000, "sale_price": 7815445699477985000, "freight_pay_amount": 3507213042598759000, "deduct_info_list": [ { "groupon_type": 1, "source_origin_amount": 3391761951919658000, "source_product_id": 3026646972684983300, "voucher_type": 1, "source_sku_name": "XMOpq9925A", "source_order_id": "RP1lBpQnAn", "source_merchant_discount_amount": 4373977388086957000, "source_certificate_id": "7fsFOFckBv", "source_sku_id": 251419901057299700, "source_product_name": "owyJwW5Ekg", "source_pay_amount": 8233765431662112000 } ], "merchant_discount_amount": 2974087320099197400, "pay_discount_amount": 1091100931565583100, "commission_amount": 2279889694237848000, "platform_discount_amount": 820681563013784800, "deduct_amount": 6645616045894952000, "activities_fee_amount": 5819135321847223000 }, "discounts": [ { "merchant_discount_amount": 2989898439295806500, "platform_discount_amount": 6968197810974929000, "provider_discount_amount": 5145066184380114000, "idle_time_info": { "WriteOffTimeLimit": { "DailyTimeRangeList": [ { "StartTime": "xSgZ3wRYdx", "EndTime": "tmlv4Hqqz1" } ], "RelativeTime": { "RelativeTimeType": 1, "RelativeTime": 8642668522102918000 }, "WeekDayList": [ 1 ], "WriteOffStartTime": 3301594823751818000, "WriteOffEndTime": 8207418652486265000 }, "idle_time_limit_type": 1 }, "brand_discount_amount": 3661513286550127600, "discount_type": 1337610350574080800, "discount_amount": 2731023831297182700 } ], "update_order_time": 2253874130315368000, "payment_discount": 6285478257304706000, "source_order_id": "3QdtT1VIhM", "anchor_id": 1984777222429226500, "discount_amount": 4007929541086404000, "pay_time": 5810775718517258000, "open_id": "XrRUGjlHyY", "user_id": 8155505152300245000, "receipt_amount": 1011585713006168200, "sku_id": "o2UbybGqe3", "intention_poi_id": "cwLqFjIDQB", "order_id": "RfM0B7Cbfx", "third_sku_id": "89LQHMpDUU", "poi_id": "dyOqzKbBg8" } ], "page": { "total": 8957682282831824000, "page_num": 2177573127826597000, "page_size": 5346581258640172000 }, "search_after": { "CursorValue": [ "LKvKLKOXh4" ], "AllCursorValue": [ [ "BlvKlKA1HV" ] ], "Size": 3539575335092756000 }, "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 | 5000001 | 服务器打瞌睡了,请稍后再试。 | |
| 200 | 3000001 | 以实际错误信息为准 |
附录
(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 | 已履约 | 该商品完成履约 | 系统 |
