餐饮团购-订单查询__抖音开放平台

通过接口查询指定范围的订单列表及订单详情：

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%

使用限制

接口只能保证准实时（数据平均延时 2s 可查到最新状态，负载较高时 p99 可达 min 级别），建议用于实时性不高的统计类查询。
单页查询最大 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	调用https://open.douyin.com/oauth/client_token/生成的token
content-type	String	是	application/json	固定值"application/json"

请求参数

Query

名称	字段类型	是否必填	描述
account_id	String	是	来客商户根账户ID
page_num	Int32	是	第几页（首页传1）
page_size	Int32	是	页大小，取值范围1～100
create_order_end_time	Int64	否	创单结束时间（秒时间戳，创单起止时间必须同时传入）
create_order_start_time	Int64	否	创单起始时间（秒时间戳，创单起止时间必须同时传入）
cursor	List	否	根据游标滚动请求，直到返回结果数量小于请求的size或未返回search_after结束；首页传0，第二页翻页传首页返回的cursor，数组格式["0","1"]；如果传入此参数，会优先使用cursor翻页，而不是page翻页
ext_order_id	String	否	开发者系统中的订单号
open_id	String	否	抖音用户id
order_id	String	否	抖音生活服务订单ID 见抖音-团购频道-订单详情
order_status	Int32	否	订单状态
update_order_end_time	Int64	否	修改起始时间（秒时间戳，修改起止时间必须同时传入）
update_order_start_time	Int64	否	修改起始时间（秒时间戳，修改起止时间必须同时传入）

请求示例

https://open.douyin.com/goodlife/v1/akte/order/query/?account_id=xxx&page_num=1&page_size=10&create_order_start_time=1693554171&create_order_end_time=1696059771&order_status=1&cursor=["0"]

响应参数

Body

名称	字段类型	是否必填	示例	描述
data	Struct	否
extra	Struct	否

响应示例

正常响应示例

{
  "data": {
    "error_code": 0,
    "description": "",
    "search_after": {
      "size": 2279938142718329600,
      "cursor": [
        "udkldLui4E"
      ],
      "all_cursor": [
        [
          "SJjU8G8jvK"
        ]
      ]
    },
    "orders": [
      {
        "sub_order_amount_infos": [
          {
            "discount_amount": 8372708220084542000,
            "discounts": [
              {
                "discount_type": 2244867133783721500,
                "discount_amount": 4108400947318316500,
                "merchant_discount_amount": 3111905708063814700,
                "platform_discount_amount": 2602215100184337400
              }
            ],
            "sku_id": "dfm2sYetyn",
            "sub_order_type": 6450734776375772000,
            "sub_order_id": "MUsTQijfWI",
            "pay_amount": 5272208770032270000,
            "origin_amount": 4879501272093242000
          }
        ],
        "order_type": 4487833961598848500,
        "discounts": [
          {
            "discount_type": 2883474230585013000,
            "discount_amount": 4229472370775611400,
            "merchant_discount_amount": 3349143804843075000,
            "platform_discount_amount": 2507015063431919000
          }
        ],
        "pay_time": 826080941465378600,
        "discount_amount": 2409050312390589000,
        "create_order_time": 344407058579477800,
        "poi": {
          "poi_name": "brUn0aSvNs",
          "poi_id": "5Aya5QLZTv"
        },
        "certificate": [
          {
            "certificate_id": "KeHecUkqAv",
            "item_status": 1467773805061948700,
            "item_update_time": 8332829157012008000,
            "refund_amount": 3742757024130223000,
            "refund_time": 5083386230581569000,
            "sku_id": "cyQkw0ZDkJ",
            "order_item_id": "TPOXza1IC3"
          }
        ],
        "order_status": 2645441812770081300,
        "open_id": "f4pvznstis",
        "goods": [
          {
            "goods_detail": {
              "goods_attr": {
                "voucher_par_type": 1,
                "dynamic_par_rule": {
                  "dynamic_par_rule_item_list": [
                    {
                      "time_period": {
                        "end_time_is_next_day": false,
                        "use_start_time": "3fXn6Hz3Nj",
                        "use_end_time": "YZxaXprh0Q"
                      },
                      "deductible_amount": 1987076235376095700,
                      "day_of_week": [
                        1
                      ]
                    }
                  ],
                  "dynamic_par_rule_desc": "tWGISL44os",
                  "dynamic_par_min_amount": 5871111854213007000,
                  "dynamic_par_max_amount": 8098672671525528000
                }
              }
            },
            "sku_id": "p7dSET0W31",
            "sku_name": "raw23ExhxP",
            "third_sku_id": "LLPUXKEAPG",
            "count": 6621619483212321000
          }
        ],
        "contacts": [
          {
            "phone": "IDCwCZAqNF",
            "phone_encrypt": "nMzqFXjd7R",
            "name": "53XvdM25Yz"
          }
        ],
        "update_order_time": 4852331528936809000,
        "pay_amount": 3535520381497489000,
        "order_id": "R52fT58k4w",
        "amount_info": {
          "pay_amount": 7665014508769570000,
          "origin_amount": 5501829126606440000,
          "pay_discount_amount": 6140983063216853000,
          "merchant_discount_amount": 2868212681254656000,
          "platform_discount_amount": 4097098745007679000
        },
        "merchant_info": {
          "account_id": "zdLP9lejw2",
          "account_name": "4hOXhaJExx"
        },
        "original_amount": 5460312037163710000,
        "payment_discount": 2899639474560017000
      }
    ],
    "page": {
      "page_num": 1041769564919063900,
      "page_size": 5249802275301294000,
      "total": 1830102544205173200
    }
  },
  "extra": {
    "logid": "202008121419360101980821035705926A",
    "now": 642719501346803600,
    "error_code": 7613799757771928000,
    "description": "hLVtKs4Iqy",
    "sub_error_code": 3999959595765676500,
    "sub_description": "RNtdnNIk7n"
  }
}

异常响应示例

{
  "data": {
    "error_code": 2190008,
    "description": "access_token过期,请刷新或重新授权"
  },
  "extra": {
    "error_code": 2190008,
    "description": "access_token过期,请刷新或重新授权",
    "sub_error_code": 0,
    "sub_description": "access_token过期,请刷新或重新授权",
    "logid": "202406131959494F28C28C0002DD440D4B",
    "now": 1718279990081
  }
}

错误码

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	根据实际业务错误返回	联系抖音处理

错误码

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		联系抖音处理

附录

（1）订单维度订单状态

order	状态	状态定义
0	初始化	创单初始值
100	待支付	创单成功，未完成支付，15min待支付等待期
101	支付取消	用户取消支付或超时未支付
200	已支付	用户完成支付
201	待使用	发码成功，商品还未使用或完成预约
1	已完成	订单完成履约或者全部退款

（2）团购-券维度的订单状态

value	B端	状态语义	驱动角色
0	初始化	创单初始值	-
100	待使用	该商品未发生预约、预订失败回滚	系统
300	退款中	发起退款流程	用户/商户/系统/客服
301	已退款	退款成功	系统
400	履约中	已到履约时间，订单开始履约	系统
401	已履约	该商品完成履约	系统

餐饮团购-订单查询在线调试

​接口 SLA​

接口说明

使用限制

基本信息

请求头

请求参数

Query

请求示例

响应参数

Body

响应示例

正常响应示例

异常响应示例

错误码

​错误码​

​附录​

餐饮团购-订单查询

接口 SLA

错误码

附录