餐饮团购-订单查询
通过接口查询指定范围的订单列表及订单详情:
- 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=6851842349098056144&account_id=KPsWBlVK60&create_order_start_time=6160927040598967465&order_status=5598397946683747175&update_order_start_time=5802002554324567694&order_id=OHdLT0pDF5&create_order_end_time=6890971019556563993&open_id=4vU98NUZLe&page_size=5273592753365017406&page_num=2141860765083333145&cursor=[0oPpu0uEP3]&ext_order_id=pMXbTXHHP3' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \
响应参数
Body展开全部子属性
extra必填Struct
扩展信息
展开子属性
dataStruct
展开子属性
响应示例
正常响应示例异常响应示例
{ "data": { "page": { "page_size": 4157374814901897000, "total": 2326448153920169500, "page_num": 6409374628676909000 }, "search_after": { "all_cursor": [ [ "UMeoyY38gU" ] ], "size": 6114363648315649000, "cursor": [ "gBH4laeLvN" ] }, "orders": [ { "certificate": [ { "combination_id": "hzkzMVR1mI", "origin_certificate_id": "UzzoqLvVSt", "order_item_id": "EqamYcE1Q8", "item_status": 427454142560128800, "sku_id": "Fpd8fQHI0R", "sub_sku_id": "5vW5untZSf", "item_update_time": 6094415834101025000, "refund_amount": 5053379799180770000, "is_donated_item": false, "certificate_id": "Q4KoBYsFRa", "refund_time": 4594886807561263600 } ], "order_pay_amount": 5164654956279549000, "order_sale_info": { "transfer_douyin_uid": "PD25ZO2FlY", "sale_role": "cMozCqGOhx", "sale_channel": "uTHQazNuh1", "transfer_nickName": "y7695oiVRk", "transfer_uid": "j5bsfvEq81" }, "order_type": 4709350754253524000, "goods": [ { "third_sku_id": "8QyqqJQghp", "count": 2959941084162611700, "goods_detail": { "product_type": 2400064879359952000, "product_attr": { "UzJJok11ay": "DYv4Os9Kok" }, "show_channel": 8495826594209717000, "goods_attr": { "dynamic_par_rule": { "dynamic_par_max_amount": 487192585724791400, "dynamic_par_rule_item_list": [ { "time_period": { "use_start_time": "Oe7RBbN8qs", "use_end_time": "2NnuZ9AxU5", "end_time_is_next_day": false }, "deductible_amount": 5148287571295571000, "day_of_week": [ 1 ] } ], "dynamic_par_rule_desc": "TEHIrVoWGe", "dynamic_par_min_amount": 7336583254005580000 }, "voucher_par_type": 1 }, "sku_attr": { "s8KulKbSNm": "c4UJwZKq49" } }, "sku_id": "dcUsYlE5pa", "sku_name": "7t7hjSPHMP" } ], "attribute_info": { "room_id": 4429213191866797000, "anchor_id": 6496874785552539000 }, "update_order_time": 3248260046494284000, "contacts": [ { "name": "hB5gwkqZ3u", "phone": "9Z8PaWluwj", "phone_encrypt": "IcCMaWWsoJ" } ], "pay_time": 3653844287604215300, "original_amount": 708937259221593600, "sub_order_amount_infos": [ { "pay_amount": 6333347448830551000, "combination_id": "JKG0PQNlrx", "origin_amount": 4889513052221879000, "discounts": [ { "merchant_discount_amount": 6133702660757052000, "platform_discount_amount": 5992699897835314000, "discount_extra": { "idle_time_discount_info": { "daily_time_range": [ { "start_time": "GCWFAIYVtc", "end_time": "2EIG3GND1o" } ], "week_day_list": [ 1 ], "idle_time_limit_type": 1, "discount_start_time": 1310984693095267800, "discount_end_time": 9183186979806732000 } }, "brand_discount_amount": 6583058957297351000, "discount_type": 3034205335470822000, "discount_amount": 5544624354704195000 } ], "sku_id": "FjF0XbJU2F", "sub_coupon_pay_amount": 5845308272923971000, "sub_order_type": 5573400153372165000, "sub_order_id": "9WD1Sox8Tf", "sub_sku_id": "1PEhJJxgph", "discount_amount": 4544382023405044000 } ], "has_donated_items": false, "poi": { "poi_id": "AVM2fccK9J", "poi_name": "XvZkuKfsBl", "intention_poi_id": "b8mii5bVhY", "intention_poi_name": "l7oPvUL1gE" }, "payment_discount": 6807634042650338000, "order_status": 4630575410917919000, "order_id": "B0AXpFhKRH", "create_order_time": 304792770471603300, "merchant_info": { "account_id": "HO2QYdCSO9", "account_name": "neukN44Smo" }, "pay_amount": 1450796372939696400, "amount_info": { "order_pay_amount": 4235852899275661000, "brand_discount_amount": 6543601207149867000, "pay_amount": 7732205174433787000, "origin_amount": 5177783033562999000, "pay_discount_amount": 7304862348230667000, "merchant_discount_amount": 1628817595251936500, "platform_discount_amount": 5551864882040743000 }, "discounts": [ { "merchant_discount_amount": 7190817577745661000, "platform_discount_amount": 3845452228143280000, "discount_extra": { "idle_time_discount_info": { "idle_time_limit_type": 1, "discount_start_time": 8936188367713988000, "discount_end_time": 3754381811660252700, "daily_time_range": [ { "start_time": "u4jQEYTpmL", "end_time": "PKgAEN8qEP" } ], "week_day_list": [ 1 ] } }, "brand_discount_amount": 8539373346228495000, "discount_type": 6069391119901082000, "discount_amount": 5886692595667831000 } ], "open_id": "GksR3vIQ5C", "discount_amount": 5140744035883785000 } ], "error_code": 0, "description": "" }, "extra": { "error_code": 0, "description": "", "sub_error_code": 0, "sub_description": "", "logid": "20260410170454976AD8E7EB8662C3ED1D", "now": 1775811894 } }
错误码
| 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 | 已履约 | 该商品完成履约 | 系统 |
