订单查询
通过接口查询指定范围的订单列表及订单详情:
1、查询指定状态的订单列表,用于对账或差异单最新状态确认;
2、查询指定用户的订单列表,用于积分计算、订单展示;
3、查询指定订单详情,用于接口补偿处理。
开票说明
尊敬的商家,依据税务规则与《抖音生活服务平台商户合作协议》的约定,如用户向商家申请开具发票,商家应按照用户实际支付金额向用户开具相应金额的发票。用户的实际支付金额可参考订单查询pay amount字段展示的具体金额(用户实际支付金额,不含平台等其他方补贴的金额)。
针对平台补贴需向平台开具增值税发票,请勿开具给用户。若商家向用户超额开具发票,由此导致的损失及税务风险需由商家自行承担
接口 SLA
指标 | 数值 |
可承载最大qps | 500 |
响应耗时pct99 | 1s |
服务目标可用性 | 99.9% |
接口说明
- 服务商通过接口查询订单详情,支持三种查询方式:
- 根据订单 ID 或第三方订单号,查询对应订单详情,入参:订单 ID/第三方订单号、商户 id;
- 根据订单状态和商户 id,查询指定时间内该商户下的订单列表,入参:商户 id、订单状态、创单起止时间/修改起止时间;
- 根据用户 id 和商户 id,查询某用户在该商户下的所有订单,入参:商户 id、用户 id、创单起止时间/修改起止时间;
- 支付后未发码/发码失败订单查询方式:限定订单状态为“已支付”,如用户下单后超过 10 分钟未发码会发起退款;
- 退款申请待审核订单查询方式:限定券状态为“退款中”,如退款状态未响应超过 72 小时会自动退款。
使用限制
SLA:支持的最大QPS:20;
基本信息
| 名称 | 描述 |
|---|---|
| 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/?update_order_start_time=4203847846113505803&page_num=4522082316689507407&ext_order_id=BW5QhYUjUB&order_status=866662884611459095&create_order_start_time=8144650007910718507&account_id=MG9ak7MDHB&order_id=LSQATWYdD4&open_id=qV0BcqeekU&cursor=[4EjoT3U3Op]&create_order_end_time=16248398294235704&update_order_end_time=3488014828066786535&get_secret_number=false&page_size=7333439816170817503' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \
响应参数
Body展开全部子属性
extra必填Struct
扩展信息
展开子属性
dataStruct
数据列表
展开子属性
响应示例
正常响应示例异常响应示例
{ "extra": { "error_code": 0, "description": "", "sub_error_code": 0, "sub_description": "", "logid": "2025112616403588E883FF39A20CC6E243", "now": 1764146443 }, "data": { "orders": [ { "delivery_info": { "sys_expect_time": "Lu8TUX0p00", "remark": "WuNnGUvggt", "table_ware": "zpON2CVjX3", "deliver_model": 6886035795660529000, "shop_number": "fTiYBknXQS", "is_book": false, "user_expect_time": "NLzZu5quJ3" }, "update_order_time": 5625559804865125000, "discounts": [ { "provider_discount_amount": 3202857660569921500, "idle_time_info": { "WriteOffTimeLimit": { "DailyTimeRangeList": [ { "StartTime": "ytcKhx1MlT", "EndTime": "XDPUrNk0js" } ], "RelativeTime": { "RelativeTime": 994452822934750700, "RelativeTimeType": 1 }, "WeekDayList": [ 1 ], "WriteOffStartTime": 3572909796386843000, "WriteOffEndTime": 7936668628496960000 }, "idle_time_limit_type": 1 }, "brand_discount_amount": 6406983402809881000, "discount_type": 3774416376577539600, "discount_amount": 3183005711160435000, "merchant_discount_amount": 2662283466726786000, "platform_discount_amount": 5839753944733653000 } ], "original_amount": 554563391616419840, "source_order_id": "N2cCpTjVb3", "receiver_info": { "receiver_real_phone": "w8wRrFqpwC", "town": "uxsHttInVa", "lat": 0.26549788236306937, "receiver_name": "PBCwOUMRxa", "secret_number": "7eUMMrtekT", "district": "ayBWrr2p1Q", "location_name": "EugCpiMIs2", "location_address": "FgbSp1rwJJ", "receiver_phone": "bZvnMEuycm", "province": "ZU8n7QGgtu", "city": "hVIzckJ3SS", "lng": 0.7089010871704714, "door_plate_num": "TygVWoAxgf" }, "receipt_amount": 1487475462055227400, "order_type": 2856894099684378600, "third_sku_id": "FDNLBSnQjj", "pay_time": 7000486301696710000, "pay_amount": 3187601524202549000, "merchant_info": { "account_id": "8AkSgdNwaK", "account_name": "8fJ2TpDzXj" }, "discount_amount": 5466391264244751000, "is_deliver_later": false, "user_id": 3886165028350067700, "sub_order_amount_infos": [ { "origin_amount": 6766880637918117000, "discount_amount": 633834768829230700, "discounts": [ { "idle_time_info": { "WriteOffTimeLimit": { "DailyTimeRangeList": [ { "StartTime": "m4ghwKqwmy", "EndTime": "ZaEbnRq073" } ], "RelativeTime": { "RelativeTimeType": 1, "RelativeTime": 304954372698019200 }, "WeekDayList": [ 1 ], "WriteOffStartTime": 5249065647480633000, "WriteOffEndTime": 4444498097962696000 }, "idle_time_limit_type": 1 }, "brand_discount_amount": 3371399631272422400, "discount_type": 501652597195073700, "discount_amount": 1965432799251995000, "merchant_discount_amount": 5826807136636366000, "platform_discount_amount": 8234874643572965000, "provider_discount_amount": 29339934604469224 } ], "receipt_amount": 637283127211548800, "combination_id": "9Zjv0g1kNj", "sub_order_type": 3430312274420633000, "sub_order_id": "mJrnolyB9R", "pay_amount": 3661354456026523000 } ], "contacts": [ { "name": "LcswdoklQ3", "phone": "JgPPoVETcP", "phone_encrypt": "2ra9yGUHC2" } ], "certificate": [ { "order_item_id": "ia0jLAvEVc", "certificate_id": "bz1CvoNuWH", "item_status": 2431699061321358300, "item_update_time": 5535043498743678000, "refund_amount": 3576297856350727700, "refund_time": 4592218245422010000, "combination_id": "68CMCiUJog", "fulfil_mode": 1 } ], "room_id": "zTsY3XAzBR", "order_id": "m8PeMgmLK0", "anchor_id": 790684052315581300, "payment_discount": 2916920025217749000, "create_order_time": 960389380889555000, "order_status": 5892172366074798000, "poi_id": "tskGtcNQB8", "craftsman_uid": "Df2W7mdwB7", "intention_poi_id": "N9DsKBpQvQ", "sku_name": "kkKGULgEp8", "products": [ { "commodities": [ { "group_name": "qowktsAm7Y", "total_count": 8155427309143160000, "option_count": 4177490782181734400, "items": [ { "price": 362493225161480770, "count": 8288005281583002000, "unit": "r7PwPaVL9g", "desc": "XS9aoRNLzN", "item_tag": "RK0GGx6ikj", "attr_list": [ "eRhgPS3Yhl" ], "sku_attr_list": [ { "attr_name": "ywpwGa9XxT", "num": 2910501281673836500 } ], "name": "IEogBFDQWY" } ] } ], "snapshot_product": { "product_attr": { "voucher_par_type": 1, "dynamic_par_rule": { "dynamic_par_rule_item_list": [ { "day_of_week": [ 1 ], "time_period": { "end_time_is_next_day": false, "use_start_time": "KeE38uPNO5", "use_end_time": "1g52hT8kM5" }, "deductible_amount": 2122246275418625300 } ], "dynamic_par_rule_desc": "zrmxK1jcUf", "dynamic_par_min_amount": 8999066444249489000, "dynamic_par_max_amount": 8244596475996310000 }, "show_channel": 1, "advance_purchase_struct": { "purchase_type": 1, "time_detail": [ { "time": 6827847755007679000, "time_type": 1 } ] }, "combo_package_verify_limit_struct": { "product_id_index": { "4529334098212088052": 4934398175510331000 }, "type": 1 } }, "tag_info_list": [ { "TagKey": "hnOeLxUZpI", "TagName": "3qOOguFsYs", "TagValue": "muyQJ3Nytq" } ] }, "num": 410029479910230340, "product_id": "erBmgIplYV", "origin_amount": 4202075055200686000, "sku_id": "Tgogbf8PPC", "product_name": "pMdiznwygw", "product_origin_amount": 7992552723511643000, "ext_product_id": "Z4m7inj0RC" } ], "amount_info": { "estimated_order_income": 1199232528327016400, "sale_price": 3593969328060804600, "commission_amount": 394245644644136450, "platform_discount_amount": 430982091834173400, "provider_discount_amount": 9084171109884343000, "freight_pay_amount": 5543693832512735000, "deduct_info_list": [ { "source_product_name": "XCyUE7wmVo", "source_selling_price": 774804361544102800, "source_origin_amount": 3165042851167357000, "source_payment_discount_amount": 2787087676876439000, "source_order_id": "H3cBxgH1fj", "source_product_id": 981563718830343800, "voucher_type": 1, "source_sku_id": 6735931447626429000, "groupon_type": 1, "source_certificate_id": "ZI66e9bvB9", "source_merchant_discount_amount": 500552660739708860, "source_pay_amount": 3271342514636914000, "source_platform_discount_amount": 4259223913733671400, "source_brand_discount_amount": 7621014269748950000, "source_provider_discount_amount": 4905362745047697000, "source_sku_name": "SarxjjG6sF" } ], "deduct_amount": 7078829783630286000, "product_origin_amount": 1347919531180309000, "pay_amount": 477878585442058560, "activities_fee_amount": 2500018211721677300, "origin_amount": 2543926568652869000, "pay_discount_amount": 8447673481311501000, "merchant_discount_amount": 3382180860409544000, "brand_discount_amount": 6206933534309998000, "merchant_deliver_freight_fee": 2582640479288516600, "platform_deliver_freight_fee": 7653278296976692000 }, "sku_id": "sz3CH1gwA8", "open_id": "bpz62MwXTY", "buyer_info": { "buyer_phone": "ps5nEAfSHf", "buyer_secret_number": "4okRQsTH3g", "buyer_real_phone": "N16gvTUISv" }, "count": 6418240516759984000, "poi": { "poi_id": "SLoLVBYCAt", "poi_name": "nArTDQoIF8", "url": "Q8y3iqoLAd" } } ], "page": { "page_size": 5994177887224688000, "total": 8736107028557829000, "page_num": 814005667490264200 }, "search_after": { "Size": 1218150583358336800, "CursorValue": [ "FYrn7Cp62M" ], "AllCursorValue": [ [ "KesBbCzT4w" ] ] }, "error_code": 0, "description": "" } }
错误码
| 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 | 待使用 | 该商品未发生预约、预订失败回滚 | 系统 |
200 | 预订中 | 用户正在确认该商品的预订单 | 商户 |
201 | 已预订 | 用户已确认预约信息,契约达成 | 用户 |
300 | 退款中 | 发起退款流程 | 用户/商户/系统/客服 |
301 | 已退款 | 退款成功 | 系统 |
400 | 履约中 | 已到履约时间,订单开始履约 | 系统 |
401 | 已履约 | 该商品完成履约 | 系统 |
(3)团购-券维度的订单状态
value | B端 | 状态语义 | 驱动角色 |
0 | 初始化 | 创单初始值 | - |
100 | 待使用 | 该商品未发生预约、预订失败回滚 | 系统 |
300 | 退款中 | 发起退款流程 | 用户/商户/系统/客服 |
301 | 已退款 | 退款成功 | 系统 |
400 | 履约中 | 已到履约时间,订单开始履约 | 系统 |
401 | 已履约 | 该商品完成履约 | 系统 |
