订单查询
通过接口查询指定范围的订单列表及订单详情:
1、查询指定状态的订单列表,用于对账或差异单最新状态确认;
2、查询指定用户的订单列表,用于积分计算、订单展示;
3、查询指定订单详情,用于接口补偿处理。
开票说明
尊敬的商家,依据税务规则与《抖音生活服务平台商户合作协议》的约定,如用户向商家申请开具发票,商家应按照用户实际支付金额向用户开具相应金额的发票。用户的实际支付金额可参考订单查询pay amount字段展示的具体金额(用户实际支付金额,不含平台等其他方补贴的金额)。
针对平台补贴需向平台开具增值税发票,请勿开具给用户。若商家向用户超额开具发票,由此导致的损失及税务风险需由商家自行承担
接口 SLA
指标 | 数值 |
可承载最大qps | 500 |
响应耗时pct99 | 1s |
服务目标可用性 | 99.9% |
接口说明
- 服务商通过接口查询订单详情,支持三种查询方式:
- 根据订单 ID 或第三方订单号,查询对应订单详情,入参:订单 ID/第三方订单号、商户 id;
- 根据订单状态和商户 id,查询指定时间内该商户下的订单列表,入参:商户 id、订单状态、创单起止时间/修改起止时间;
- 根据用户 id 和商户 id,查询某用户在该商户下的所有订单,入参:商户 id、用户 id、创单起止时间/修改起止时间;
- 支付后未发码/发码失败订单查询方式:限定订单状态为“已支付”,如用户下单后超过 10 分钟未发码会发起退款;
- 退款申请待审核订单查询方式:限定券状态为“退款中”,如退款状态未响应超过 72 小时会自动退款。
基本信息
名称 | 描述 |
---|---|
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/?create_order_end_time=6428917102147190881&page_num=5546916480029150731&order_id=1hwMrueIyn&open_id=iW8OJ2xsto&account_id=TvLoDHQcLC&cursor=[4XF9zig9TE]&get_secret_number=false&page_size=8072214299171231072&ext_order_id=9z9MS5RP26&create_order_start_time=1748004751931739609&order_status=1242099232986977884&update_order_start_time=6761501696214913942&update_order_end_time=4262552206247697417' \ --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": "20250805110825D29BA5CB7CD1D6DFDB2C", "now": 1754363313 }, "data": { "orders": [ { "order_type": 846323678350565400, "merchant_info": { "account_id": "ZXDVHKxv0i", "account_name": "y4J14zKOpW" }, "count": 3749491195328965600, "sub_order_amount_infos": [ { "sub_order_id": "5oKNNwtqD2", "pay_amount": 4171781983507540500, "origin_amount": 5856064016916839000, "discount_amount": 2050484166705575200, "discounts": [ { "provider_discount_amount": 5620877696129737000, "idle_time_info": { "idle_time_limit_type": 1, "WriteOffTimeLimit": { "WriteOffEndTime": 2817248192844083700, "DailyTimeRangeList": [ { "EndTime": "7skWXAFWmr", "StartTime": "EfnJNfkqwb" } ], "RelativeTime": { "RelativeTimeType": 1, "RelativeTime": 5283522372463796000 }, "WeekDayList": [ 1 ], "WriteOffStartTime": 2043084521942293500 } }, "brand_discount_amount": 1776103610930141400, "discount_type": 5097275505036709000, "discount_amount": 9174547236289117000, "merchant_discount_amount": 8811453638975865000, "platform_discount_amount": 8524768015983610000 } ], "receipt_amount": 3514640600265743000, "combination_id": "yHFKLNHAuS", "sub_order_type": 4752965775077636000 } ], "poi": { "poi_id": "GBCenb6fc6", "poi_name": "vIxx8gHlgd", "url": "wUQbzbcbuK" }, "user_id": 3327689317743627000, "order_status": 4817057200005288000, "receiver_info": { "town": "bFQFrNzqbV", "location_address": "oBwHW2uQ1f", "door_plate_num": "sHWnuAeLNv", "receiver_name": "h2XE9o6a7s", "lat": 0.38990584238440795, "location_name": "f3hJvbxp3i", "city": "QwPEYkhmKI", "lng": 0.4913094697569747, "province": "JUIimLz1S9", "receiver_phone": "OwPM0hu2ck", "secret_number": "2OHfFZdA6U", "district": "88pg0KBOVN", "receiver_real_phone": "eI34a8qQiH" }, "certificate": [ { "refund_time": 3044490662595785000, "combination_id": "e4ZhKwjRpv", "order_item_id": "NTMFtUT0Pb", "certificate_id": "UGQ9xwTmgR", "item_status": 8570948413342747000, "item_update_time": 4680684668104814000, "refund_amount": 176117069313371230 } ], "discounts": [ { "discount_type": 2451642790109378000, "discount_amount": 4687846782100089000, "merchant_discount_amount": 1051453514837212400, "platform_discount_amount": 7240510429788042000, "provider_discount_amount": 7741027959662747000, "idle_time_info": { "WriteOffTimeLimit": { "DailyTimeRangeList": [ { "StartTime": "N1BXxZz8Gm", "EndTime": "qCAsDiZStH" } ], "RelativeTime": { "RelativeTimeType": 1, "RelativeTime": 5476025143122527000 }, "WeekDayList": [ 1 ], "WriteOffStartTime": 8904597984923827000, "WriteOffEndTime": 8667096695562443000 }, "idle_time_limit_type": 1 }, "brand_discount_amount": 8269658062746760000 } ], "room_id": "fcQ2sb2RxJ", "order_id": "3DbXBGn6KU", "payment_discount": 9118724448779801000, "poi_id": "scoH058HVm", "is_deliver_later": false, "products": [ { "product_id": "jhkpNSMMzx", "sku_id": "FrV38uHPSV", "num": 1622055507195380200, "ext_product_id": "Pw5AZa9ATI", "product_name": "qQyhA9wBEG", "product_origin_amount": 1466156784536847400, "origin_amount": 1985046374290100500, "commodities": [ { "group_name": "OAgMUkbwM4", "total_count": 3139460167253424000, "option_count": 2553762279587430000, "items": [ { "price": 3538675435353064400, "count": 7912530442231637000, "unit": "8YCQonhvDX", "desc": "9Y2OQFakMs", "item_tag": "sY48mogrDs", "attr_list": [ "j3uQWT7wlE" ], "sku_attr_list": [ { "attr_name": "eNSLyYOE4u", "num": 4381904172058857000 } ], "name": "NVkUsOGoOL" } ] } ], "snapshot_product": { "tag_info_list": [ { "TagKey": "qXvTK1bw0l", "TagName": "7qBFl6kL3x", "TagValue": "YteDMLBoKi" } ], "product_attr": { "voucher_par_type": 1, "dynamic_par_rule": { "dynamic_par_min_amount": 1210314089382192000, "dynamic_par_max_amount": 7860912733587287000, "dynamic_par_rule_item_list": [ { "day_of_week": [ 1 ], "time_period": { "end_time_is_next_day": false, "use_start_time": "4DaO0TM96C", "use_end_time": "lRNDitnEwh" }, "deductible_amount": 2601917773855264000 } ], "dynamic_par_rule_desc": "ST7MlDIGSv" }, "show_channel": 1, "advance_purchase_struct": { "purchase_type": 1, "time_detail": [ { "time": 8387140516854020000, "time_type": 1 } ] } } } } ], "contacts": [ { "name": "Dg4gTRUC8J", "phone": "PzF2UbXQSn", "phone_encrypt": "2W8dzG9cWy" } ], "discount_amount": 8143957251381131000, "pay_time": 6967868762248970000, "amount_info": { "commission_amount": 5707568528561959000, "sale_price": 1998781584134755800, "activities_fee_amount": 1274000163781366000, "product_origin_amount": 5184015844180900000, "provider_discount_amount": 7551951285982588000, "platform_deliver_freight_fee": 6535835640775219000, "estimated_order_income": 3346764831690844000, "merchant_discount_amount": 7010297692576841000, "brand_discount_amount": 7611881356619041000, "merchant_deliver_freight_fee": 3201299430945782300, "pay_discount_amount": 2345076520329936400, "pay_amount": 1169747976960755000, "freight_pay_amount": 3954898236287727000, "platform_discount_amount": 8639355833693264000, "origin_amount": 4637360789044560000 }, "open_id": "aTgJQIUVw9", "delivery_info": { "shop_number": "JjxZmqMfWR", "is_book": false, "user_expect_time": "4bkUa2B51Y", "sys_expect_time": "Ob82mkYfOb", "remark": "r8rqmd12cG", "table_ware": "khybKg4Uxw", "deliver_model": 4281529832827951000 }, "intention_poi_id": "QAOW2IMWBb", "anchor_id": 5654680811031320000, "pay_amount": 8110636163667319000, "sku_name": "wGeZNPbnuQ", "sku_id": "TeZbKOxNPr", "third_sku_id": "f61Qp9oBvq", "create_order_time": 3054535779133333000, "original_amount": 7858735614021976000, "craftsman_uid": "c0GB7zHEw7", "buyer_info": { "buyer_secret_number": "mwGTurUDsK", "buyer_real_phone": "rTSqBy6pi0", "buyer_phone": "aEQ8EKcjQz" }, "receipt_amount": 2904050533922795000, "source_order_id": "5Tfd9SsxYH", "update_order_time": 6782461761792152000 } ], "page": { "total": 5106106948868796000, "page_num": 729133201954738400, "page_size": 3415703968567083000 }, "search_after": { "Size": 2501500962496587000, "CursorValue": [ "UsbBN538wf" ], "AllCursorValue": [ [ "qqQaWAFkkJ" ] ] }, "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 | 已履约 | 该商品完成履约 | 系统 |