订单查询
通过接口查询指定范围的订单列表及订单详情:
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/?update_order_end_time=1333544974080859720&page_size=5981403062673186913&create_order_end_time=7812410394215061549&update_order_start_time=2030815162346110228&order_status=605108039859085948&get_secret_number=false&open_id=Fvdo2zGetp&page_num=8790058726930365664&cursor=[xCRTkfabA0]&order_id=pVMIri75Ew&create_order_start_time=4322576243927987192&account_id=PHJCLXO1Xr&ext_order_id=5W1wiZ57Ht' \ --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": "2026100910413243CE1AA59574B0E59861", "now": 1791513695 }, "data": { "search_after": { "AllCursorValue": [ [ "tSwJoYLDfy" ] ], "Size": 2337129429586352600, "CursorValue": [ "ZL1A4yNQ0R" ] }, "orders": [ { "is_deliver_later": false, "amount_info": { "sale_price": 1860242786360270800, "origin_amount": 7762917704668782000, "estimated_order_income": 5092105308537110000, "deduct_info_list": [ { "order_source": 1, "source_selling_price": 1932895630302735000, "source_platform_discount_amount": 1130148287129492700, "voucher_type": 1, "source_pay_amount": 187866017051455800, "groupon_type": 1, "source_brand_discount_amount": 3024611596274477600, "source_product_name": "W3x2EKep9R", "source_product_id": 8586310022545486000, "source_certificate_id": "CeQhamtgm5", "source_origin_amount": 6190549742424288, "source_payment_discount_amount": 7867388517297572000, "source_order_id": "VQF1bjyTC7", "source_merchant_discount_amount": 2391407673535419000, "source_sku_name": "xULVVBhzwA", "source_provider_discount_amount": 8032440268210393000, "source_sku_id": 4169344948089047600 } ], "freight_pay_amount": 1240774882273726200, "pay_amount": 3403963208350576600, "pay_discount_amount": 3199666235615209000, "brand_discount_amount": 2223863312356212200, "platform_deliver_freight_fee": 7714038555995611000, "deduct_amount": 1685923767412384000, "merchant_discount_amount": 6598456409950585000, "provider_discount_amount": 3831796822533350000, "product_origin_amount": 3854657833257551400, "commission_amount": 8166680719386087000, "platform_discount_amount": 2907769356574330400, "activities_fee_amount": 408392523416683140, "merchant_deliver_freight_fee": 8437243739486687000 }, "craftsman_uid": "MahPG0u5qW", "order_id": "NS5dNt30jC", "update_order_time": 4670662723091862000, "buyer_reserve_info": [ { "credential_type": 4859571723891741000, "enc_credential_numb": "4xLlvkSfZQ", "enc_name": "YiYCzGKiIC" } ], "pay_amount": 4284903721527306000, "products": [ { "ext_product_id": "lLVlxs71Q3", "third_sku_id": "9740pEfDzN", "snapshot_product": { "product_attr": { "dynamic_par_rule": { "dynamic_par_min_amount": 3261970179211777000, "dynamic_par_max_amount": 1764966150536052500, "dynamic_par_rule_item_list": [ { "time_period": { "use_end_time": "8QwRQer753", "end_time_is_next_day": false, "use_start_time": "by1MjF8DrG" }, "deductible_amount": 5152104339795746000, "day_of_week": [ 1 ] } ], "dynamic_par_rule_desc": "Iq1MaO6ft8" }, "show_channel": 1, "advance_purchase_struct": { "purchase_type": 1, "time_detail": [ { "time": 1236023087772874200, "time_type": 1 } ] }, "combo_package_verify_limit_struct": { "type": 1, "product_id_index": { "2482841927301611068": 8679622317933947000 } }, "voucher_par_type": 1 }, "tag_info_list": [ { "TagName": "l0LUEK6fD9", "TagValue": "kGdg8IWaiw", "TagKey": "WtxG1eEXpJ" } ] }, "sku_id": "7SukEcWWfa", "origin_amount": 7080027495815123000, "num": 1508982995425628000, "product_name": "c0oF7mgR2q", "commodities": [ { "option_count": 7988029395152423000, "items": [ { "name": "AGV1SG0sUE", "attr_list": [ "Ke2gNXMI1d" ], "item_tag": "FKRQzlntOe", "unit": "gpvOOgjPDC", "desc": "SKxLd5PtAi", "sku_attr_list": [ { "attr_name": "ajSEiugaAs", "num": 945081478190225000 } ], "count": 1628136016735643600, "price": 7201308891253133000 } ], "group_name": "yL3ANLT0uP", "total_count": 1270355833749387800 } ], "product_origin_amount": 9123996494664908000, "product_id": "GnM8iJB7Pp", "sku_sale_specs": [ { "spec_name": "e5stm7nLIA", "spec_value": "OuXUy988ef" } ] } ], "third_sku_id": "Hxfg1re1kK", "original_amount": 43290217377841610, "user_id": 2653574763845178400, "performance_ticket_info": { "ticket_type": 5344610438350098000, "show_time": 8676363084425046000, "ticket_area": "hYKX222JEq", "entry_type": 1589412987906643500 }, "pay_time": 6729391814721658000, "create_order_time": 7102626301918301000, "order_type": 5924299428011824000, "room_id": "O2ZtWph3Ic", "order_status": 7195274545177517000, "discounts": [ { "platform_discount_amount": 7216078854115324000, "provider_discount_amount": 691872581555154400, "idle_time_info": { "idle_time_limit_type": 1, "WriteOffTimeLimit": { "WriteOffEndTime": 5433307233241523000, "DailyTimeRangeList": [ { "EndTime": "G0WRTFhy7Z", "StartTime": "jYJppNVvJo" } ], "RelativeTime": { "RelativeTime": 8018384341366605000, "RelativeTimeType": 1 }, "WeekDayList": [ 1 ], "WriteOffStartTime": 2597594306903041000 } }, "brand_discount_amount": 9165033604387665000, "discount_type": 5560705071161532000, "discount_amount": 4975482954483113000, "merchant_discount_amount": 192669554829493220 } ], "contacts": [ { "phone_encrypt": "fRnJQt5hLs", "name": "G60S08VkvM", "phone": "8tMK9zt6cN" } ], "receiver_info": { "secret_number": "Nzt0leD4yA", "district": "c2YJyrwnkS", "lng": 0.43969531030737, "receiver_real_phone": "wwFjZgZ4k5", "town": "dit32ah9WB", "location_address": "8Mu8rMXi6A", "receiver_name": "lMHpDZcFU2", "door_plate_num": "zpI1loqIfk", "receiver_phone": "lpN6OvBecB", "city": "jsdwpRdvR0", "location_name": "jMNgJO2YfE", "lat": 0.35829629221115405, "province": "H1T3iUlPtN" }, "count": 4250783703956817000, "sku_name": "f2lyTqseBa", "poi_id": "G8Qjg3ph0V", "reservation_gift": { "reserved_gift_quantity": "LdKVn35yg6", "reserved_gift_content": "iNmpC3sAoN", "has_reserved_gift": false }, "receipt_amount": 6787979743356084000, "delivery_info": { "table_ware": "ByHdIjrLdU", "deliver_model": 4884532264981152000, "shop_number": "h1zqgpzHQ6", "is_book": false, "user_expect_time": "2gE88Ems3v", "sys_expect_time": "px5OrL6L6v", "remark": "4l4bRWOb2M" }, "payment_discount": 5046202789449836000, "sub_order_amount_infos": [ { "combination_id": "O53MPhNX6u", "receipt_amount": 4344265180265653000, "origin_amount": 6655209779285489000, "sub_order_type": 333042820498690200, "pay_amount": 8671008556213328000, "discounts": [ { "brand_discount_amount": 6584187872503672000, "discount_type": 8795205206408728000, "discount_amount": 6528443784016131000, "merchant_discount_amount": 7186449215658851000, "platform_discount_amount": 3097307734435318300, "provider_discount_amount": 346247479149435140, "idle_time_info": { "WriteOffTimeLimit": { "WeekDayList": [ 1 ], "WriteOffStartTime": 4353427451686210600, "WriteOffEndTime": 1098870242346077200, "DailyTimeRangeList": [ { "StartTime": "S82hEPUGqn", "EndTime": "2mjRkBAlKM" } ], "RelativeTime": { "RelativeTimeType": 1, "RelativeTime": 8149622914267564000 } }, "idle_time_limit_type": 1 } } ], "sub_order_id": "oXqRpLb58h", "discount_amount": 3177456591468005400 } ], "discount_amount": 3989231816969892400, "pay_bill_info": { "total_pay_amount": 2030992019658425900, "is_timely_pay_bill": false, "order_source": 1 }, "buyer_info": { "buyer_secret_number": "Irnvbh2afn", "buyer_real_phone": "yqK9FNB4xw", "buyer_phone": "gevOvvBi6k" }, "sku_id": "rH8Z1dWyCA", "anchor_id": 6515954086379549000, "open_id": "DkcccBX0zt", "source_order_id": "7KetRF2Iu3", "certificate": [ { "fulfil_mode": 1, "combination_id": "hSchIHkR0Z", "item_status": 7824623484538124000, "order_item_id": "wFGpiO9gg6", "refund_time": 5272136777301550000, "certificate_id": "DwBsnBmjnZ", "item_update_time": 5824093629180466000, "refund_amount": 5545717608180359000 } ], "merchant_info": { "account_id": "SAqczWBBSx", "account_name": "FdnRvDaU9E" }, "intention_poi_id": "YHQUAxHjqu", "poi": { "url": "qBLLvn3Aa6", "poi_id": "gMTvW1s2mt", "poi_name": "GJk9iQQXsC" }, "order_sale_info": { "order_source": 1, "sale_role": "PzbTtkTLyU", "sale_channel": "hHCPwBLAOl", "transfer_nickName": "oHTsW28Voz", "transfer_uid": "fRYTc1KdMp", "transfer_douyin_uid": "gfJDnCKGht" } } ], "page": { "page_size": 2747331752185226000, "total": 226258941411402200, "page_num": 664764559689884800 }, "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 | 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 | 已履约 | 该商品完成履约 | 系统 |
