订单查询
通过接口查询指定范围的订单列表及订单详情:
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
创单起始时间 (秒时间戳,创单起止时间必须同时传入)
cursorList
根据游标滚动请求,直到返回结果数量小于请求的size或未返回search_after结束;首页传"0",之后传返回参数中的CursorValue string数组拼接的string,如CursorValue返回参数["0","1"],则传"0,1";如果传入此参数,会优先使用cursor翻页,而不是page翻页
展开子属性
ext_order_idString
开发者系统中的订单号
get_secret_numberBool
是否需要查询配送信息
open_idString
抖音用户id
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_start_time=4996451650835589307&get_secret_number=false&page_num=3816837112904424937&order_id=WNpcc7tzdu&update_order_end_time=7556252557970667668&order_status=8778678853604001637&ext_order_id=jbjTdJVDdz&open_id=RcrbIS0oRY&page_size=2659496928173162342&account_id=KJ3QRgK88k&update_order_start_time=6418301624394609920&cursor=[qWrAms7Z2o]&create_order_end_time=2577886148022871834' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \
响应参数
Body展开全部子属性
extra必填Struct
扩展信息
展开子属性
dataStruct
数据列表
展开子属性
响应示例
正常响应示例异常响应示例
{ "data": { "orders": [ { "payment_discount": 7198277068872794000, "certificate": [ { "refund_amount": 7544699310601122000, "refund_time": 2546709305698195000, "combination_id": "LcrlThI98j", "order_item_id": "vVjntWfZ6j", "certificate_id": "OPUU2OhUiG", "item_status": 4062357228228032000, "item_update_time": 263068747607787700 } ], "intention_poi_id": "FCJq7ANvmF", "amount_info": { "estimated_order_income": 6991346119898380000, "pay_discount_amount": 5935054461191006000, "freight_pay_amount": 8934766677582568000, "activities_fee_amount": 3849153842384292000, "brand_discount_amount": 6597310479270825000, "provider_discount_amount": 7394817127735965000, "merchant_discount_amount": 433229257408382340, "sale_price": 3433581501099492400, "platform_deliver_freight_fee": 4551025930767429000, "commission_amount": 1486136421623191000, "platform_discount_amount": 6954485278808518000, "origin_amount": 4216338061950377500, "pay_amount": 3874309008022751700, "product_origin_amount": 2259115745863048700, "merchant_deliver_freight_fee": 9113313561629060000 }, "sku_id": "qz03yGQsCC", "open_id": "UUR1hyE3ML", "update_order_time": 8799016894143563000, "products": [ { "num": 3073828604447984000, "origin_amount": 7721161127568911000, "product_id": "vDpYvnCPWr", "snapshot_product": { "tag_info_list": [ { "TagValue": "r5kOoXg21x", "TagKey": "U8a9Ey0P5o", "TagName": "T60Mah8yT9" } ], "product_attr": { "dynamic_par_rule": { "dynamic_par_min_amount": 526474742151278700, "dynamic_par_max_amount": 3050518360973814300, "dynamic_par_rule_item_list": [ { "deductible_amount": 4269120993748129300, "day_of_week": [ 1 ], "time_period": { "use_end_time": "CZXndnISN9", "end_time_is_next_day": false, "use_start_time": "znqHUh29ny" } } ], "dynamic_par_rule_desc": "OHNZbLhwlH" }, "show_channel": 1, "voucher_par_type": 1 } }, "commodities": [ { "option_count": 4454572878491119000, "items": [ { "desc": "wQvA6cmcZa", "item_tag": "LzSduAKHa5", "attr_list": [ "8F5upZMsVW" ], "sku_attr_list": [ { "attr_name": "labMWcOFUk", "num": 1608110505540441000 } ], "name": "gQ6Dw7PqfJ", "price": 8613065704015085000, "count": 8349019490672300000, "unit": "rURxGS5QfE" } ], "group_name": "fsPoup9mt7", "total_count": 823243080120895900 } ], "sku_id": "CBhAdwr5du", "product_origin_amount": 5880793762328582000, "product_name": "iXMjXwqvN3", "ext_product_id": "NKMgqQOXZh" } ], "create_order_time": 872512988572155600, "room_id": "cyY6mXKXGD", "discount_amount": 9094525413836156000, "merchant_info": { "account_id": "y5UrXJRIMg", "account_name": "fOeVzVxcVh" }, "discounts": [ { "idle_time_info": { "WriteOffTimeLimit": { "DailyTimeRangeList": [ { "StartTime": "VWp7jzyRTa", "EndTime": "qS8VhIP5Pn" } ], "RelativeTime": { "RelativeTimeType": 1, "RelativeTime": 1197981671162756900 }, "WeekDayList": [ 1 ], "WriteOffStartTime": 861264663563055900, "WriteOffEndTime": 399952185236644030 }, "idle_time_limit_type": 1 }, "brand_discount_amount": 2744670229205985300, "discount_type": 5139001161051722000, "discount_amount": 4066324150174868500, "merchant_discount_amount": 195509407896124670, "platform_discount_amount": 3796690893897711600, "provider_discount_amount": 2290552449928392700 } ], "is_deliver_later": false, "poi": { "poi_id": "hLCsXRPWdZ", "poi_name": "6DNYaH9Aed", "url": "oPCc0FV3AS" }, "anchor_id": 8447110458000281000, "receiver_info": { "receiver_real_phone": "SqcWw2qOTG", "lng": 0.9653436908440963, "district": "ktgN2Ba8HL", "town": "aNPyX3PWLh", "receiver_phone": "us8C1h4vuG", "province": "ymYemdJOyO", "city": "NHMbxEum9W", "location_name": "1c6cgZ02gA", "lat": 0.7158993884731851, "location_address": "SXOh6SOPLt", "receiver_name": "HVJ1dht97q", "door_plate_num": "kKRFZV4jnR", "secret_number": "f1Gj2eBhuV" }, "buyer_info": { "buyer_real_phone": "OBWdQnEnAw", "buyer_phone": "3HOZ774ZgR", "buyer_secret_number": "v0LrQWQBio" }, "pay_time": 7280820818476934000, "order_id": "mQmxYSlU1H", "user_id": 1788203420284589300, "third_sku_id": "I4LkQIRS9o", "contacts": [ { "name": "5N6SPLJssQ", "phone": "GiC6Bp0CC8", "phone_encrypt": "3awfaXgrYT" } ], "count": 1906015527458622200, "order_type": 7354265623590109000, "pay_amount": 7449861034011129000, "sku_name": "v9eeMOe1NA", "receipt_amount": 1826460433351481900, "sub_order_amount_infos": [ { "combination_id": "P7GNAXIOzL", "sub_order_type": 8458645655459838000, "sub_order_id": "6pOX9go0pd", "pay_amount": 3313520445863778000, "origin_amount": 5263237582202539000, "discount_amount": 1175161075678026200, "discounts": [ { "idle_time_info": { "WriteOffTimeLimit": { "WeekDayList": [ 1 ], "WriteOffStartTime": 3111496286248548000, "WriteOffEndTime": 511227048372920060, "DailyTimeRangeList": [ { "StartTime": "OIZ2bFori6", "EndTime": "PsraLY2mGD" } ], "RelativeTime": { "RelativeTimeType": 1, "RelativeTime": 5593376524402131000 } }, "idle_time_limit_type": 1 }, "brand_discount_amount": 7388512371202978000, "discount_type": 4176090662509710000, "discount_amount": 2728783203371285500, "merchant_discount_amount": 3887242357235421000, "platform_discount_amount": 471947112285489700, "provider_discount_amount": 6195350513642793000 } ], "receipt_amount": 2607486640507719700 } ], "order_status": 5032208610455307000, "original_amount": 6088457652735688000, "poi_id": "zKtDAugsrl", "delivery_info": { "table_ware": "hLVa6DdrP3", "deliver_model": 7779862611375297000, "shop_number": "5Ycpe2x6u9", "is_book": false, "user_expect_time": "kqcTy0zok9", "sys_expect_time": "eGnEDO1dnf", "remark": "faK9saRXaX" } } ], "page": { "page_num": 6764409043429498000, "page_size": 9031414214042376000, "total": 5395387450989852000 }, "search_after": { "CursorValue": [ "dQQhl9P7wC" ], "AllCursorValue": [ [ "EF27zlihzh" ] ], "Size": 2694816955040001000 }, "error_code": 0, "description": "" }, "extra": { "error_code": 0, "description": "", "sub_error_code": 0, "sub_description": "", "logid": "20250208163425D36461A2664DCE4EACEE", "now": 1739003665 } }
错误码
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 | 已履约 | 该商品完成履约 | 系统 |