订单查询
通过接口查询指定范围的订单列表及订单详情:
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/?order_id=DL1txp8Zhh&order_status=8401887910238374889&get_secret_number=false&create_order_end_time=1070701471099307931&page_num=10402883612639321&account_id=KUgMJbXBY1&update_order_start_time=4717436603725171176&update_order_end_time=7605421996286429985&page_size=8976018493655501111&open_id=G2b98cDxtW&create_order_start_time=4655738128202190513&cursor=[TmBCuch5A4]&ext_order_id=2FcJd5VSSR' \ --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": "202608181627017F3EBC4E257ED561B101", "now": 1787041624 }, "data": { "search_after": { "CursorValue": [ "WHkmTigjCQ" ], "AllCursorValue": [ [ "gx3febQZZL" ] ], "Size": 3663713671160379000 }, "orders": [ { "discounts": [ { "platform_discount_amount": 1477776874034140700, "provider_discount_amount": 774666914396590600, "idle_time_info": { "WriteOffTimeLimit": { "RelativeTime": { "RelativeTimeType": 1, "RelativeTime": 7898344099287113000 }, "WeekDayList": [ 1 ], "WriteOffStartTime": 1192190316293387800, "WriteOffEndTime": 6544541638518890000, "DailyTimeRangeList": [ { "StartTime": "Pw7hzuEIr1", "EndTime": "MTUMRfNZh5" } ] }, "idle_time_limit_type": 1 }, "brand_discount_amount": 6009962685713384000, "discount_type": 5363009849371921000, "discount_amount": 4825181203876337000, "merchant_discount_amount": 6194597976867189000 } ], "is_deliver_later": false, "order_status": 4907604583855847000, "buyer_reserve_info": [ { "enc_credential_numb": "Vqb2WgdbkK", "enc_name": "pIDU6CicWq", "credential_type": 8622460623094540000 } ], "create_order_time": 7651296412840616000, "certificate": [ { "fulfil_mode": 1, "combination_id": "EjH0bXIvpp", "order_item_id": "Gpxq9HfwRz", "item_status": 3250331015597759000, "refund_amount": 7831257644889517000, "certificate_id": "Vgf2a1GpCm", "item_update_time": 9191484482554506000, "refund_time": 5297667128785294000 } ], "order_type": 7632886850047791000, "reservation_gift": { "has_reserved_gift": false, "reserved_gift_quantity": "y1URfqOjjq", "reserved_gift_content": "Sm7fMZjq0a" }, "discount_amount": 1509972056080926700, "poi_id": "hHan0aZHrT", "sku_id": "nGbL41ddEc", "count": 4397626429485191700, "sku_name": "1BXlC4JJ3g", "receipt_amount": 7244781021599643000, "user_id": 7454755012285074000, "poi": { "url": "Ml3brfsbSG", "poi_id": "38JNb8BS5G", "poi_name": "fLTS2kznAv" }, "anchor_id": 8680180785568767000, "room_id": "N7Yob7bqpJ", "merchant_info": { "account_name": "LPuieOLj9v", "account_id": "Y7hECEn6uX" }, "amount_info": { "brand_discount_amount": 5408190969376289000, "deduct_amount": 2728517800012657000, "pay_amount": 3387902677239421000, "sale_price": 7755105173954875000, "pay_discount_amount": 5014239614916404000, "merchant_discount_amount": 5976672364398668000, "platform_deliver_freight_fee": 8329061002435814000, "provider_discount_amount": 5833739403613639000, "freight_pay_amount": 5397817102094594000, "commission_amount": 9080875727802356000, "activities_fee_amount": 5716157633701419000, "merchant_deliver_freight_fee": 2279364579812453400, "product_origin_amount": 8863993626265541000, "estimated_order_income": 586693472807679200, "deduct_info_list": [ { "source_sku_id": 984048731639621600, "order_source": 1, "source_certificate_id": "OujRT09FIu", "source_platform_discount_amount": 8292657540193996000, "source_brand_discount_amount": 6329531671338243000, "source_order_id": "knQKWZtSLv", "source_payment_discount_amount": 8570364593777851000, "source_product_name": "ToOD3HLXQm", "groupon_type": 1, "source_product_id": 4834150978150289000, "source_sku_name": "NA2HZQj3zY", "source_origin_amount": 1194099403005910800, "source_selling_price": 3664351520195913000, "voucher_type": 1, "source_pay_amount": 3779442484764754000, "source_merchant_discount_amount": 1679948424893368000, "source_provider_discount_amount": 4377197550034961400 } ], "platform_discount_amount": 5777283748468536000, "origin_amount": 1063352601876508300 }, "third_sku_id": "w7p0MV8121", "original_amount": 1461183607930359800, "buyer_info": { "buyer_phone": "Cwn3Xnvo3f", "buyer_secret_number": "PJoGBk45Us", "buyer_real_phone": "Pu1ra4pYLO" }, "delivery_info": { "user_expect_time": "2EKUF5R8xL", "sys_expect_time": "Ur0cqUeWbw", "remark": "Br9TndYR3o", "table_ware": "nkZmZwjkES", "deliver_model": 2554825819404837400, "shop_number": "wKyAD3GtvZ", "is_book": false }, "craftsman_uid": "6NEiHXNtIr", "open_id": "qQppagMX90", "pay_time": 786863685109254800, "source_order_id": "ZVVvReYk08", "order_sale_info": { "sale_channel": "suygj929fD", "transfer_nickName": "8A7Wote9sX", "transfer_uid": "NfxJobxX7N", "transfer_douyin_uid": "JkyYpJrweD", "order_source": 1, "sale_role": "iHgh0tEAva" }, "order_id": "G4AbBPmb7s", "pay_amount": 1108966414876351600, "intention_poi_id": "CQmVJCz9zb", "pay_bill_info": { "total_pay_amount": 5465246075705060000, "is_timely_pay_bill": false, "order_source": 1 }, "contacts": [ { "name": "QVeoPAlSQg", "phone": "cXiG9EhFCR", "phone_encrypt": "7aywKdlPhT" } ], "update_order_time": 4968315974509525000, "sub_order_amount_infos": [ { "sub_order_type": 3574767503858570000, "pay_amount": 3054891721127746000, "discount_amount": 888822465889266300, "receipt_amount": 8953263720971477000, "sub_order_id": "o8chomXLLc", "origin_amount": 2034435089042624000, "discounts": [ { "merchant_discount_amount": 3013321979225483300, "platform_discount_amount": 6364480414893185000, "provider_discount_amount": 6948276568399090000, "idle_time_info": { "WriteOffTimeLimit": { "DailyTimeRangeList": [ { "StartTime": "lqsUtP8VKo", "EndTime": "V1dKyl1u0V" } ], "RelativeTime": { "RelativeTime": 5058470793990737000, "RelativeTimeType": 1 }, "WeekDayList": [ 1 ], "WriteOffStartTime": 6744152141708723000, "WriteOffEndTime": 571722818425367040 }, "idle_time_limit_type": 1 }, "brand_discount_amount": 1415238721397879800, "discount_type": 4643859993698611000, "discount_amount": 1340012914741398800 } ], "combination_id": "Fk9DpoOECs" } ], "receiver_info": { "door_plate_num": "Jw6U0sIMNa", "receiver_name": "lsCQ0PxrIO", "secret_number": "pQw0xL1wYL", "receiver_phone": "z0SQn3Mnhp", "town": "EC7gYhJa7C", "lat": 0.5665882860317293, "district": "Go2S16K5yq", "location_name": "3brJiu2NkC", "city": "1U3eFplfIW", "receiver_real_phone": "I9joJjCgqS", "province": "9FBtyqh1B5", "location_address": "UCElW6jjdr", "lng": 0.8122691584659429 }, "products": [ { "snapshot_product": { "product_attr": { "voucher_par_type": 1, "dynamic_par_rule": { "dynamic_par_rule_item_list": [ { "deductible_amount": 7368060282941541000, "day_of_week": [ 1 ], "time_period": { "use_start_time": "AiPICsHPH4", "use_end_time": "gYtw3KWLLe", "end_time_is_next_day": false } } ], "dynamic_par_rule_desc": "rXWvDFuZnV", "dynamic_par_min_amount": 8355688843888622000, "dynamic_par_max_amount": 7227333733798538000 }, "show_channel": 1, "advance_purchase_struct": { "purchase_type": 1, "time_detail": [ { "time": 4757784035852012000, "time_type": 1 } ] }, "combo_package_verify_limit_struct": { "product_id_index": { "765696839658317259": 4498414577260742700 }, "type": 1 } }, "tag_info_list": [ { "TagName": "gG3k4Qrun9", "TagValue": "lNDUgDNYxg", "TagKey": "3K29rDGmu0" } ] }, "origin_amount": 4304282589431489500, "sku_id": "MqUUhLtLmS", "ext_product_id": "evmDxYgA61", "num": 903632252589914400, "third_sku_id": "woaixPc62l", "product_id": "QupMXXG5iW", "product_name": "AWEMoiFezm", "commodities": [ { "option_count": 8890249309873463000, "items": [ { "unit": "LX2dNue2XF", "count": 7739407156196311000, "sku_attr_list": [ { "attr_name": "DzVa7rFxwD", "num": 7921756203760752000 } ], "attr_list": [ "izMNXTeYtT" ], "desc": "LgWnPK0dRt", "price": 3847514194463815000, "name": "NWYpihiJ27", "item_tag": "0XkC1AcauE" } ], "group_name": "iXKISYXXhb", "total_count": 2245941981890522000 } ], "product_origin_amount": 566853303214397630 } ], "payment_discount": 7515477278767977000 } ], "page": { "page_num": 7070756161709339000, "page_size": 8564239444150543000, "total": 7891597048596831000 }, "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 | 已履约 | 该商品完成履约 | 系统 |
