餐饮团购-订单查询
通过接口查询指定范围的订单列表及订单详情:
- 1.查询指定条件订单列表,用于对账或订单展示;
- 2.查询指定订单详情,用于接口补偿处理。
接口 SLA
指标 | 数值 |
可承载最大qps | 100 |
响应耗时pct99 | 1s |
服务目标可用性 | 99.9% |
接口说明
- 通过接口查询订单详情,支持三种查询方式:
- 根据订单 ID 或第三方订单号和商户id,查询对应订单详情,入参:订单 ID/第三方订单号、商户 id;
- 根据订单状态和商户 id,查询指定时间内该商户下的订单列表,入参:商户 id、订单状态、创单起止时间/修改起止时间;
- 根据用户 id 和商户 id,查询某用户在该商户下的所有订单,入参:商户 id、用户 id、创单起止时间/修改起止时间;
- 支付后未发码/发码失败订单查询方式:限定订单状态为“已支付”,如用户下单后超过 10 分钟未发码会发起退款;
- 退款申请待审核订单查询方式:限定券状态为“退款中”,如退款状态未响应超过 72 小时会自动退款。
指标 | 数值 |
可承载最大qps | 100 |
响应耗时pct99 | 1s |
服务目标可用性 | 99.9% |
基本信息
名称 | 描述 |
---|---|
HTTP URL | https://open.douyin.com/goodlife/v1/akte/order/query/ |
HTTP Method | GET |
Scope | life.capacity.order.query |
权限要求 | 订单查询
|
请求参数
请求头
access-token必填String
示例:clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-type必填String
固定值"application/json"
Query
account_id必填String
来客商户根账户ID
page_num必填Int32
第几页(首页传1)
page_size必填Int32
页大小,取值范围1~100
create_order_end_timeInt64
创单结束时间(秒时间戳,创单起止时间必须同时传入)
create_order_start_timeInt64
创单起始时间 (秒时间戳,创单起止时间必须同时传入)
cursorArray<String>
根据游标滚动请求,直到返回结果数量小于请求的size或未返回search_after结束;首页传0,第二页翻页传首页返回的cursor,数组格式["0","1"];如果传入此参数,会优先使用cursor翻页,而不是page翻页
ext_order_idString
开发者系统中的订单号
open_idString
抖音用户id
order_idString
抖音生活服务订单ID
见抖音-团购频道-订单详情
order_statusInt32
订单状态
update_order_end_timeInt64
修改起始时间(秒时间戳,修改起止时间必须同时传入)
update_order_start_timeInt64
修改起始时间 (秒时间戳,修改起止时间必须同时传入)
请求示例
curl --location --request GET '/goodlife/v1/akte/order/query/?cursor=[zkQltRXLcP]&order_id=55PpBD6kWv&create_order_start_time=5585284864617573344&create_order_end_time=7891128849951174601&update_order_start_time=7029241511296835200&page_size=1577235092237898195&ext_order_id=oE86O8uNuq&open_id=5nT6gmauQx&order_status=5376938394379960006&update_order_end_time=2433283684113185236&page_num=571889612207534994&account_id=yxYWj5RLuT' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \
响应参数
Body展开全部子属性
dataStruct
展开子属性
extraStruct
展开子属性
响应示例
正常响应示例异常响应示例
{ "data": { "orders": [ { "amount_info": { "brand_discount_amount": 5818096517179290000, "merchant_discount_amount": 7962066369333283000, "order_pay_amount": 5045584830146524000, "origin_amount": 8238212399607115000, "pay_amount": 458189950884581400, "pay_discount_amount": 4800955944073719000, "platform_discount_amount": 4251431319287092000 }, "attribute_info": { "anchor_id": 6182583454285356000, "room_id": 7303054450260554000 }, "certificate": [ { "certificate_id": "CPturnMaE5", "combination_id": "B4wlLeap0n", "is_donated_item": false, "item_status": 1179946200968287000, "item_update_time": 6664997604629816000, "order_item_id": "Bb7r4oxbXq", "origin_certificate_id": "bFcOsq11JA", "refund_amount": 3692686333158494700, "refund_time": 5582195998520268000, "sku_id": "z6w6ndvnU3", "sub_sku_id": "eCMd5Uu63W" } ], "contacts": [ { "name": "bmPd8fdfoS", "phone": "d3oSBuIe2e", "phone_encrypt": "78UKjNJ8L6" } ], "create_order_time": 4750975708992667000, "discount_amount": 6367054437209883000, "discounts": [ { "brand_discount_amount": 6104638598379392000, "discount_amount": 1001416977183887600, "discount_extra": { "idle_time_discount_info": { "daily_time_range": [ { "end_time": "tg0KtVvbX7", "start_time": "4vC0z1csvh" } ], "discount_end_time": 1084811338943855400, "discount_start_time": 745399546995958500, "idle_time_limit_type": 1, "week_day_list": [ 1 ] } }, "discount_type": 5085850601215001000, "merchant_discount_amount": 4386359434038684000, "platform_discount_amount": 3328706567170773500 } ], "goods": [ { "count": 2283719663956363800, "goods_detail": { "goods_attr": { "dynamic_par_rule": { "dynamic_par_max_amount": 6904724324283237000, "dynamic_par_min_amount": 4573971962870504000, "dynamic_par_rule_desc": "VQyUJCwbPB", "dynamic_par_rule_item_list": [ { "day_of_week": [ 1 ], "deductible_amount": 6265711523188197000, "time_period": { "end_time_is_next_day": false, "use_end_time": "ibVEAz7IiP", "use_start_time": "dwBzVs59Q9" } } ] }, "voucher_par_type": 1 }, "product_attr": { "lf6_krr_z3_bs": "xAOryFPGoh" }, "product_type": 5543187969186266000, "show_channel": 1617342170627022300, "sku_attr": { "t_w8y_pm_tur_f": "LAAd8j6pPh" } }, "sku_id": "rQS7ip1xh9", "sku_name": "auePZ6XXtG", "third_sku_id": "cE91WKnkn1" } ], "has_donated_items": false, "merchant_info": { "account_id": "dFtR6fsuI9", "account_name": "ZzaR9PJLEV" }, "open_id": "yALqpX1QKq", "order_id": "TypVYaef1W", "order_pay_amount": 3852815526877752300, "order_status": 170758703383531400, "order_type": 978191030554753700, "original_amount": 7671806993277836000, "pay_amount": 3024839622541958700, "pay_time": 3252098086363859500, "payment_discount": 8070111677719076000, "poi": { "intention_poi_id": "Fl8pPYxZ51", "intention_poi_name": "RO3hFReoZ6", "poi_id": "K8Fv93ACju", "poi_name": "JV2nI77hmz" }, "sub_order_amount_infos": [ { "combination_id": "t3sm4iWE6C", "discount_amount": 2011652794246625000, "discounts": [ { "brand_discount_amount": 4152722259117295000, "discount_amount": 826523283275021600, "discount_extra": { "idle_time_discount_info": { "daily_time_range": [ { "end_time": "KeICI45oeG", "start_time": "YLOEiaTSCT" } ], "discount_end_time": 5750678773746475000, "discount_start_time": 1715789344042427600, "idle_time_limit_type": 1, "week_day_list": [ 1 ] } }, "discount_type": 2241241597947085800, "merchant_discount_amount": 8380632913670639000, "platform_discount_amount": 3619173313724148000 } ], "origin_amount": 8387292381183491000, "pay_amount": 4834227449733761000, "sku_id": "Hevu8i9cLD", "sub_coupon_pay_amount": 8210504143706765000, "sub_order_id": "cVXD2RozCS", "sub_order_type": 7036739717063556000, "sub_sku_id": "dMsi3KqJVf" } ], "update_order_time": 8562012086206785000 } ], "page": { "page_num": 6374152339339429000, "page_size": 6418998022660143000, "total": 1114883913961559200 }, "search_after": { "all_cursor": [ [ "LUx8GuG4Sy" ] ], "cursor": [ "xLBl7YlF5t" ], "size": 5661008819309727000 }, "error_code": 0, "description": "" }, "extra": { "error_code": 0, "description": "", "sub_error_code": 0, "sub_description": "", "logid": "202411291221342EAE924E87ADE3F22509", "now": 1732854094 } }
错误码
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 | 待使用 | 该商品未发生预约、预订失败回滚 | 系统 |
300 | 退款中 | 发起退款流程 | 用户/商户/系统/客服 |
301 | 已退款 | 退款成功 | 系统 |
400 | 履约中 | 已到履约时间, 订单开始履约 | 系统 |
401 | 已履约 | 该商品完成履约 | 系统 |