订单查询
通过接口查询指定范围的订单列表及订单详情:
1、查询指定状态的订单列表,用于对账或差异单最新状态确认;
2、查询指定用户的订单列表,用于积分计算、订单展示;
3、查询指定订单详情,用于接口补偿处理。
开票说明
尊敬的商家,依据税务规则与《抖音生活服务平台商户合作协议》的约定,如用户向商家申请开具发票,商家应按照用户实际支付金额向用户开具相应金额的发票。用户的实际支付金额可参考订单查询pay amount字段展示的具体金额(用户实际支付金额,不含平台等其他方补贴的金额)。
针对平台补贴需向平台开具增值税发票,请勿开具给用户。若商家向用户超额开具发票,由此导致的损失及税务风险需由商家自行承担
接口说明
- 服务商通过接口查询订单详情,支持三种查询方式(不支持查询酒店行业订单信息):
- 根据订单 ID 或第三方订单号,查询对应订单详情,入参:订单 ID/第三方订单号、商户 id;该接口为订单维度查询,不支持券维度查询。
- 根据订单状态和商户 id,查询指定时间内该商户下的订单列表,入参:商户 id、订单状态、创单起止时间/修改起止时间;
- 根据用户 id 和商户 id,查询某用户在该商户下的所有订单,入参:商户 id、用户 id、创单起止时间/修改起止时间;
- 支付后未发码/发码失败订单查询方式:限定订单状态为“已支付”,如用户下单后超过 10 分钟未发码会发起退款;
- 退款申请待审核订单查询方式:限定券状态为“退款中”,如退款状态未响应超过 72 小时会自动退款。
- 承载总qps:200 (单服务商应用默认:20)
- 订单查询接口不会透传券码明文code
- 查询时间和订单完成时间一致导致需要延长2-3秒查询或增加重试机制
使用限制
transfer_uid是条件性返回字段,仅在同时满足以下两个条件时才会返回:
订单的sale_role(销售角色)为“达人”“职人”或“店员”;
订单带有明确的room_id(直播间ID)或item_id(商品ID)等关联标识。若订单不满足上述条件(如sale_role为“商家”或“ 其他”,或无关联标识),则该字段不会出现在接口返回数据中。
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
(page_num×page_size 不得超过 10000,超过一万使用 Cursor 参数查询)
create_order_end_timeInt64
创单结束时间(秒时间戳,创单起止时间必须同时传入)
create_order_start_timeInt64
创单起始时间 (秒时间戳,创单起止时间必须同时传入)
cursorArray<String>
根据游标滚动请求,直到返回结果数量小于请求的size或未返回search_after结束;
首页传"0",之后传返回参数中的CursorValue string数组拼接的string,如CursorValue返回参数["0","1"],则传"0,1";
如果传入此参数(cursor),会优先使用cursor翻页,而不是page翻页;但page_size和page_num是必填项,不传会报错
ext_order_idString
开发者系统中的订单号
get_secret_numberBool
是否需要查询配送信息
(已废弃,当前接口忽略该参数)
open_idString
抖音内部用户的一种唯一标识
如果对接了会员通,可以通过接收会员入会SPI接口获取并保存
order_idString
抖音生活服务订单ID
见抖音-团购频道-订单详情
order_statusInt32
订单状态
(0=初始化、100=待支付、101=支付取消、200=已支付、201=待使用、1=已完成、150=部分支付)
update_order_end_timeInt64
修改结束时间(秒时间戳,修改起止时间必须同时传入)
update_order_start_timeInt64
修改起始时间 (秒时间戳,修改起止时间必须同时传入)
请求示例
curl --location --request GET 'https://open.douyin.com/goodlife/v1/trade/order/query/?get_secret_number=false&create_order_start_time=3240717436550218958&order_id=eYOMMtI4CR&page_size=5074727875666023414&ext_order_id=IFTpG9S00b&create_order_end_time=6004376316893545467&order_status=3701043678719364315&update_order_start_time=8983227566587768845&cursor=[acme63Asd8]&open_id=OIevwduC4p&update_order_end_time=1837261115335521251&account_id=b7fQMVfIww&page_num=1983460959357172791' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \
响应参数
Body展开全部子属性
extra必填Struct
扩展信息
展开子属性
dataStruct
数据列表
展开子属性
响应示例
正常响应示例异常响应示例
{ "data": { "search_after": { "CursorValue": [ "GbYgoHn8QX" ], "AllCursorValue": [ [ "4CcUWInqcd" ] ], "Size": 4427297293879609000 }, "orders": [ { "update_order_time": 4939691383804446000, "source_order_id": "mmLXXhIy8b", "intention_poi_id": "VT2dMMx40A", "merchant_info": { "account_id": "vLHiQP7PXF", "account_name": "QrpvHzhYob" }, "third_sku_id": "GBrXEpBqJ5", "pay_amount": 4093985637258134000, "count": 174263170485427260, "create_order_time": 4000758574540797000, "poi": { "poi_id": "wgcv9pzLqs", "poi_name": "mQ3ULML72h", "url": "oZmTDTsl87" }, "products": [ { "product_origin_amount": 6015544900652163000, "origin_amount": 8952107363008777000, "product_id": "AMlcsvy5EH", "num": 403449382940245600, "sku_id": "B7GwvWQoXy", "third_sku_id": "0SUiWyZRY8", "commodities": [ { "items": [ { "sku_attr_list": [ { "attr_name": "BauBYw3soO", "num": 7954284133076165000 } ], "item_tag": "DfgodVnM3S", "count": 6901322921686252000, "price": 3397011461266538000, "unit": "0nCNvR6UEy", "desc": "jStsrdNM2I", "attr_list": [ "H9RS4pF10R" ], "name": "pvaIZIdt1f" } ], "group_name": "nCCGt7MBux", "total_count": 8930666600492396000, "option_count": 884166512219852000 } ], "ext_product_id": "KYevIPcKI2", "product_name": "7Lxhx9fnVK", "snapshot_product": { "product_attr": { "show_channel": 1, "advance_purchase_struct": { "time_detail": [ { "time_type": 1, "time": 7342063093950342000 } ], "purchase_type": 1 }, "combo_package_verify_limit_struct": { "type": 1, "product_id_index": { "4151179404708108946": 4756449229435201000 } }, "voucher_par_type": 1, "dynamic_par_rule": { "dynamic_par_rule_item_list": [ { "day_of_week": [ 1 ], "time_period": { "end_time_is_next_day": false, "use_start_time": "p0LUASTbpv", "use_end_time": "fpUmxKTm4H" }, "deductible_amount": 849802593733835300 } ], "dynamic_par_rule_desc": "CnNoQR5ozN", "dynamic_par_min_amount": 2754092050875038700, "dynamic_par_max_amount": 304395446090380800 } }, "tag_info_list": [ { "TagName": "tGMaJyawd2", "TagValue": "hNlUQjfm6k", "TagKey": "IlNPbWd0LK" } ] } } ], "pay_time": 6076269884955435000, "amount_info": { "pay_discount_amount": 4544888641843104000, "pay_amount": 3339765492208801000, "origin_amount": 4089836214548482600, "merchant_discount_amount": 716329700198600200, "platform_deliver_freight_fee": 5170439152121506000, "deduct_amount": 6368077255007219000, "estimated_order_income": 1187285600806412300, "commission_amount": 7146989570723935000, "product_origin_amount": 339852522109492860, "deduct_info_list": [ { "source_selling_price": 2279992443320554200, "source_sku_id": 5749551828255516000, "source_pay_amount": 7056450739572213000, "source_product_name": "sjIWYjnwGI", "groupon_type": 1, "source_payment_discount_amount": 2264727801844324600, "source_merchant_discount_amount": 2920575976556742700, "source_provider_discount_amount": 359728822662814500, "source_product_id": 4302309152454432000, "source_sku_name": "8sHDVxFEX9", "source_brand_discount_amount": 4716500755398979000, "source_order_id": "ba38e1oPUn", "source_origin_amount": 1966521765391305700, "source_platform_discount_amount": 7243238405661067000, "order_source": 1, "source_certificate_id": "4q7NtrAXVp", "voucher_type": 1 } ], "freight_pay_amount": 4099027812586306, "sale_price": 8969831693907028000, "provider_discount_amount": 4981279846516071000, "merchant_deliver_freight_fee": 6164169768939039000, "brand_discount_amount": 6731460946019962000, "platform_discount_amount": 3329878067490930700, "activities_fee_amount": 4801141161424629000 }, "original_amount": 6463924414412824000, "user_id": 310016646258781500, "poi_id": "3rbi2t0eI2", "order_id": "YSznHq4AnF", "order_status": 5842433892924812000, "sku_name": "fYypMBMX6N", "discounts": [ { "discount_type": 8046037912655827000, "discount_amount": 7224546420129032000, "merchant_discount_amount": 9176994689183684000, "platform_discount_amount": 4478919301851959000, "provider_discount_amount": 1956429533718101000, "idle_time_info": { "WriteOffTimeLimit": { "DailyTimeRangeList": [ { "StartTime": "V480yiXD1N", "EndTime": "taxya9LwdY" } ], "RelativeTime": { "RelativeTimeType": 1, "RelativeTime": 3887848360160321500 }, "WeekDayList": [ 1 ], "WriteOffStartTime": 5027891014371701000, "WriteOffEndTime": 6758534852573413000 }, "idle_time_limit_type": 1 }, "brand_discount_amount": 4503302091732946000 } ], "discount_amount": 489217250335417660, "payment_discount": 8039446354988506000, "pay_bill_info": { "order_source": 1, "total_pay_amount": 3787727333321181000, "is_timely_pay_bill": false }, "anchor_id": 3437101685801167400, "receipt_amount": 8983340852300206000, "buyer_reserve_info": [ { "enc_name": "9xm5IZ2FaB", "credential_type": 8568149997841432000, "enc_credential_numb": "YWBl2bsHhf" } ], "sku_id": "dG5oKOoCQ7", "certificate": [ { "order_item_id": "2PaVWtQ2Lt", "refund_amount": 1529798150195691300, "item_status": 5800404130343315000, "fulfil_mode": 1, "refund_time": 1675854282686989000, "combination_id": "m9TtHswbg9", "item_update_time": 7347643437764882000, "certificate_id": "LK1KNrdjAn" } ], "is_deliver_later": false, "delivery_info": { "deliver_model": 7577812138482491000, "shop_number": "LHPrDKp8Jg", "is_book": false, "user_expect_time": "nVR7AmPjM6", "sys_expect_time": "QSu0lOCBuH", "remark": "TjuUUzGeCi", "table_ware": "WmqgFHwlXx" }, "sub_order_amount_infos": [ { "sub_order_type": 4985344644255154000, "pay_amount": 8487907489691258000, "receipt_amount": 1726759777921019400, "origin_amount": 247749112107999600, "combination_id": "JL5dlpkrOk", "sub_order_id": "FpzUXFzyjN", "discount_amount": 7359748791820050000, "discounts": [ { "brand_discount_amount": 6471554802366140000, "discount_type": 9083807102812335000, "discount_amount": 7067562186160725000, "merchant_discount_amount": 6644844895288087000, "platform_discount_amount": 1122299791388079100, "provider_discount_amount": 5468788385819068000, "idle_time_info": { "idle_time_limit_type": 1, "WriteOffTimeLimit": { "RelativeTime": { "RelativeTimeType": 1, "RelativeTime": 8985916218411347000 }, "WeekDayList": [ 1 ], "WriteOffStartTime": 5732790229860214000, "WriteOffEndTime": 5515796998229423000, "DailyTimeRangeList": [ { "EndTime": "PjpwJ9lKvz", "StartTime": "F2yet8WS9E" } ] } } } ] } ], "contacts": [ { "name": "YE92fOqiGU", "phone": "lJmmp01bQM", "phone_encrypt": "uSYjTxaVmo" } ], "buyer_info": { "buyer_secret_number": "VMhsDMIAcp", "buyer_real_phone": "1O4oehCOj3", "buyer_phone": "MHAqWH46Ed" }, "receiver_info": { "lat": 0.39630362415811743, "location_address": "7W9pxfoj7R", "lng": 0.24914643760120783, "town": "1dScRsrPQt", "secret_number": "9HNuXmqPxW", "province": "iPaQW3NRkQ", "receiver_real_phone": "zu5iE4OIQn", "location_name": "lO9LDMmoZA", "door_plate_num": "NPvsIHo2l8", "receiver_name": "EScWHb6JVn", "district": "Rzs0gh5u4U", "receiver_phone": "AdQeZ5mIWP", "city": "wkHWFRrN9s" }, "order_type": 2117428086159696600, "reservation_gift": { "reserved_gift_quantity": "yQ6qNsiJ2R", "reserved_gift_content": "KSELn7gUMX", "has_reserved_gift": false }, "order_sale_info": { "transfer_uid": "Vv5bJr59SW", "transfer_douyin_uid": "EIixL06oWC", "order_source": 1, "sale_role": "Lov7sgVTEf", "sale_channel": "Q3irEBgRUF", "transfer_nickName": "eYpQmFs0bn" }, "craftsman_uid": "Y3zMytjxO2", "open_id": "rrb29OEB5i", "room_id": "2LFjq7Txv1" } ], "page": { "total": 3570694597586331600, "page_num": 5618724666730906000, "page_size": 1398468245322948600 }, "error_code": 0, "description": "" }, "extra": { "error_code": 0, "description": "", "sub_error_code": 0, "sub_description": "", "logid": "20260708200902E6C4959D7BB12A43586B", "now": 1783512544 } }
错误码
| 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 | 已履约 | 该商品完成履约 | 系统 |
