订单查询
通过接口查询指定范围的订单列表及订单详情:
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/?page_num=5006096769998429001&page_size=2670320876983582181&account_id=HFXlh6WkBl&order_id=Zg9FZhywjw&update_order_start_time=1043024675196940077&create_order_end_time=4970299142578401684&open_id=XlcCvue1Bw&update_order_end_time=2202257971185890071&ext_order_id=P7awaSUBFm&cursor=[63S9Rc3xKI]&order_status=7004721144252394970&get_secret_number=false&create_order_start_time=3668133900232528729' \ --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": "202505141433088E4A5B4C6C41F41CAF72", "now": 1747204396 }, "data": { "page": { "page_num": 1135756429346105900, "page_size": 500786284042466500, "total": 5910435349552218000 }, "search_after": { "Size": 662843331600141400, "CursorValue": [ "Coqz7VLluB" ], "AllCursorValue": [ [ "qTQJHBVnf4" ] ] }, "orders": [ { "sub_order_amount_infos": [ { "pay_amount": 6345605104018863000, "origin_amount": 4517920897753632300, "discount_amount": 185242084986785250, "discounts": [ { "brand_discount_amount": 6766684242264448000, "discount_type": 8840605000792340000, "discount_amount": 25310374688069570, "merchant_discount_amount": 1412646541600155000, "platform_discount_amount": 531665755937562750, "provider_discount_amount": 1118879465018023000, "idle_time_info": { "WriteOffTimeLimit": { "WeekDayList": [ 1 ], "WriteOffStartTime": 689721920026159600, "WriteOffEndTime": 2438251998658460700, "DailyTimeRangeList": [ { "StartTime": "t9Lk1zMQQp", "EndTime": "ArwAbHHYe1" } ], "RelativeTime": { "RelativeTime": 3955759853308333000, "RelativeTimeType": 1 } }, "idle_time_limit_type": 1 } } ], "receipt_amount": 6009500281037997000, "combination_id": "DoAHhEpjyy", "sub_order_type": 439635265771607550, "sub_order_id": "MKldw3373n" } ], "sku_id": "xMfyyy4ucB", "is_deliver_later": false, "user_id": 7320950920941436000, "poi": { "url": "hJu5G9Iktq", "poi_id": "SWLhRjzhpQ", "poi_name": "7qQ2M6lmKd" }, "order_id": "XoBRRuq9Yu", "update_order_time": 3174840387147930000, "amount_info": { "pay_amount": 6502730217546391000, "merchant_deliver_freight_fee": 2315846003329946000, "product_origin_amount": 6331640538266931000, "activities_fee_amount": 2804854918325762000, "brand_discount_amount": 6126007526929618000, "provider_discount_amount": 2608599846636104000, "estimated_order_income": 3063579866324333600, "platform_discount_amount": 3927031539681760000, "merchant_discount_amount": 5529298029785532000, "freight_pay_amount": 7767756239923713000, "pay_discount_amount": 7632217328726297000, "commission_amount": 2664366369440477700, "sale_price": 2024879413818225400, "platform_deliver_freight_fee": 3657932544175313400, "origin_amount": 6403924981243078000 }, "receiver_info": { "door_plate_num": "E5KdtjoUOJ", "receiver_real_phone": "XVyrkFtOZl", "district": "iTEUF91Rog", "lng": 0.7531137305549824, "location_name": "quJWlvlV5u", "city": "pUhJ4IFO5G", "receiver_phone": "EbRPJoeJvb", "location_address": "Fw40lDPZGr", "secret_number": "xmHswM6M63", "lat": 0.006909452952158007, "receiver_name": "CbTYT3eVav", "province": "orVfFgUShg", "town": "se8DsWCuAe" }, "poi_id": "TiRaRzFqaP", "anchor_id": 4751521251585394000, "craftsman_uid": "7zYSDWuaOW", "count": 1354172931145578800, "buyer_info": { "buyer_secret_number": "twncP2Io3p", "buyer_real_phone": "jLa7ZT3LYT", "buyer_phone": "bEOQrkJM0m" }, "certificate": [ { "combination_id": "e50R8fPCiV", "order_item_id": "IV1GMlmwvL", "certificate_id": "xMH2wK0Y2N", "item_status": 4629307154401808000, "item_update_time": 6458695795948312000, "refund_amount": 4148303916984973000, "refund_time": 3524310710814442000 } ], "intention_poi_id": "r02PLsKaJc", "pay_time": 8215283173621386000, "payment_discount": 7882837258463240000, "delivery_info": { "is_book": false, "user_expect_time": "EtrsmbgF5v", "sys_expect_time": "KPozysDEHe", "remark": "JGA2tHO4x0", "table_ware": "laWsMIzf94", "deliver_model": 1624431505644698000, "shop_number": "J5AJikIZcY" }, "pay_amount": 544909833720438900, "room_id": "iZtgYbWEW9", "original_amount": 4156045313530602500, "discount_amount": 5978507465707990000, "products": [ { "product_name": "xElB15Y902", "origin_amount": 3111604644931962000, "snapshot_product": { "product_attr": { "dynamic_par_rule": { "dynamic_par_rule_item_list": [ { "time_period": { "end_time_is_next_day": false, "use_start_time": "M4U4iH9euA", "use_end_time": "b6Vv2P28L4" }, "deductible_amount": 5347494354588285000, "day_of_week": [ 1 ] } ], "dynamic_par_rule_desc": "ZmLqqFyJQT", "dynamic_par_min_amount": 5351834886863714000, "dynamic_par_max_amount": 2244524436144371500 }, "show_channel": 1, "voucher_par_type": 1 }, "tag_info_list": [ { "TagName": "semHKXGO1O", "TagValue": "ifANLVZmus", "TagKey": "0VbGzxDF75" } ] }, "ext_product_id": "jaekgcSgiX", "sku_id": "mmZgyOdnTR", "commodities": [ { "items": [ { "sku_attr_list": [ { "num": 2386022604772080000, "attr_name": "fCulPOU1eq" } ], "name": "zorbQ7lGbU", "price": 5379956128946333000, "count": 4196409176200540700, "unit": "tU9ClyyLyY", "desc": "FDODVP5ygC", "item_tag": "oAMRVbVjFG", "attr_list": [ "b0r0tztUOL" ] } ], "group_name": "MyxoztSpjd", "total_count": 2608136676941909000, "option_count": 8197029325173938000 } ], "product_id": "OMQPEZwNFL", "product_origin_amount": 7621621911262384000, "num": 1025113568773305700 } ], "discounts": [ { "brand_discount_amount": 7294491335916383000, "discount_type": 6240128707131287000, "discount_amount": 4587034337091247600, "merchant_discount_amount": 6434240156856538000, "platform_discount_amount": 5959918744238433000, "provider_discount_amount": 2269360721137493500, "idle_time_info": { "WriteOffTimeLimit": { "WriteOffStartTime": 9164173224179990000, "WriteOffEndTime": 5217952538905202000, "DailyTimeRangeList": [ { "StartTime": "CkGE3phJpF", "EndTime": "YeF44MjV71" } ], "RelativeTime": { "RelativeTimeType": 1, "RelativeTime": 3653278719831764500 }, "WeekDayList": [ 1 ] }, "idle_time_limit_type": 1 } } ], "merchant_info": { "account_name": "Hw6DaHDyju", "account_id": "9Q8guKrqto" }, "order_type": 7507556647947936000, "open_id": "hlW49rsc4f", "third_sku_id": "7hcqglgXoN", "create_order_time": 3486459626325374500, "order_status": 545514091867458940, "receipt_amount": 7627427761144926000, "contacts": [ { "name": "ZU5vIdhnhQ", "phone": "wwcZGo1Fdp", "phone_encrypt": "Estk8yQvjo" } ], "sku_name": "swCsPRHy5u" } ], "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 | 已履约 | 该商品完成履约 | 系统 |