订单查询
通过接口查询指定范围的订单列表及订单详情:
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/?create_order_start_time=4926300426470116966&order_id=9fcUHmq6HQ&cursor=[iCTYt9OqkQ]&order_status=5809142605884785193&create_order_end_time=8629825810427767858&ext_order_id=YXwqAKRTwK&update_order_end_time=5939038577626455156&get_secret_number=false&open_id=6neutd6TaJ&update_order_start_time=2387494922604625753&page_num=6143572121307593508&page_size=8826046065187280215&account_id=2j7B5TzlwT' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \
响应参数
Body展开全部子属性
extra必填Struct
扩展信息
展开子属性
dataStruct
数据列表
展开子属性
响应示例
正常响应示例异常响应示例
{ "data": { "page": { "page_num": 4103605496016299500, "page_size": 2280677468379447000, "total": 625900134425992600 }, "search_after": { "Size": 6355225223477377000, "CursorValue": [ "Jr32uadkye" ], "AllCursorValue": [ [ "ss4qyCwRJy" ] ] }, "orders": [ { "poi": { "poi_id": "lthyNphGYQ", "poi_name": "mr6p3ZbnFA", "url": "9rD2gdo8D0" }, "receipt_amount": 3033689886871540700, "pay_time": 6690077489896778000, "original_amount": 2188576924848440800, "products": [ { "num": 4551398899348495000, "product_id": "rNTNeklpl5", "snapshot_product": { "product_attr": { "dynamic_par_rule": { "dynamic_par_max_amount": 4277071290304994300, "dynamic_par_rule_item_list": [ { "day_of_week": [ 1 ], "time_period": { "use_end_time": "z0m8tzIf4y", "end_time_is_next_day": false, "use_start_time": "da7Z4IVVVG" }, "deductible_amount": 1469244617332285200 } ], "dynamic_par_rule_desc": "wMMFW6hy7j", "dynamic_par_min_amount": 283563764519795460 }, "show_channel": 1, "advance_purchase_struct": { "purchase_type": 1, "time_detail": [ { "time": 1222038366866349000, "time_type": 1 } ] }, "voucher_par_type": 1 }, "tag_info_list": [ { "TagKey": "1FBN7ZrmE7", "TagName": "7QO0alBYEq", "TagValue": "kAbOFNXqGk" } ] }, "sku_id": "tS4otsUzUX", "product_name": "EbpCAAPWq7", "product_origin_amount": 2086893614921835000, "origin_amount": 8304495194890933000, "commodities": [ { "total_count": 7359249399147074000, "option_count": 5998785911769643000, "items": [ { "sku_attr_list": [ { "attr_name": "QVufqcKzy6", "num": 2398772195570084000 } ], "name": "YmzBQUvvwc", "price": 9202666712304545000, "count": 3981608643386553300, "unit": "tu5IDMpGyb", "desc": "R2mXq80JEC", "item_tag": "CCuaS2pWXB", "attr_list": [ "nEJqqjt3wZ" ] } ], "group_name": "sgKUwtOHvP" } ], "ext_product_id": "Ipj9QhMUXh" } ], "open_id": "WcpEOPSJqR", "third_sku_id": "GntlgkDFpR", "sku_name": "bpnKjJwEc1", "discounts": [ { "brand_discount_amount": 2584358686814830600, "discount_type": 3954662828853978600, "discount_amount": 583842912070590700, "merchant_discount_amount": 2627469883574116000, "platform_discount_amount": 3970622001996766000, "provider_discount_amount": 6943566190713825000, "idle_time_info": { "WriteOffTimeLimit": { "WriteOffStartTime": 2426537438553246000, "WriteOffEndTime": 4372465263521844000, "DailyTimeRangeList": [ { "StartTime": "gghiczqzdT", "EndTime": "Qqori8p2Pu" } ], "RelativeTime": { "RelativeTimeType": 1, "RelativeTime": 714438699266140300 }, "WeekDayList": [ 1 ] }, "idle_time_limit_type": 1 } } ], "receiver_info": { "door_plate_num": "P9Cf8lDA9U", "secret_number": "RXtalLytLu", "receiver_phone": "UbCkpco7XL", "location_name": "suZiUPScLm", "lat": 0.8205181043317006, "receiver_name": "rL1h56baqj", "lng": 0.12019671069371289, "town": "Kk1748ss3u", "receiver_real_phone": "K74abL4tzb", "district": "4wzAz5AJUZ", "location_address": "RbVfnftDR9", "city": "mblm87KdND", "province": "BrVhqC1AJH" }, "payment_discount": 2919609924718341600, "amount_info": { "platform_discount_amount": 3617528339300286500, "merchant_discount_amount": 8592691330660518000, "product_origin_amount": 2236886369731063800, "estimated_order_income": 7295039776757268000, "origin_amount": 4306982866262610400, "commission_amount": 3874022706416186400, "pay_amount": 4132163559552012300, "brand_discount_amount": 2775606715256969700, "freight_pay_amount": 3056962976452877000, "provider_discount_amount": 8331063777607601000, "sale_price": 3192176507590275600, "merchant_deliver_freight_fee": 3673452581374773000, "pay_discount_amount": 2071646431883667500, "platform_deliver_freight_fee": 6957419734363679000, "activities_fee_amount": 9210417520638791000 }, "contacts": [ { "phone": "A4yOtlypvG", "phone_encrypt": "Fkv8QGzzFC", "name": "132tq3FKqv" } ], "delivery_info": { "is_book": false, "user_expect_time": "BpBdr3fx5P", "sys_expect_time": "i3quiKPEnm", "remark": "TRRFSfmalM", "table_ware": "Z3d2O0SDWZ", "deliver_model": 6374385884798550000, "shop_number": "N0N4fW5lH5" }, "is_deliver_later": false, "sub_order_amount_infos": [ { "discounts": [ { "brand_discount_amount": 2529262946477366300, "discount_type": 3124837967568347600, "discount_amount": 1911441579585166000, "merchant_discount_amount": 8786131053113646000, "platform_discount_amount": 3312619519253779000, "provider_discount_amount": 8632610479006484000, "idle_time_info": { "WriteOffTimeLimit": { "WriteOffStartTime": 3528494104670351400, "WriteOffEndTime": 4364424497955291000, "DailyTimeRangeList": [ { "StartTime": "Lsvip8RNm2", "EndTime": "sI4XZfahvO" } ], "RelativeTime": { "RelativeTimeType": 1, "RelativeTime": 6853221659173481000 }, "WeekDayList": [ 1 ] }, "idle_time_limit_type": 1 } } ], "receipt_amount": 4292799498390812000, "combination_id": "5b2yCj1jR9", "sub_order_type": 8960535236774924000, "sub_order_id": "hPwmLV1zEq", "pay_amount": 3906253965560336400, "origin_amount": 5056472043963430000, "discount_amount": 5639958134430165000 } ], "order_status": 8963601424437701000, "anchor_id": 5846678226105421000, "count": 5920226111531552000, "order_id": "qS0F6ZTRJN", "poi_id": "4U5ZDF9tzO", "order_type": 3340477964609410000, "merchant_info": { "account_id": "5BoqxV16g0", "account_name": "dk8vxvyz1V" }, "craftsman_uid": "SWEqXEchRi", "user_id": 7156971205083018000, "discount_amount": 2152559812609369300, "buyer_info": { "buyer_real_phone": "TKLe8EhfqN", "buyer_phone": "royjY1kaXJ", "buyer_secret_number": "DX5gcflNLX" }, "update_order_time": 5000969806328924000, "pay_amount": 9211464207176581000, "create_order_time": 7294837377562142000, "intention_poi_id": "bFzrNbexp2", "certificate": [ { "item_update_time": 7557499510154852000, "refund_amount": 7805913995799215000, "refund_time": 4458716561774779000, "combination_id": "eyzhnZ1RFF", "order_item_id": "OCydmwz7dO", "certificate_id": "iU7ZFLe57Q", "item_status": 7611141085104778000 } ], "sku_id": "uO9PuekSYK", "room_id": "xlcUkeawCJ" } ], "error_code": 0, "description": "" }, "extra": { "error_code": 0, "description": "", "sub_error_code": 0, "sub_description": "", "logid": "2025072919280397CE10EF21CCB22E8277", "now": 1753788491 } }
错误码
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 | 已履约 | 该商品完成履约 | 系统 |