订单查询
通过接口查询指定范围的订单列表及订单详情:
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/?open_id=BMlYYFxxBc&page_num=8117645472736096812&update_order_start_time=5652236469254849014&update_order_end_time=5450411170955480516&account_id=GsszHWft7y&ext_order_id=edmB5C9jzz&create_order_end_time=6000728206480696204&get_secret_number=false&page_size=2458343175904605951&cursor=[Pc0UDrGko0]&order_id=KcRiZr0R8K&order_status=7710314407763414990&create_order_start_time=322250070163483897' \ --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": "20260521193836F194ACE78780CBA4067D", "now": 1779363519 }, "data": { "orders": [ { "poi_id": "lUsoPDFFTn", "order_status": 4028273138600332000, "count": 2456096719405817300, "reservation_gift": { "has_reserved_gift": false, "reserved_gift_quantity": "9eQSc9sCqQ", "reserved_gift_content": "oigEXcfA7L" }, "anchor_id": 4781980527889547000, "source_order_id": "vctzlvDnuO", "receiver_info": { "town": "scWS5TgDOE", "lng": 0.7628524827167583, "location_address": "AmgWWb1jxM", "province": "mgVnsEAqAW", "door_plate_num": "EiAs563f6R", "receiver_name": "JPvNGxxsV1", "district": "gHN073EWpw", "receiver_real_phone": "aJ21to1h1z", "receiver_phone": "vTlA4dk93o", "secret_number": "KdKPIcE2hX", "location_name": "lwcjFPeRJE", "city": "tNckGt8UZ6", "lat": 0.7137710329714321 }, "order_type": 5742135213836025000, "order_id": "U3X6o9Nmq2", "buyer_reserve_info": [ { "enc_credential_numb": "MTq6fIFIL8", "enc_name": "tQMsVpLIEf", "credential_type": 3389723381600518700 } ], "room_id": "RgN0LFu7Lr", "open_id": "8gN644CUpP", "sku_name": "oaHRqP5Oay", "delivery_info": { "remark": "uTAEF4TXQy", "table_ware": "a4u3CVKt7y", "deliver_model": 297124204119080640, "shop_number": "fafJX65kSx", "is_book": false, "user_expect_time": "dpPwpyll0x", "sys_expect_time": "jlq6RGX7da" }, "poi": { "poi_name": "BSL5GvwK9A", "url": "kxtqEfHu40", "poi_id": "z6EMCu3xSY" }, "third_sku_id": "vKtSJVHzCn", "products": [ { "num": 5751314553505848000, "product_id": "dtqRvxDZ48", "commodities": [ { "items": [ { "attr_list": [ "DrS5hMIfZZ" ], "count": 2925160694197236700, "name": "adYLsKZtB1", "unit": "y2a977imCs", "sku_attr_list": [ { "attr_name": "1MB4ehpYxF", "num": 9164651612431651000 } ], "price": 3185530580614057000, "desc": "aoUmYneF2j", "item_tag": "Ir62Fq8Vu3" } ], "group_name": "jUpB5zfcr6", "total_count": 14929413488336548, "option_count": 6994781999857693000 } ], "ext_product_id": "MrWaqsipRp", "snapshot_product": { "tag_info_list": [ { "TagName": "CgiL2QMASh", "TagValue": "MsqaaOoTYw", "TagKey": "l6HG00grxt" } ], "product_attr": { "voucher_par_type": 1, "dynamic_par_rule": { "dynamic_par_rule_item_list": [ { "time_period": { "use_start_time": "U46WObpFVb", "use_end_time": "KdaNVJvBCg", "end_time_is_next_day": false }, "deductible_amount": 1324913038799284700, "day_of_week": [ 1 ] } ], "dynamic_par_rule_desc": "yXPiPoZMDD", "dynamic_par_min_amount": 35280565580996276, "dynamic_par_max_amount": 2884722879134177000 }, "show_channel": 1, "advance_purchase_struct": { "purchase_type": 1, "time_detail": [ { "time": 622018118314344600, "time_type": 1 } ] }, "combo_package_verify_limit_struct": { "type": 1, "product_id_index": { "802632583204206071": 6633812021234044000 } } } }, "third_sku_id": "bMsPdTKyAC", "origin_amount": 2908587088559793000, "product_origin_amount": 4114771962763002400, "product_name": "Oi6XWEmTEz", "sku_id": "VDUK8anoxc" } ], "update_order_time": 7632105524059140000, "sub_order_amount_infos": [ { "sub_order_id": "iysMw1C9xI", "discount_amount": 5418090713645809000, "combination_id": "urSHVS4Rky", "sub_order_type": 717226094787277700, "receipt_amount": 31924929638344856, "pay_amount": 3531897687610006500, "origin_amount": 5430900748213124000, "discounts": [ { "merchant_discount_amount": 1530747559346321000, "platform_discount_amount": 1986659305466929700, "provider_discount_amount": 5196225116723249000, "idle_time_info": { "WriteOffTimeLimit": { "WriteOffStartTime": 4946432536674292000, "WriteOffEndTime": 4251038080625770500, "DailyTimeRangeList": [ { "StartTime": "mG76WdumVq", "EndTime": "MIzHAlkzZ1" } ], "RelativeTime": { "RelativeTime": 179373173062350750, "RelativeTimeType": 1 }, "WeekDayList": [ 1 ] }, "idle_time_limit_type": 1 }, "brand_discount_amount": 2411389253328550000, "discount_type": 1585497861047392800, "discount_amount": 6049368504281765000 } ] } ], "certificate": [ { "refund_amount": 2672973920187489000, "combination_id": "JJqEmTy09i", "refund_time": 2879629161948457000, "item_status": 6391070301611617000, "item_update_time": 4007351378871213600, "order_item_id": "iqerU0oOnj", "certificate_id": "BUayLyAUjv", "fulfil_mode": 1 } ], "amount_info": { "activities_fee_amount": 8971784585775243000, "platform_discount_amount": 9201490988123335000, "deduct_amount": 5536420012347904000, "provider_discount_amount": 6143253255978924000, "commission_amount": 845434997631145200, "brand_discount_amount": 4942103206822612000, "pay_amount": 3871586225164176400, "platform_deliver_freight_fee": 7620524498135409000, "estimated_order_income": 7033075722211638000, "sale_price": 4300936091922827300, "product_origin_amount": 4515928327054557000, "merchant_discount_amount": 3487934573156875000, "deduct_info_list": [ { "voucher_type": 1, "source_selling_price": 7158143756811379000, "source_product_id": 4019727363735719400, "source_origin_amount": 3812781140474315000, "source_provider_discount_amount": 7831376438156310000, "source_order_id": "XsAQD6kAOw", "source_payment_discount_amount": 8488147584499853000, "source_certificate_id": "guK3wLHmlo", "source_pay_amount": 2325692903445657000, "source_sku_name": "xCggQic9E6", "source_product_name": "Ut00W56Agb", "source_platform_discount_amount": 4049510571248210000, "groupon_type": 1, "source_merchant_discount_amount": 2188102445469115600, "source_brand_discount_amount": 2501242199964721700, "source_sku_id": 8714513724320367000 } ], "pay_discount_amount": 4648311323804566000, "merchant_deliver_freight_fee": 958007425868633700, "freight_pay_amount": 3055684264143712000, "origin_amount": 5118428067572484000 }, "pay_time": 8062276894719143000, "original_amount": 4350012016377042400, "payment_discount": 3144801850161390000, "sku_id": "yxcNSiJFEH", "intention_poi_id": "aiVpSrBVe1", "is_deliver_later": false, "create_order_time": 6108829068602508000, "craftsman_uid": "CyD1Xq1CqB", "discount_amount": 5887379491616582000, "order_sale_info": { "transfer_nickName": "Pz2PTwEHvJ", "transfer_uid": "QPkznXO4Lg", "transfer_douyin_uid": "MJjuk6GBdF", "sale_role": "1chkPDC8Ai", "sale_channel": "pfw5ZewwU4" }, "discounts": [ { "provider_discount_amount": 6677839474854491000, "idle_time_info": { "WriteOffTimeLimit": { "WriteOffStartTime": 6040600292564597000, "WriteOffEndTime": 8999097083020239000, "DailyTimeRangeList": [ { "EndTime": "CXJVOgdScn", "StartTime": "XislJgAwDC" } ], "RelativeTime": { "RelativeTimeType": 1, "RelativeTime": 8943644507152184000 }, "WeekDayList": [ 1 ] }, "idle_time_limit_type": 1 }, "brand_discount_amount": 8258118059702764000, "discount_type": 5604668625013032000, "discount_amount": 6693760825132678000, "merchant_discount_amount": 458408041025269250, "platform_discount_amount": 8126225785808938000 } ], "pay_amount": 3628118968504122000, "receipt_amount": 7777362597657962000, "user_id": 9020771305435032, "buyer_info": { "buyer_phone": "vmt6qvrdIE", "buyer_secret_number": "98usziQ0j9", "buyer_real_phone": "MlClsQR2Bm" }, "contacts": [ { "name": "074s1EQwe4", "phone": "u7y3Yhgx5m", "phone_encrypt": "b5NghkRK53" } ], "merchant_info": { "account_id": "eoo2iTwJWB", "account_name": "iCrdFXoYXd" }, "pay_bill_info": { "total_pay_amount": 641677920442671600, "is_timely_pay_bill": false } } ], "page": { "page_size": 1915442523601860000, "total": 4209579227256044000, "page_num": 5785921117227855000 }, "search_after": { "Size": 7095068639307871000, "CursorValue": [ "pSuIRu5Mk0" ], "AllCursorValue": [ [ "lHrqq87neI" ] ] }, "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 | 已履约 | 该商品完成履约 | 系统 |
