订单查询
通过接口查询指定范围的订单列表及订单详情:
1、查询指定状态的订单列表,用于对账或差异单最新状态确认;
2、查询指定用户的订单列表,用于积分计算、订单展示;
3、查询指定订单详情,用于接口补偿处理。
开票说明
尊敬的商家,依据税务规则与《抖音生活服务平台商户合作协议》的约定,如用户向商家申请开具发票,商家应按照用户实际支付金额向用户开具相应金额的发票。用户的实际支付金额可参考订单查询pay amount字段展示的具体金额(用户实际支付金额,不含平台等其他方补贴的金额)。
针对平台补贴需向平台开具增值税发票,请勿开具给用户。若商家向用户超额开具发票,由此导致的损失及税务风险需由商家自行承担
接口说明
- 服务商通过接口查询订单详情,支持三种查询方式:
- 根据订单 ID 或第三方订单号,查询对应订单详情,入参:订单 ID/第三方订单号、商户 id;
- 根据订单状态和商户 id,查询指定时间内该商户下的订单列表,入参:商户 id、订单状态、创单起止时间/修改起止时间;
- 根据用户 id 和商户 id,查询某用户在该商户下的所有订单,入参:商户 id、用户 id、创单起止时间/修改起止时间;
- 支付后未发码/发码失败订单查询方式:限定订单状态为“已支付”,如用户下单后超过 10 分钟未发码会发起退款;
- 退款申请待审核订单查询方式:限定券状态为“退款中”,如退款状态未响应超过 72 小时会自动退款。
- 承载总qps:200 (单服务商应用默认:20)
使用限制
SLA:支持的最大QPS:20;PCT99承诺值:2ms;
基本信息
| 名称 | 描述 |
|---|---|
| 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翻页,但page_size和page_num是必填项,不传会报错
ext_order_idString
开发者系统中的订单号
get_secret_numberBool
是否需要查询配送信息
open_idString
抖音内部用户的一种唯一标识
如果对接了会员通,可以通过接收会员入会SPI接口获取并保存
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=602016740182894127&cursor=[tSH5FndIWu]&create_order_start_time=8970877567997522303&update_order_start_time=3522863798191870333&order_status=8569828167959769364&open_id=zstyokwbwM&account_id=VEVpJ0FnQQ&ext_order_id=EUuipo7GUq&get_secret_number=false&page_size=430929905388603913&update_order_end_time=4983719544842469223&create_order_end_time=8378796556838530003&order_id=1OVpDkXRMF' \ --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": "202604151825291F7F4B09F9D1DCABE990", "now": 1776248732 }, "data": { "orders": [ { "order_sale_info": { "transfer_uid": "KnlmMssz6H", "transfer_douyin_uid": "iCNWAl00Nr", "sale_role": "6c3ZhoCzCx", "sale_channel": "QpsC8i4dVN", "transfer_nickName": "hn8m6tChtb" }, "is_deliver_later": false, "order_id": "nyan02dXWb", "create_order_time": 3578783278173743600, "poi": { "poi_name": "wvrkmvbDR4", "url": "Ekjdpbuggo", "poi_id": "8jewa9Miiq" }, "pay_time": 2349757051448570400, "discounts": [ { "discount_type": 8868434777360697000, "discount_amount": 2345576152360665600, "merchant_discount_amount": 5871127341467790000, "platform_discount_amount": 459584400536880400, "provider_discount_amount": 4894496704504925000, "idle_time_info": { "idle_time_limit_type": 1, "WriteOffTimeLimit": { "WriteOffEndTime": 3227126645269250000, "DailyTimeRangeList": [ { "EndTime": "dSk0MLOq8H", "StartTime": "eiBzE0HONg" } ], "RelativeTime": { "RelativeTimeType": 1, "RelativeTime": 2240872359662439200 }, "WeekDayList": [ 1 ], "WriteOffStartTime": 6673592826836628000 } }, "brand_discount_amount": 3814991810319389000 } ], "payment_discount": 4816343128066495000, "craftsman_uid": "ITD6FjoQFt", "poi_id": "SMbmJPyFrI", "anchor_id": 8716810527102667000, "room_id": "PnboPfUgHd", "discount_amount": 6941634252622030000, "amount_info": { "deduct_amount": 2873226107979074000, "sale_price": 1925646090973303000, "brand_discount_amount": 6050133797120334000, "product_origin_amount": 3126788113044583000, "deduct_info_list": [ { "source_origin_amount": 5836483108208806000, "source_payment_discount_amount": 502420160443635900, "source_selling_price": 5348616503803589000, "source_product_name": "PdQeWWtefA", "source_platform_discount_amount": 6763775773061140000, "source_brand_discount_amount": 6236122402922173000, "source_product_id": 546387104062407500, "source_provider_discount_amount": 8862632708076979000, "source_pay_amount": 3929551832928316400, "source_sku_id": 6136220153823282000, "source_certificate_id": "VP1lKH6OHR", "source_merchant_discount_amount": 8218112745381144000, "voucher_type": 1, "source_sku_name": "bbNu7EjA20", "source_order_id": "8TM4n13dvE", "groupon_type": 1 } ], "merchant_discount_amount": 5324803986251128000, "platform_discount_amount": 4630704772488067000, "pay_discount_amount": 1932975940390598700, "merchant_deliver_freight_fee": 3873938097126566000, "activities_fee_amount": 5616581684760520000, "estimated_order_income": 754035991131766500, "origin_amount": 8939184693482757000, "platform_deliver_freight_fee": 9063385405837383000, "freight_pay_amount": 4572217688587082000, "pay_amount": 6140057266555650000, "commission_amount": 3534615631052190700, "provider_discount_amount": 5954907832266698000 }, "intention_poi_id": "GkRoaM1vzT", "products": [ { "sku_id": "HUyD9nTXuS", "ext_product_id": "N5PrwOvtzb", "commodities": [ { "option_count": 4822793917656130000, "items": [ { "sku_attr_list": [ { "num": 6944280892503953000, "attr_name": "oIu0bIvH8W" } ], "name": "7X3Du9vBlX", "price": 5840609362253685000, "attr_list": [ "FG7LfeG6dL" ], "unit": "naTSiWTiQT", "item_tag": "nb2luRBIXC", "desc": "uzvDMeANFt", "count": 2018198307695811600 } ], "group_name": "6rKQ5faHNk", "total_count": 7607374592733674000 } ], "origin_amount": 1583073099997362000, "product_origin_amount": 7445358504704728000, "product_id": "tfLusnUfBN", "product_name": "D2JLzvT0AK", "snapshot_product": { "tag_info_list": [ { "TagName": "ZFgD3NJTtj", "TagValue": "ogG7f7ceKF", "TagKey": "yzGMYpKwZp" } ], "product_attr": { "advance_purchase_struct": { "purchase_type": 1, "time_detail": [ { "time": 4217673423538420700, "time_type": 1 } ] }, "combo_package_verify_limit_struct": { "type": 1, "product_id_index": { "1110362344605731145": 2249369780799306500 } }, "voucher_par_type": 1, "dynamic_par_rule": { "dynamic_par_min_amount": 4265718782649289700, "dynamic_par_max_amount": 855135252851832300, "dynamic_par_rule_item_list": [ { "day_of_week": [ 1 ], "time_period": { "use_start_time": "V7ItYGzUaA", "use_end_time": "CKs8goOapG", "end_time_is_next_day": false }, "deductible_amount": 5017436341248865000 } ], "dynamic_par_rule_desc": "jf7y69ytki" }, "show_channel": 1 } }, "num": 3320167057906438000, "third_sku_id": "GCAqYTDcPC" } ], "contacts": [ { "name": "cEs4z37SWi", "phone": "ikD1oxNYAt", "phone_encrypt": "CnPBMEulvM" } ], "sku_id": "zWs6BRWESi", "certificate": [ { "item_update_time": 858979551126482700, "certificate_id": "CDkovzGOAC", "item_status": 8961885119100606000, "combination_id": "ECKhN8rHMC", "refund_time": 1995877079050482200, "order_item_id": "rbMHFpigkd", "fulfil_mode": 1, "refund_amount": 5571755437093664000 } ], "original_amount": 5693732658851019000, "order_status": 1989014430344555800, "order_type": 5824884185029678000, "third_sku_id": "CUMcHFGyBl", "open_id": "r3Y1qh2uRF", "user_id": 8552681107235754000, "receipt_amount": 3688770509890631000, "sub_order_amount_infos": [ { "discounts": [ { "provider_discount_amount": 5572193415971641000, "idle_time_info": { "WriteOffTimeLimit": { "WeekDayList": [ 1 ], "WriteOffStartTime": 1237502749256235300, "WriteOffEndTime": 4134241845459819500, "DailyTimeRangeList": [ { "StartTime": "IFdmnRyR4r", "EndTime": "7nziZ86HIT" } ], "RelativeTime": { "RelativeTimeType": 1, "RelativeTime": 7503492281055586000 } }, "idle_time_limit_type": 1 }, "brand_discount_amount": 5940252532139710000, "discount_type": 1855346026941161500, "discount_amount": 3781602344781449000, "merchant_discount_amount": 7855887722267711000, "platform_discount_amount": 1987442872911873800 } ], "pay_amount": 1398254137053584400, "origin_amount": 8466422261369594000, "sub_order_type": 4876440778231509000, "discount_amount": 4320177020083247000, "combination_id": "9yhUrr65rF", "sub_order_id": "jiSPCiaOKu", "receipt_amount": 5259805328646584000 } ], "merchant_info": { "account_id": "MzYZn9yzz7", "account_name": "4gGbYa4i7N" }, "receiver_info": { "receiver_phone": "Vut0V8JIbN", "lng": 0.19371498691478947, "secret_number": "VL0tejrRZ1", "city": "suXxDBy8H1", "location_name": "AfIpGrdg1n", "district": "LXcppmv6zo", "town": "tOSdTjv9Z6", "location_address": "tHJXe6xqeX", "lat": 0.8497033359423157, "receiver_real_phone": "wvLbBH7psL", "receiver_name": "RX7sVkizGu", "door_plate_num": "blEfdWTHSN", "province": "oAEI927nn9" }, "source_order_id": "PGDYTfUwJf", "delivery_info": { "shop_number": "TgFjVmDA2e", "is_book": false, "user_expect_time": "PGXItWMPMF", "sys_expect_time": "4say4crrDk", "remark": "kaX1l7ckC7", "table_ware": "w715EUSCjz", "deliver_model": 8744384390915202000 }, "update_order_time": 711457935491845900, "sku_name": "PbwwOQh2nD", "pay_amount": 4263172278578437000, "buyer_info": { "buyer_phone": "1PfRJrJwA7", "buyer_secret_number": "uyp0SRSaZD", "buyer_real_phone": "NIs8VOsGls" }, "count": 3771103604422676500 } ], "page": { "page_num": 8053399576091638000, "page_size": 8541874759193066000, "total": 1504050230756663600 }, "search_after": { "Size": 9128043071931039000, "CursorValue": [ "YrfdnlOpGK" ], "AllCursorValue": [ [ "FX7waojP5S" ] ] }, "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 | 已履约 | 该商品完成履约 | 系统 |
