订单查询
通过接口查询指定范围的订单列表及订单详情:
1、查询指定状态的订单列表,用于对账或差异单最新状态确认;
2、查询指定用户的订单列表,用于积分计算、订单展示;
3、查询指定订单详情,用于接口补偿处理。
开票说明
尊敬的商家,依据税务规则与《抖音生活服务平台商户合作协议》的约定,如用户向商家申请开具发票,商家应按照用户实际支付金额向用户开具相应金额的发票。用户的实际支付金额可参考订单查询pay amount字段展示的具体金额(用户实际支付金额,不含平台等其他方补贴的金额)。
针对平台补贴需向平台开具增值税发票,请勿开具给用户。若商家向用户超额开具发票,由此导致的损失及税务风险需由商家自行承担
接口说明
- 服务商通过接口查询订单详情,支持三种查询方式:
- 根据订单 ID 或第三方订单号,查询对应订单详情,入参:订单 ID/第三方订单号、商户 id;
- 根据订单状态和商户 id,查询指定时间内该商户下的订单列表,入参:商户 id、订单状态、创单起止时间/修改起止时间;
- 根据用户 id 和商户 id,查询某用户在该商户下的所有订单,入参:商户 id、用户 id、创单起止时间/修改起止时间;
- 支付后未发码/发码失败订单查询方式:限定订单状态为“已支付”,如用户下单后超过 10 分钟未发码会发起退款;
- 退款申请待审核订单查询方式:限定券状态为“退款中”,如退款状态未响应超过 72 小时会自动退款。
- 承载总qps:200 (单服务商应用默认:20)
使用限制
SLA:支持的最大QPS:20;PCT99承诺值:2ms;
基本信息
| 名称 | 描述 |
|---|---|
| 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翻页,但page_size和page_num是必填项,不传会报错
ext_order_idString
开发者系统中的订单号
get_secret_numberBool
是否需要查询配送信息
open_idString
抖音内部用户的一种唯一标识
如果对接了会员通,可以通过接收会员入会SPI接口获取并保存
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_end_time=8750231714234149131&update_order_start_time=2207809880535641822&page_num=769903066438681863&create_order_start_time=1332144044588151004&get_secret_number=false&account_id=fJ1bhG5yO9&order_id=JIgvPSG3oh&cursor=[UPRfEHAj5l]&order_status=7199142770809846121&ext_order_id=m7csGVkwQS&page_size=2003611807529999453&open_id=noAJ5xcdsi&update_order_end_time=7517256127479647933' \ --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": "202604221138458D7D5B18F4DCF8EED3CA", "now": 1776829128 }, "data": { "page": { "total": 640743133914464500, "page_num": 3605812970962591000, "page_size": 7260940189996982000 }, "search_after": { "Size": 161444417383639580, "CursorValue": [ "c9PcERHORI" ], "AllCursorValue": [ [ "mGqi1gZ7xq" ] ] }, "orders": [ { "user_id": 3782551387740999000, "order_status": 3298099570581833700, "open_id": "uQIws3uOvJ", "buyer_info": { "buyer_phone": "a9gfoThiop", "buyer_secret_number": "mbqKjCQft8", "buyer_real_phone": "nFE3cBKbbr" }, "order_type": 8175357318643337000, "sku_name": "zeIPIqZVUL", "room_id": "0QorjjcF6z", "products": [ { "snapshot_product": { "product_attr": { "combo_package_verify_limit_struct": { "product_id_index": { "443539940063503442": 3611297337836046000 }, "type": 1 }, "voucher_par_type": 1, "dynamic_par_rule": { "dynamic_par_min_amount": 7279078508755121000, "dynamic_par_max_amount": 2492078241349460500, "dynamic_par_rule_item_list": [ { "day_of_week": [ 1 ], "time_period": { "use_end_time": "qHRPSqAbAt", "end_time_is_next_day": false, "use_start_time": "uSkOXmT9QR" }, "deductible_amount": 794825905048301000 } ], "dynamic_par_rule_desc": "2EqA7XfkvD" }, "show_channel": 1, "advance_purchase_struct": { "time_detail": [ { "time_type": 1, "time": 5583129442690911000 } ], "purchase_type": 1 } }, "tag_info_list": [ { "TagKey": "01aDJrTmc9", "TagName": "UJLdEjOJN7", "TagValue": "ipTROTeiw7" } ] }, "sku_id": "rrlhadi41S", "product_name": "eL2I34PNL6", "product_id": "1psOdc5HWQ", "num": 841477903744773600, "commodities": [ { "total_count": 1643740461919149000, "option_count": 6437880997681055000, "items": [ { "attr_list": [ "msmN1IlGqv" ], "desc": "2ylZvT0vfz", "price": 1472422913597271800, "name": "bQfSYzQEL7", "unit": "IPNoWP0lcF", "sku_attr_list": [ { "attr_name": "0p7UzsXCwy", "num": 139405964907121140 } ], "item_tag": "CI6HUeJ0BA", "count": 7463830625286948000 } ], "group_name": "2Qqw2vjmUO" } ], "product_origin_amount": 5650665375356902000, "third_sku_id": "HwJcMam1UR", "ext_product_id": "cX38yzPEah", "origin_amount": 116010732548566800 } ], "poi": { "poi_id": "bvBP6tYh9L", "poi_name": "KKwj0cAaMo", "url": "9Zz5LOAEUM" }, "is_deliver_later": false, "order_id": "uipfqmFExl", "poi_id": "1p7ImUS0OU", "source_order_id": "drJctKzBep", "sub_order_amount_infos": [ { "origin_amount": 7361909815930778000, "discount_amount": 3893198990421190700, "discounts": [ { "platform_discount_amount": 2029988893996271400, "provider_discount_amount": 1359309002085290200, "idle_time_info": { "WriteOffTimeLimit": { "DailyTimeRangeList": [ { "StartTime": "Tq9B4j5IHL", "EndTime": "PoVEjRdM7t" } ], "RelativeTime": { "RelativeTimeType": 1, "RelativeTime": 3874500773554856000 }, "WeekDayList": [ 1 ], "WriteOffStartTime": 3187335308067654700, "WriteOffEndTime": 2972301186286722600 }, "idle_time_limit_type": 1 }, "brand_discount_amount": 2737436507731132400, "discount_type": 7665496566384194000, "discount_amount": 1728548368524649700, "merchant_discount_amount": 8195339584979047000 } ], "sub_order_type": 1527955210329137400, "combination_id": "igKkSjoU2E", "sub_order_id": "B7N0p8qwk8", "pay_amount": 218382544167634200, "receipt_amount": 4667529935252458000 } ], "reservation_gift": { "reserved_gift_quantity": "ykTH1aWyyz", "reserved_gift_content": "piRpoUuDDj", "has_reserved_gift": false }, "pay_time": 1167136735090276400, "contacts": [ { "phone_encrypt": "MLPxoqtUpu", "name": "7j3qvnUGu2", "phone": "OoUhnYRaEP" } ], "intention_poi_id": "TOWfULZEFL", "certificate": [ { "order_item_id": "SMcCJVlIFH", "item_status": 6443176984183404000, "refund_amount": 5176709504663236000, "refund_time": 1443318409745674000, "certificate_id": "OX71KtzxiH", "combination_id": "FRnPstCH0h", "item_update_time": 2096772892882478600, "fulfil_mode": 1 } ], "create_order_time": 6411139666176851000, "order_sale_info": { "transfer_nickName": "cVjBlHGqqa", "transfer_uid": "mheC7L8E7K", "transfer_douyin_uid": "3tbVt4rhM4", "sale_role": "b8udROCLXz", "sale_channel": "Uwd9fxzTqT" }, "discounts": [ { "platform_discount_amount": 6186773556608190000, "provider_discount_amount": 7661161320404600000, "idle_time_info": { "idle_time_limit_type": 1, "WriteOffTimeLimit": { "RelativeTime": { "RelativeTime": 5844519122127831000, "RelativeTimeType": 1 }, "WeekDayList": [ 1 ], "WriteOffStartTime": 2501767907774933000, "WriteOffEndTime": 4507818702385580000, "DailyTimeRangeList": [ { "StartTime": "76nXfSp1JV", "EndTime": "xheHc84ady" } ] } }, "brand_discount_amount": 2857465061389204500, "discount_type": 1881136414404290800, "discount_amount": 649531374135217000, "merchant_discount_amount": 7646310056599620000 } ], "update_order_time": 8309556344127587000, "receipt_amount": 1373953290364070000, "craftsman_uid": "ZwoQ07ZKDL", "pay_amount": 6540379136402509000, "sku_id": "B0OEAon7MQ", "anchor_id": 7996527567966536000, "delivery_info": { "table_ware": "Ll68Shl4Jh", "deliver_model": 5307243576102699000, "shop_number": "wnvMLE31wx", "is_book": false, "user_expect_time": "P3evD7oIC4", "sys_expect_time": "gTI0UFvOqn", "remark": "D9lVSVHe5M" }, "count": 1520590675023391500, "merchant_info": { "account_name": "yOlkpMgdFI", "account_id": "hn5oHiQ2Wa" }, "discount_amount": 674304352683613000, "payment_discount": 463587643236175940, "third_sku_id": "8MOPeDPgUO", "amount_info": { "origin_amount": 219163030254093220, "pay_amount": 8516627644876572000, "platform_deliver_freight_fee": 7753469348870036000, "activities_fee_amount": 4955667777409480000, "platform_discount_amount": 1157114989346339300, "brand_discount_amount": 1732583139084684300, "merchant_discount_amount": 8701998772213202000, "sale_price": 8916883586597362000, "deduct_info_list": [ { "source_product_id": 1860012662450518000, "source_payment_discount_amount": 7769728102395111000, "source_brand_discount_amount": 3770629913564136000, "source_sku_id": 6261454901900780000, "source_certificate_id": "trAbmsiUla", "source_provider_discount_amount": 2819399449025164300, "source_merchant_discount_amount": 1665563060027241000, "source_selling_price": 7042068170936371000, "source_order_id": "3hiUSYkFu2", "source_product_name": "cLiDt02ExI", "voucher_type": 1, "source_platform_discount_amount": 2899533910156687400, "groupon_type": 1, "source_pay_amount": 2562272912083746300, "source_sku_name": "4WyrkDJzZ3", "source_origin_amount": 5542072184759477000 } ], "product_origin_amount": 7096029197437578000, "estimated_order_income": 2520641775911613000, "deduct_amount": 1673401570624220700, "freight_pay_amount": 8269797540714271000, "merchant_deliver_freight_fee": 7988682483881641000, "provider_discount_amount": 220545517918058600, "pay_discount_amount": 2733863365215655000, "commission_amount": 5371739540305668000 }, "original_amount": 7344221012886089000, "receiver_info": { "location_address": "FaZWaTbetU", "door_plate_num": "7hDmf6ak7Q", "receiver_name": "4Nb3WIQ2No", "lng": 0.902031788583168, "lat": 0.025100959073475638, "town": "07k6rdS8Tw", "receiver_real_phone": "ys5qGcfxBt", "receiver_phone": "xXmjKlbCpD", "secret_number": "u0JheqyA7o", "city": "zNz3RUR0kO", "province": "gSvJtJR6bd", "location_name": "DsiUpXsTA7", "district": "rbDBSqAAdB" } } ], "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 | 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 | 已履约 | 该商品完成履约 | 系统 |
