订单查询
通过接口查询指定范围的订单列表及订单详情:
1、查询指定状态的订单列表,用于对账或差异单最新状态确认;
2、查询指定用户的订单列表,用于积分计算、订单展示;
3、查询指定订单详情,用于接口补偿处理。
开票说明
尊敬的商家,依据税务规则与《抖音生活服务平台商户合作协议》的约定,如用户向商家申请开具发票,商家应按照用户实际支付金额向用户开具相应金额的发票。用户的实际支付金额可参考订单查询pay amount字段展示的具体金额(用户实际支付金额,不含平台等其他方补贴的金额)。
针对平台补贴需向平台开具增值税发票,请勿开具给用户。若商家向用户超额开具发票,由此导致的损失及税务风险需由商家自行承担
接口 SLA
指标 | 数值 |
可承载最大qps | 500 |
响应耗时pct99 | 1s |
服务目标可用性 | 99.9% |
接口说明
- 服务商通过接口查询订单详情,支持三种查询方式:
- 根据订单 ID 或第三方订单号,查询对应订单详情,入参:订单 ID/第三方订单号、商户 id;
- 根据订单状态和商户 id,查询指定时间内该商户下的订单列表,入参:商户 id、订单状态、创单起止时间/修改起止时间;
- 根据用户 id 和商户 id,查询某用户在该商户下的所有订单,入参:商户 id、用户 id、创单起止时间/修改起止时间;
- 支付后未发码/发码失败订单查询方式:限定订单状态为“已支付”,如用户下单后超过 10 分钟未发码会发起退款;
- 退款申请待审核订单查询方式:限定券状态为“退款中”,如退款状态未响应超过 72 小时会自动退款。
基本信息
名称 | 描述 |
---|---|
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/?ext_order_id=gyovMHsfkF&cursor=[xXiDBIeskT]&create_order_end_time=3960430251346322268&get_secret_number=false&order_status=8979515929471061603&create_order_start_time=4690115795190652697&account_id=4x6dI22EzH&update_order_end_time=6220769854646867387&open_id=O1NCYJYtXD&update_order_start_time=7744945620872343060&page_num=333646378720750757&page_size=6034790347547385527&order_id=u8hz3RZrIm' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \
响应参数
Body展开全部子属性
extra必填Struct
扩展信息
展开子属性
dataStruct
数据列表
展开子属性
响应示例
正常响应示例异常响应示例
{ "data": { "orders": [ { "create_order_time": 7062736427808083000, "intention_poi_id": "pn5nYD4ypH", "room_id": "noAKdOER0A", "merchant_info": { "account_name": "hqdiU7K6qx", "account_id": "mdAkJQxyh0" }, "buyer_info": { "buyer_real_phone": "tZxW0putDR", "buyer_phone": "4yCSRR5vkL", "buyer_secret_number": "pVi1kzbmSe" }, "order_id": "lg2KnKf1IW", "receipt_amount": 3055616876670936600, "is_deliver_later": false, "source_order_id": "YXxINJjwsH", "poi": { "poi_name": "5vdn877T2j", "url": "iQg0nrKPhT", "poi_id": "s9watrMgIy" }, "discount_amount": 8735272806101988000, "contacts": [ { "phone": "ackqAmzXUO", "phone_encrypt": "SIdXfCCy5x", "name": "s4kTOK7QJH" } ], "sku_id": "oRNbGwFt3A", "original_amount": 4692440724036898000, "user_id": 7307967504807289000, "craftsman_uid": "ijTcppnoal", "payment_discount": 2225181250636914200, "order_type": 1084507043715570200, "products": [ { "sku_id": "Jo9TcFMw8V", "product_name": "GowYeh3NNz", "commodities": [ { "group_name": "nkh3bLytWQ", "total_count": 5002999468774259000, "option_count": 619414318287086200, "items": [ { "sku_attr_list": [ { "attr_name": "OzLfyiGZsg", "num": 2047703867134981600 } ], "name": "KgJHDy7Wec", "price": 7863370256925154000, "count": 6785773581562758000, "unit": "oU9PgF178B", "desc": "gLSdjloLMe", "item_tag": "nz4AKetHfy", "attr_list": [ "2oI6IukfXs" ] } ] } ], "num": 8835720546827626000, "product_id": "5hP0ZhW83m", "snapshot_product": { "product_attr": { "dynamic_par_rule": { "dynamic_par_max_amount": 1509531421748087000, "dynamic_par_rule_item_list": [ { "day_of_week": [ 1 ], "time_period": { "use_start_time": "r3LJ4XPF1W", "use_end_time": "rE3ebOAKe4", "end_time_is_next_day": false }, "deductible_amount": 5553675168676766000 } ], "dynamic_par_rule_desc": "qCQC43I12Y", "dynamic_par_min_amount": 192900782106452960 }, "show_channel": 1, "advance_purchase_struct": { "purchase_type": 1, "time_detail": [ { "time": 5297342975361604000, "time_type": 1 } ] }, "voucher_par_type": 1 }, "tag_info_list": [ { "TagValue": "hcM2dPIcu2", "TagKey": "uFLpahcVXY", "TagName": "HLlc1d1ewb" } ] }, "ext_product_id": "65LCADqMUN", "origin_amount": 7654407098275390000, "product_origin_amount": 3979756782019742000 } ], "anchor_id": 7423507164755454000, "receiver_info": { "receiver_phone": "5rWXB4IKOt", "door_plate_num": "YDJXrFKxAo", "lng": 0.5098056014794896, "lat": 0.5111916898342618, "town": "u8D1UcxgnW", "location_name": "qa7zF2rsko", "receiver_real_phone": "32U8Nv6uxV", "location_address": "6z1CcpZdi3", "secret_number": "RbkycrTSVd", "city": "8kDffX7hTq", "receiver_name": "IFs1e2G67u", "district": "BNqOxGvbsb", "province": "38tscXzZjJ" }, "third_sku_id": "3sKTvcaTPQ", "sub_order_amount_infos": [ { "combination_id": "RKbseIT79r", "sub_order_type": 3789875989480677000, "sub_order_id": "7RDXXCDKfz", "pay_amount": 203783486828959420, "origin_amount": 7807125350162708000, "discount_amount": 8518844800203679000, "discounts": [ { "merchant_discount_amount": 369222664265686300, "platform_discount_amount": 8740113930989568000, "provider_discount_amount": 3099247293284350500, "idle_time_info": { "WriteOffTimeLimit": { "DailyTimeRangeList": [ { "StartTime": "IxZLtvwVrT", "EndTime": "vRCfBdQ95p" } ], "RelativeTime": { "RelativeTimeType": 1, "RelativeTime": 1334261759943700700 }, "WeekDayList": [ 1 ], "WriteOffStartTime": 4698013761003832000, "WriteOffEndTime": 2113121097491341600 }, "idle_time_limit_type": 1 }, "brand_discount_amount": 3181192850881671700, "discount_type": 3783311181126347300, "discount_amount": 7295256870876057000 } ], "receipt_amount": 8420863214526576000 } ], "order_status": 8743919313066257000, "count": 8512073742410212000, "poi_id": "ZfUl9VQmU1", "open_id": "BEogmwz9uT", "update_order_time": 5141127020129570000, "certificate": [ { "item_update_time": 5068575304667810000, "refund_amount": 8234214111176509000, "refund_time": 6548677825899623000, "combination_id": "4ukIDu6MSP", "fulfil_mode": 1, "order_item_id": "GoHhoEuqUO", "certificate_id": "SNa4Cl6cyb", "item_status": 9091666108065930000 } ], "delivery_info": { "sys_expect_time": "29EkycI1Nj", "remark": "Zo1h94t6HO", "table_ware": "DjPjnnGN3B", "deliver_model": 6117014318387909000, "shop_number": "V1aFv3T2Pa", "is_book": false, "user_expect_time": "aWGZG1a6NQ" }, "sku_name": "rDFPMamhXk", "pay_amount": 1602359123282186200, "discounts": [ { "provider_discount_amount": 8774535241555235000, "idle_time_info": { "WriteOffTimeLimit": { "RelativeTime": { "RelativeTimeType": 1, "RelativeTime": 6769595305839483000 }, "WeekDayList": [ 1 ], "WriteOffStartTime": 4561222852346312000, "WriteOffEndTime": 7102010371248019000, "DailyTimeRangeList": [ { "EndTime": "L1Y2aaizRc", "StartTime": "CuGb6rxI5I" } ] }, "idle_time_limit_type": 1 }, "brand_discount_amount": 4117479800695081000, "discount_type": 3267215438090233300, "discount_amount": 1280797887918568200, "merchant_discount_amount": 815621015795789700, "platform_discount_amount": 4700028866409967000 } ], "pay_time": 467832706739693200, "amount_info": { "commission_amount": 2690941036154813000, "estimated_order_income": 8445928239496434000, "provider_discount_amount": 8871915915359070000, "brand_discount_amount": 1119574347423990300, "pay_discount_amount": 4633863483985389000, "freight_pay_amount": 6978479891060270000, "platform_deliver_freight_fee": 9023213496489872000, "merchant_discount_amount": 7098694387534915000, "sale_price": 4488575687722717700, "pay_amount": 6081689996513783000, "origin_amount": 1146223704205350800, "deduct_info_list": [ { "source_product_id": 865880178292365200, "source_certificate_id": "73sN3dk1js", "voucher_type": 1, "source_pay_amount": 6190212926498433000, "source_sku_name": "45LMZwRuQ2", "source_product_name": "M6VJ0HjPFr", "source_origin_amount": 2070215422156627200, "source_merchant_discount_amount": 4293647589504186000, "source_sku_id": 885869470201631000, "source_order_id": "G6WffeoC5O", "groupon_type": 1 } ], "activities_fee_amount": 1601500793380056300, "merchant_deliver_freight_fee": 7255076605089904000, "product_origin_amount": 1668920717315256300, "platform_discount_amount": 3772648866079589000, "deduct_amount": 2031601040761161200 } } ], "page": { "page_num": 4347968734000553500, "page_size": 6633656117152001000, "total": 2548033530148701700 }, "search_after": { "CursorValue": [ "2aBcXnkSVE" ], "AllCursorValue": [ [ "MjUle3z9I7" ] ], "Size": 8643218365645448000 }, "error_code": 0, "description": "" }, "extra": { "error_code": 0, "description": "", "sub_error_code": 0, "sub_description": "", "logid": "20250902220340DCBDA96D992468C4764C", "now": 1756821827 } }
错误码
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 | 已履约 | 该商品完成履约 | 系统 |