餐饮团购-订单查询
通过接口查询指定范围的订单列表及订单详情:
- 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% |
使用限制
SLA:支持的最大QPS:100;
基本信息
| 名称 | 描述 |
|---|---|
| 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"
Rpc-Transit-Life-AccountString
来客商户根账户ID
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,数组格式["111","222"];如果传入此参数,会优先使用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 'https://open.douyin.com/goodlife/v1/akte/order/query/?update_order_end_time=6058018847834339116&update_order_start_time=4955268319139179664&ext_order_id=f4bvT8Csjf&order_status=2267242938017496194&page_num=7512872034638353222&account_id=uYG1CapP7l&create_order_end_time=479001515308563308&page_size=1329762211570593421&cursor=[VSPaN5vyYx]&create_order_start_time=5054521298417974701&order_id=1tW5Ii5asp&open_id=yapj7Qwtwo' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \
响应参数
Body展开全部子属性
extra必填Struct
扩展信息
展开子属性
dataStruct
展开子属性
响应示例
正常响应示例异常响应示例
{ "data": { "page": { "page_num": 7261626449888078000, "page_size": 3757344773111455000, "total": 4756464371601809000 }, "search_after": { "all_cursor": [ [ "9aprWCi6tC" ] ], "size": 5856017792539425000, "cursor": [ "5NJp3gEpo7" ] }, "orders": [ { "order_type": 900702814114456000, "open_id": "Pji3hMQfSn", "merchant_info": { "account_id": "lOWivcNqoM", "account_name": "16X9LhaDLI" }, "certificate": [ { "combination_id": "FGBwPXlWuP", "sub_sku_id": "KjbqK7xCi7", "item_status": 2916269630547194000, "item_update_time": 7576028675615463000, "origin_certificate_id": "HwcBrSOGZo", "refund_time": 1800333899354418400, "order_item_id": "fDHO8thvEN", "refund_amount": 8658852891391045000, "sku_id": "gt736Ui71p", "is_donated_item": false, "certificate_id": "jyjOJfvXxq" } ], "sub_order_amount_infos": [ { "sub_order_id": "zgI6Sdiou2", "origin_amount": 3705536035930010000, "sub_coupon_pay_amount": 7117170548627532000, "sub_sku_id": "OkAQ6Jk4EH", "sub_order_type": 4965511203101373000, "discounts": [ { "discount_amount": 2929291165852012500, "merchant_discount_amount": 267357707927810980, "platform_discount_amount": 8976092452996624000, "discount_extra": { "idle_time_discount_info": { "week_day_list": [ 1 ], "idle_time_limit_type": 1, "discount_start_time": 490507924201427140, "discount_end_time": 6031708925184632000, "daily_time_range": [ { "start_time": "6Z1qoOXqXy", "end_time": "7xqEOhnT4P" } ] } }, "brand_discount_amount": 8910217654736637000, "discount_type": 7871463048054567000 } ], "combination_id": "44o6o7cmLT", "pay_amount": 6159937881472488000, "sku_id": "uUWR9btmaX", "discount_amount": 7261994228153038000 } ], "pay_time": 7057463191042089000, "contacts": [ { "name": "nASK93K8GS", "phone": "F0ry6cP5yU", "phone_encrypt": "Yb6E63II1r" } ], "discounts": [ { "discount_type": 5688876348434074000, "discount_amount": 6738290730447118000, "merchant_discount_amount": 2292296011838513400, "platform_discount_amount": 7293039146870984000, "discount_extra": { "idle_time_discount_info": { "week_day_list": [ 1 ], "idle_time_limit_type": 1, "discount_start_time": 7514965842889420000, "discount_end_time": 8967845800609676000, "daily_time_range": [ { "start_time": "fhd6ACgrEO", "end_time": "b5sE8BTHuJ" } ] } }, "brand_discount_amount": 8242535862535725000 } ], "order_status": 4794616261688727000, "order_id": "auBJnzBws1", "create_order_time": 5287691539940371000, "attribute_info": { "anchor_id": 6940384835684573000, "room_id": 7799935894045900000 }, "original_amount": 6569946544270476000, "has_donated_items": false, "update_order_time": 1431177723081134600, "order_sale_info": { "sale_role": "qQrzBupSwx", "sale_channel": "Pzb6JBmzIF", "transfer_nickName": "IuC8hyZ0nR", "transfer_uid": "693nmKauqT" }, "poi": { "poi_id": "c6UjPwwg9d", "poi_name": "uQ12DayeqX", "intention_poi_id": "WuKjZixr10", "intention_poi_name": "PLNIEWYtM6" }, "goods": [ { "count": 2476266969631447600, "goods_detail": { "sku_attr": { "KOWdy1l2an": "Z605chQDS5" }, "product_type": 46393967853474910, "product_attr": { "DS5johq9ug": "7JUY7y8gwh" }, "show_channel": 9161759321824114000, "goods_attr": { "voucher_par_type": 1, "dynamic_par_rule": { "dynamic_par_rule_item_list": [ { "day_of_week": [ 1 ], "time_period": { "use_start_time": "Xy3uHpSpea", "use_end_time": "SALARiAmnY", "end_time_is_next_day": false }, "deductible_amount": 3037096506334668300 } ], "dynamic_par_rule_desc": "eCCk3LFTj0", "dynamic_par_min_amount": 756004778512529900, "dynamic_par_max_amount": 7307238696589828000 } } }, "sku_id": "DJepBiQe3r", "sku_name": "wdllVh6KAM", "third_sku_id": "rz0rS1fGTV" } ], "amount_info": { "platform_discount_amount": 8775907973307502000, "order_pay_amount": 7217484167054312000, "brand_discount_amount": 8280442038349693000, "pay_amount": 4938822811407089000, "origin_amount": 2739155104816639000, "pay_discount_amount": 6057697209514056000, "merchant_discount_amount": 3819560870131272700 }, "discount_amount": 2333940399422533000, "order_pay_amount": 2523970851129394000, "pay_amount": 8062193286945336000, "payment_discount": 262036811915351000 } ], "error_code": 0, "description": "" }, "extra": { "error_code": 0, "description": "", "sub_error_code": 0, "sub_description": "", "logid": "20260204103945FE55182A46FD2BC4080F", "now": 1770172788 } }
错误码
| 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 | 待使用 | 该商品未发生预约、预订失败回滚 | 系统 |
300 | 退款中 | 发起退款流程 | 用户/商户/系统/客服 |
301 | 已退款 | 退款成功 | 系统 |
400 | 履约中 | 已到履约时间,订单开始履约 | 系统 |
401 | 已履约 | 该商品完成履约 | 系统 |
