订单查询
通过接口查询指定范围的订单列表及订单详情:
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/?page_num=5256422310380081083&cursor=[qZmnDjFq9n]&account_id=xIawfRsXPO&open_id=wVTCmU1yzz&update_order_start_time=1320545379859598957&update_order_end_time=3022100944209400494&create_order_end_time=7125659057533839883&page_size=2963319799704829618&create_order_start_time=2873165229348388619&ext_order_id=ZQst8P8N4f&order_status=6264692644341211631&get_secret_number=false&order_id=1piQufvdbj' \ --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": "202511191412044CAAD81BF82C5B54643D", "now": 1763532733 }, "data": { "search_after": { "AllCursorValue": [ [ "iU2ieYnqzt" ] ], "Size": 5186220927613528000, "CursorValue": [ "5rhYlJ8AuY" ] }, "orders": [ { "order_status": 5939101915925500000, "order_type": 3479861189806615000, "contacts": [ { "name": "PFXATqx9As", "phone": "v5n3t3f4VU", "phone_encrypt": "1844KkK4AF" } ], "sub_order_amount_infos": [ { "pay_amount": 877982188126374000, "origin_amount": 5887281450054055000, "discount_amount": 6393544018928255000, "discounts": [ { "discount_type": 2335504660754233300, "discount_amount": 1610752042276018000, "merchant_discount_amount": 182458222772989660, "platform_discount_amount": 3781978183586043400, "provider_discount_amount": 6375497416127331000, "idle_time_info": { "WriteOffTimeLimit": { "WriteOffStartTime": 558549349635789300, "WriteOffEndTime": 2528683039553910300, "DailyTimeRangeList": [ { "StartTime": "xytGcIBxyz", "EndTime": "x4mwuqeXqr" } ], "RelativeTime": { "RelativeTime": 6426526364278744000, "RelativeTimeType": 1 }, "WeekDayList": [ 1 ] }, "idle_time_limit_type": 1 }, "brand_discount_amount": 8383406154466515000 } ], "receipt_amount": 943161157429953900, "combination_id": "CPpHH4saRn", "sub_order_type": 8416083795970521000, "sub_order_id": "2rUs8LQ3IG" } ], "intention_poi_id": "VSfVzdVCNc", "pay_amount": 8427089338206785000, "source_order_id": "vS2xxbCcpk", "open_id": "R2EVuuBHmN", "anchor_id": 1090736892113185400, "amount_info": { "platform_deliver_freight_fee": 5767509647534778000, "sale_price": 5184078405914279000, "activities_fee_amount": 8479429372139375000, "estimated_order_income": 3861681168252135000, "deduct_info_list": [ { "source_product_id": 1119418545075644500, "source_origin_amount": 2129778664470569000, "source_pay_amount": 6288978525434585000, "source_merchant_discount_amount": 7187157472282848000, "source_sku_id": 8072697400345005000, "source_certificate_id": "Bf3WYqlCpL", "voucher_type": 1, "source_platform_discount_amount": 7754364495967294000, "source_sku_name": "T2ACOgc3Jt", "source_order_id": "DZEJCCj6yI", "groupon_type": 1, "source_product_name": "lYe0JnK2yz" } ], "platform_discount_amount": 2043447904637868500, "commission_amount": 8271259474154647000, "provider_discount_amount": 9008751245948116000, "origin_amount": 8306808720095213000, "freight_pay_amount": 6355150886297241000, "brand_discount_amount": 1975616710352076300, "deduct_amount": 4028784150698603000, "pay_discount_amount": 3645033341863362000, "pay_amount": 3358521906607266300, "merchant_deliver_freight_fee": 1244260963701114000, "product_origin_amount": 1842609421020587300, "merchant_discount_amount": 3736772705371161000 }, "discount_amount": 7849529242160783000, "third_sku_id": "V2jY8Ig6Gm", "buyer_info": { "buyer_phone": "9Usao23Nfd", "buyer_secret_number": "yCcdciD7u0", "buyer_real_phone": "DKhIZaJAIq" }, "is_deliver_later": false, "user_id": 6789603334921266000, "payment_discount": 6003840618421976000, "receipt_amount": 8537164678566357000, "craftsman_uid": "VKy44q2kZa", "create_order_time": 6813037670561536000, "order_id": "stlKRnqiSX", "original_amount": 1805408456134002200, "update_order_time": 4466933325138053000, "sku_id": "ltfqYITcpG", "products": [ { "ext_product_id": "PZHKExd7fO", "num": 4336819047449681400, "commodities": [ { "group_name": "3aLTY1wC5C", "total_count": 5120162970443700000, "option_count": 2210896528604207900, "items": [ { "unit": "wq0V1tL37c", "desc": "At1Tu05cwj", "item_tag": "hFjRuqxlh7", "attr_list": [ "5lrbgVgIkZ" ], "sku_attr_list": [ { "num": 7425156838214248000, "attr_name": "y8cF6CZMqg" } ], "name": "N2JrOwSdBr", "price": 7884522264635965000, "count": 3900333972573377000 } ] } ], "snapshot_product": { "product_attr": { "voucher_par_type": 1, "dynamic_par_rule": { "dynamic_par_max_amount": 2021309236167944400, "dynamic_par_rule_item_list": [ { "day_of_week": [ 1 ], "time_period": { "use_end_time": "CS3sCdzc8v", "end_time_is_next_day": false, "use_start_time": "M7ufVyv4am" }, "deductible_amount": 2880149677800375300 } ], "dynamic_par_rule_desc": "8JcsW6cQfI", "dynamic_par_min_amount": 7514208585477229 }, "show_channel": 1, "advance_purchase_struct": { "purchase_type": 1, "time_detail": [ { "time_type": 1, "time": 1590845299692577300 } ] }, "combo_package_verify_limit_struct": { "type": 1, "product_id_index": { "563835767583080377": 8901880066992623000 } } }, "tag_info_list": [ { "TagValue": "dduhwGYlA9", "TagKey": "A0wHIWyUYg", "TagName": "Ws4zsKg40g" } ] }, "product_origin_amount": 8397750772389391000, "origin_amount": 8707873822341032000, "product_name": "WJwPEE1bH8", "sku_id": "cArdC2KS18", "product_id": "IKKqDyU0Ec" } ], "count": 8876244412373294000, "room_id": "pJc61s356N", "certificate": [ { "refund_time": 2773611277107394600, "combination_id": "j3vQqeoVHP", "fulfil_mode": 1, "order_item_id": "TghaqaBw5S", "certificate_id": "wH2AKN1GS2", "item_status": 3209652474449395000, "item_update_time": 5963910129681149000, "refund_amount": 1527441861004285400 } ], "merchant_info": { "account_name": "nZcCcb8imq", "account_id": "Zmw4My2tC0" }, "sku_name": "FGzbf08LcU", "poi": { "poi_id": "IkPOhcFADd", "poi_name": "Wbr5zSztss", "url": "fPbKF4QG9y" }, "receiver_info": { "receiver_name": "OuzeVM2UKQ", "district": "UubQD3OnGL", "receiver_real_phone": "w6LQOC3QCE", "province": "oZ39RgDsl1", "lat": 0.3647051058799437, "location_address": "tPA1lCLWEZ", "lng": 0.9239907429358797, "door_plate_num": "WMeAcMKgHT", "town": "Jbh60ue6cn", "secret_number": "UIJhDu5cX7", "city": "voe0nWWBXR", "receiver_phone": "lgu2FhU9G8", "location_name": "ZUTGxiNmzN" }, "pay_time": 7943647103927976000, "discounts": [ { "platform_discount_amount": 2759846013509633500, "provider_discount_amount": 8506642217518382000, "idle_time_info": { "WriteOffTimeLimit": { "WeekDayList": [ 1 ], "WriteOffStartTime": 583937703982061800, "WriteOffEndTime": 9025467357632417000, "DailyTimeRangeList": [ { "StartTime": "JAtbOnqdf5", "EndTime": "NqndXD9IVK" } ], "RelativeTime": { "RelativeTimeType": 1, "RelativeTime": 2714944354329142300 } }, "idle_time_limit_type": 1 }, "brand_discount_amount": 4503690730696213500, "discount_type": 6216731356810107000, "discount_amount": 323115393731996700, "merchant_discount_amount": 718845190165033900 } ], "poi_id": "nVcHDdoKq1", "delivery_info": { "sys_expect_time": "PcMnD02xa7", "remark": "HcjYc8lcmZ", "table_ware": "WqBPMyj7GW", "deliver_model": 2640283304611017700, "shop_number": "iteGvZBaoo", "is_book": false, "user_expect_time": "vZwJ5s8Vs1" } } ], "page": { "total": 3783948358315982300, "page_num": 5398736207031303000, "page_size": 8773002149245941000 }, "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 | 3000001 | 以实际错误信息为准 | |
| 200 | 5000001 | 服务器打瞌睡了,请稍后再试。 |
附录
(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 | 已履约 | 该商品完成履约 | 系统 |
