订单查询
通过接口查询指定范围的订单列表及订单详情:
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=3203670861804418240&cursor=[sYsM8hEJwy]&order_id=CB0ubU9mez&order_status=7129313899426612752&ext_order_id=Oo0ZZ5W7fs&create_order_end_time=6034144278010773073&create_order_start_time=7195493709935336582&open_id=Fbg1PjthPi&update_order_end_time=6109768134394650889&page_size=6186522565595162882&update_order_start_time=7876227477609517742&get_secret_number=false&account_id=Rdqd2yY3x8' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \
响应参数
Body展开全部子属性
extra必填Struct
扩展信息
展开子属性
dataStruct
数据列表
展开子属性
响应示例
正常响应示例异常响应示例
{ "data": { "orders": [ { "third_sku_id": "XWl4LOoq26", "payment_discount": 219590666649865860, "craftsman_uid": "GPyEJaPZpt", "buyer_info": { "buyer_secret_number": "dLch7vDB7w", "buyer_real_phone": "YaAo5KpKXZ", "buyer_phone": "jEEfDxBiuk" }, "amount_info": { "estimated_order_income": 2373512780526267400, "commission_amount": 1469557944135747600, "merchant_discount_amount": 7716454434686204000, "origin_amount": 7160973708818943000, "product_origin_amount": 7693581337023857000, "platform_discount_amount": 9149438119060134000, "merchant_deliver_freight_fee": 6914022101483844000, "freight_pay_amount": 7509372801225926000, "sale_price": 7705802045257486000, "brand_discount_amount": 6620639250199455000, "activities_fee_amount": 5121047135379890000, "platform_deliver_freight_fee": 1244343579961281300, "provider_discount_amount": 7057249835544618000, "pay_amount": 5813713161451061000, "pay_discount_amount": 1464853461930080500 }, "open_id": "pp6ZLNqJ4y", "poi": { "poi_id": "yEWFRNRsCc", "poi_name": "kHaxAVg4qd", "url": "jQD8NVvM3d" }, "products": [ { "snapshot_product": { "tag_info_list": [ { "TagValue": "sdxWapzv7M", "TagKey": "qpfvwkEJcK", "TagName": "NLfkJePtOc" } ], "product_attr": { "dynamic_par_rule": { "dynamic_par_rule_desc": "voG7zzyPFg", "dynamic_par_min_amount": 2037747639733321500, "dynamic_par_max_amount": 9194359724296800000, "dynamic_par_rule_item_list": [ { "time_period": { "use_end_time": "ZhVvo2xlcE", "end_time_is_next_day": false, "use_start_time": "ZcXE41e6QW" }, "deductible_amount": 8214688295487534000, "day_of_week": [ 1 ] } ] }, "show_channel": 1, "voucher_par_type": 1 } }, "num": 2904308358125605400, "product_origin_amount": 8813902538387306000, "sku_id": "NlAsCVHlgB", "ext_product_id": "CCAgKHYXMQ", "origin_amount": 8598616624654243000, "product_id": "eHmrG6idYj", "commodities": [ { "group_name": "YDCBlQT56d", "total_count": 8982520062950696000, "option_count": 3166249986874657300, "items": [ { "item_tag": "HInXcGZNXC", "attr_list": [ "AwLYnIvD7C" ], "sku_attr_list": [ { "num": 3301325093702642000, "attr_name": "2rxNw3sV3s" } ], "name": "3JMaaWb4Yj", "price": 6054342270952582000, "count": 1925616127250683100, "unit": "WDIpPTkitC", "desc": "qcVSmpcgdH" } ] } ], "product_name": "iaSOXK3SDt" } ], "room_id": "a3O3gHmvFP", "update_order_time": 7620840850999088000, "order_status": 3898459380027462700, "user_id": 2885641177379454500, "receiver_info": { "secret_number": "uEkEjHOzNE", "town": "Z49UC6nJ4l", "location_name": "dPRr32fN7L", "receiver_name": "A7AFiPGn6s", "receiver_real_phone": "DmX6nAQtwi", "lng": 0.23110526114298732, "city": "WTxmI79QSq", "location_address": "BNfIu8kDcF", "receiver_phone": "fkCDCjDXzj", "door_plate_num": "B9hkDhSZDz", "district": "QbvLiC58R1", "lat": 0.7300587330381256, "province": "zIVImsp0Xt" }, "order_type": 6451846147668264000, "sku_name": "XijHvFDG9J", "discounts": [ { "brand_discount_amount": 6829951460770237000, "discount_type": 6929356085963774000, "discount_amount": 943019268443299700, "merchant_discount_amount": 4265272261020813300, "platform_discount_amount": 525668199216146560, "provider_discount_amount": 7618883012542529000, "idle_time_info": { "WriteOffTimeLimit": { "WriteOffStartTime": 8476085153401970000, "WriteOffEndTime": 3801749115926189600, "DailyTimeRangeList": [ { "StartTime": "4QSAwZqVgL", "EndTime": "sbQuBkP8Hl" } ], "RelativeTime": { "RelativeTimeType": 1, "RelativeTime": 9063505184605671000 }, "WeekDayList": [ 1 ] }, "idle_time_limit_type": 1 } } ], "poi_id": "XXELec4CqK", "count": 624862328423215000, "merchant_info": { "account_name": "wcjQgqtKzV", "account_id": "zEba5Vn2KW" }, "certificate": [ { "refund_time": 5686442074280928000, "combination_id": "XQwuQT0TmW", "order_item_id": "HeeJHLTQou", "certificate_id": "a5vkpGendA", "item_status": 8403219623832155000, "item_update_time": 5497306730511203000, "refund_amount": 7682066257719038000 } ], "intention_poi_id": "nxuM2KSeQS", "order_id": "5NgAD91mPf", "delivery_info": { "table_ware": "muGuqv0mNr", "deliver_model": 8771954423677356000, "shop_number": "MEdcietm1K", "is_book": false, "user_expect_time": "DLeKL0sZmJ", "sys_expect_time": "Yw4rUqoG5l", "remark": "GCzX8q6Vv8" }, "create_order_time": 1410268867582209300, "sub_order_amount_infos": [ { "combination_id": "m6mmpglXSt", "sub_order_type": 2654014481355445000, "sub_order_id": "Z6OGwD7Bui", "pay_amount": 7508212064064034000, "origin_amount": 8072596553962461000, "discount_amount": 4779112671479479000, "discounts": [ { "discount_amount": 6894830620351572000, "merchant_discount_amount": 2446422749282452500, "platform_discount_amount": 647955461499617800, "provider_discount_amount": 7553268481356491000, "idle_time_info": { "idle_time_limit_type": 1, "WriteOffTimeLimit": { "WriteOffEndTime": 2211942923090985500, "DailyTimeRangeList": [ { "StartTime": "ZgX2aG2zjM", "EndTime": "IisKK64icl" } ], "RelativeTime": { "RelativeTime": 5928089450050163000, "RelativeTimeType": 1 }, "WeekDayList": [ 1 ], "WriteOffStartTime": 7863835990260748000 } }, "brand_discount_amount": 890350491301108900, "discount_type": 7431665019383746000 } ], "receipt_amount": 1533334322208183300 } ], "pay_amount": 2215496612768574500, "pay_time": 806407876396299500, "original_amount": 7604863722503333000, "sku_id": "2dChBIypBc", "contacts": [ { "name": "FkCpVjuGRs", "phone": "LclgiJGYfx", "phone_encrypt": "quCLxs7INp" } ], "anchor_id": 912410529681287700, "is_deliver_later": false, "receipt_amount": 3329511745291765000, "discount_amount": 6724904624063176000 } ], "page": { "page_num": 7296137105416015000, "page_size": 8895549951895936000, "total": 8040445756050819000 }, "search_after": { "Size": 411974117283302100, "CursorValue": [ "itbU8fd0Bt" ], "AllCursorValue": [ [ "OaraxGC4XN" ] ] }, "error_code": 0, "description": "" }, "extra": { "error_code": 0, "description": "", "sub_error_code": 0, "sub_description": "", "logid": "2025071614301306BA8197C6502F7DDB9E", "now": 1752647413 } }
错误码
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 | 已履约 | 该商品完成履约 | 系统 |