订单查询
通过接口查询指定范围的订单列表及订单详情:
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=Q7u7LoEazX&ext_order_id=eONbS0qFBm&update_order_end_time=2053988136815435629&get_secret_number=false&page_num=555339934211235529&update_order_start_time=2503352706778951650&order_status=5315038737476760229&create_order_start_time=7227017107950272029&cursor=[4u59TqhEsT]&open_id=GwcgZYh798&page_size=6387746632524160588&account_id=Kx10H1V21Q&create_order_end_time=62528488607547280' \ --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": "202601271437316BF1A9AEB4698EB594E2", "now": 1769495854 }, "data": { "search_after": { "Size": 204236290980641150, "CursorValue": [ "Ygm5XoWmKj" ], "AllCursorValue": [ [ "JmZuKtNHYN" ] ] }, "orders": [ { "third_sku_id": "XPuxIL7Aye", "open_id": "OsM9Pzl6kX", "sku_id": "OqC7jiILAw", "craftsman_uid": "PLrY2iIpMP", "source_order_id": "kF62d7VaOz", "user_id": 934833627252968700, "discount_amount": 5718610571134812000, "merchant_info": { "account_id": "Zqe79HCYYC", "account_name": "mUmriGSR6b" }, "payment_discount": 3271534072880540000, "certificate": [ { "combination_id": "ABLu3LEUzO", "refund_time": 6084803829331183000, "refund_amount": 8687549611121593000, "certificate_id": "R1Wi117MTN", "item_update_time": 8890070221114115000, "item_status": 7311913538860166000, "fulfil_mode": 1, "order_item_id": "Gwx44xlIr0" } ], "intention_poi_id": "tyIkfYO2t4", "pay_amount": 2901519582748508000, "poi_id": "O967SVOhUI", "poi": { "url": "zrp1VaGS3B", "poi_id": "15dauhLDpY", "poi_name": "O3ZZ8fvXSN" }, "order_id": "TDnJfgSPCt", "order_status": 6320221279262081000, "products": [ { "num": 4933236058095447000, "third_sku_id": "v2RnIzDjGI", "snapshot_product": { "product_attr": { "show_channel": 1, "advance_purchase_struct": { "purchase_type": 1, "time_detail": [ { "time": 3020340417300385300, "time_type": 1 } ] }, "combo_package_verify_limit_struct": { "type": 1, "product_id_index": { "1914865120898846193": 6206187708558756000 } }, "voucher_par_type": 1, "dynamic_par_rule": { "dynamic_par_rule_item_list": [ { "time_period": { "use_end_time": "2X6ucD9NhD", "end_time_is_next_day": false, "use_start_time": "AtBB4Ub2zX" }, "deductible_amount": 8335042536045639000, "day_of_week": [ 1 ] } ], "dynamic_par_rule_desc": "8VFeqGdCuu", "dynamic_par_min_amount": 3494507295835628500, "dynamic_par_max_amount": 7348502461021308000 } }, "tag_info_list": [ { "TagValue": "O4sywSmL9e", "TagKey": "pAKDzbkiSG", "TagName": "PQLR3EHBOl" } ] }, "product_name": "osXTt2G95Q", "product_origin_amount": 594667331107676000, "origin_amount": 5788636045935510000, "product_id": "auYRfPRYSW", "sku_id": "NdfWJV9yxm", "ext_product_id": "TlkO0DgpW9", "commodities": [ { "total_count": 3408391841453944000, "option_count": 8077213997908481000, "items": [ { "sku_attr_list": [ { "attr_name": "KzeaIZ5rnC", "num": 8732940739669280000 } ], "attr_list": [ "Ywm6G2v2BR" ], "desc": "i7KFqKcAz0", "unit": "Bh8Is4WfmN", "name": "nhYAPAuPyD", "count": 581964849669050400, "item_tag": "8yfabLKLpz", "price": 4807562044733211000 } ], "group_name": "AB6j0FAFN7" } ] } ], "buyer_info": { "buyer_secret_number": "EBCibVfsjF", "buyer_real_phone": "99Y2Awz1mN", "buyer_phone": "tEK6U87wnN" }, "receiver_info": { "location_name": "U83ARlHO9Z", "town": "8EJe6RbrOr", "door_plate_num": "IPPqI7OxUB", "location_address": "MrGxdSxni0", "lng": 0.23117383867567307, "secret_number": "xPmAbS14Ah", "receiver_phone": "g4r5cZvIjE", "receiver_real_phone": "foob0hQ472", "district": "WKtjkmv3QS", "province": "0E3VLtrddL", "lat": 0.7963709677177935, "receiver_name": "Vp61udy6yk", "city": "RC3nGdFQra" }, "sub_order_amount_infos": [ { "discount_amount": 1416399498203816000, "origin_amount": 865745394309548000, "sub_order_type": 1132218238888151000, "discounts": [ { "provider_discount_amount": 903452553054317300, "idle_time_info": { "WriteOffTimeLimit": { "RelativeTime": { "RelativeTime": 3577154687894711300, "RelativeTimeType": 1 }, "WeekDayList": [ 1 ], "WriteOffStartTime": 5261522427446695000, "WriteOffEndTime": 5796101398219469000, "DailyTimeRangeList": [ { "EndTime": "ttekf6zE9R", "StartTime": "cXUjIBVsOv" } ] }, "idle_time_limit_type": 1 }, "brand_discount_amount": 3540880785550072000, "discount_type": 3436675127912786000, "discount_amount": 2002898368350052000, "merchant_discount_amount": 8129584505197682000, "platform_discount_amount": 1038493391874430100 } ], "receipt_amount": 4644095102018269000, "pay_amount": 677939523110219900, "combination_id": "qPS7c9Ev7P", "sub_order_id": "RftZS363ad" } ], "anchor_id": 962685387627659000, "discounts": [ { "idle_time_info": { "WriteOffTimeLimit": { "WriteOffEndTime": 1536297667857692000, "DailyTimeRangeList": [ { "EndTime": "6IgCNJfabI", "StartTime": "kL5MC39tMP" } ], "RelativeTime": { "RelativeTimeType": 1, "RelativeTime": 5966220016828743000 }, "WeekDayList": [ 1 ], "WriteOffStartTime": 165723071295252600 }, "idle_time_limit_type": 1 }, "brand_discount_amount": 4496279980798052400, "discount_type": 1258312327104675300, "discount_amount": 2845285857601672000, "merchant_discount_amount": 3279010155517960700, "platform_discount_amount": 8147584535203917000, "provider_discount_amount": 3840677820748788000 } ], "room_id": "HSgYEeW5o4", "receipt_amount": 7242034506635409000, "order_type": 8951106910125687000, "create_order_time": 2479830214925167000, "original_amount": 5717393280634581000, "update_order_time": 2947255222213743000, "contacts": [ { "name": "ZsR8ZdZwb1", "phone": "zO0H70PNVn", "phone_encrypt": "bVEXtoci6N" } ], "amount_info": { "pay_discount_amount": 7144364645352021000, "merchant_deliver_freight_fee": 8637826730725776000, "estimated_order_income": 7282143659000961000, "freight_pay_amount": 4237337715342730000, "platform_discount_amount": 4353041704293281300, "product_origin_amount": 1101824126779580000, "commission_amount": 4483276047888456700, "deduct_amount": 1758965264424057900, "deduct_info_list": [ { "source_selling_price": 6941876888275504000, "source_pay_amount": 121751449246801440, "source_payment_discount_amount": 4717077728124313000, "source_certificate_id": "Zii2MBbdza", "source_sku_name": "5SsNFoi6gD", "source_origin_amount": 3274666734353892400, "source_product_id": 7274952600554357000, "voucher_type": 1, "source_product_name": "Y4IiMFp0Br", "source_order_id": "MFZfNW1hAy", "source_provider_discount_amount": 7745217829069466000, "source_platform_discount_amount": 8383828602743449000, "source_sku_id": 8853841848449300000, "groupon_type": 1, "source_merchant_discount_amount": 5579583257412093000, "source_brand_discount_amount": 5847261812109258000 } ], "brand_discount_amount": 4260821044601086500, "sale_price": 6192468545485918000, "provider_discount_amount": 3267679675818507000, "activities_fee_amount": 6308822431801321000, "origin_amount": 1475126661852283100, "platform_deliver_freight_fee": 6288854602188921000, "pay_amount": 1716346033303835400, "merchant_discount_amount": 8982035054253617000 }, "sku_name": "YrPvdI7qv1", "pay_time": 9131663340672971000, "is_deliver_later": false, "count": 1361353032953796600, "delivery_info": { "user_expect_time": "ZWP7L7g0hH", "sys_expect_time": "OCduTeRkfa", "remark": "CoFrzicCJl", "table_ware": "O6MgI9ezwd", "deliver_model": 984457732314890400, "shop_number": "vGVIvnWjkg", "is_book": false } } ], "page": { "page_num": 267148718017209280, "page_size": 6325484286899476000, "total": 5656198152394360000 }, "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 | 已履约 | 该商品完成履约 | 系统 |
