抖音开放平台Logo
控制台

验券历史查询

更新时间 2024-07-24 02:58:49
收藏
我的收藏

接口说明

1、查询某个企业号下的一个或多个门店在一段时间内的全部验券历史 2、通过 size 与 cursor 参数进行分页查询

使用限制

无

基本信息

名称描述
HTTP URL
https://open.douyin.com/goodlife/v1/fulfilment/certificate/verify_record/query/
HTTP Method
GET
Scope
life.capacity.billing
权限要求
  • 需要申请权限 ，路径：抖音开放平台-开发者平台/服务商平台>控制台>应用详情>解决方案
  • 需要商家授权，路径：抖音来客>店铺管理>服务应用授权

请求头

名称字段类型是否必填示例描述
access-tokenString是clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
调用https://open.douyin.com/oauth/client_token/生成的token
content-typeString是application/json
固定值"application/json"

请求参数

Query

名称字段类型是否必填示例描述
account_idString是
商家信息
cursorString是
游标,传前一页最后一条记录的游标(首页传0)
sizeInt32是

页大小, 1~20

end_timeInt64否
截止时间戳,单位秒
start_timeInt64否
起始时间戳,单位秒,不传表示今天

请求示例

https://open.douyin.com/goodlife/v1/fulfilment/certificate/verify_record/query/?size=20&cursor=0&account_id=702818239741028387&poi_ids=76102981024801401&start_time=1597213176393&end_time=1597213176393

响应参数

Body

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

响应示例

正常响应示例

{
  "extra": {
    "sub_description": "oyWARKyAvQ",
    "logid": "202008121419360101980821035705926A",
    "now": 4821079028422212000,
    "error_code": 212373746802350750,
    "description": "aLwvOh4QEL",
    "sub_error_code": 312249806326892400
  },
  "data": {
    "error_code": 0,
    "description": "",
    "total": 2153437585552810200,
    "records": [
      {
        "verify_amount_info": {
          "times_card_serial_amount": {
            "serial_numb": 6064986885608677000,
            "amount": {
              "payment_discount_amount": 2490891403361177600,
              "origin_list_market_amount": 7157048064035672000,
              "merchant_ticket_amount": 5168209767083723000,
              "list_market_amount": 5490509144281442000,
              "original_currency": "hZPaz9i0BZ",
              "platform_discount_amount": 1932140448715524000,
              "original_amount": 6985194078099370000,
              "pay_amount": 936014577237163300,
              "coupon_pay_amount": 5658902422324563000
            }
          },
          "time_card_amount": {
            "amount": 194622874991142340
          }
        },
        "certificate_id": "bLMMg92RMJ",
        "verify_time": 2797205443960703000,
        "cancel_time": 5951621134340837000,
        "status": 1,
        "code": "DYPoTw4ICH",
        "cursor": "JwJzJzxZpE",
        "sku": {
          "groupon_type": 1,
          "market_price": 2323377740787363000,
          "sold_start_time": 3838055978944902000,
          "third_sku_id": "cDcQhuflZU",
          "account_id": "f6JS7mcqA2",
          "sku_id": "N5nqQN9BKr",
          "title": "ViVYnhm4vk"
        },
        "certificate_status": 1,
        "verify_type": 1,
        "verify_id": "HR8p0gsGRF",
        "can_cancel": false,
        "amount": {
          "pay_amount": 5812284129910882000,
          "platform_discount_amount": 3350545732665303000,
          "original_currency": "eA4GzqV1eu",
          "original_amount": 7783604774414293000,
          "payment_discount_amount": 1816536232994594000,
          "origin_list_market_amount": 3794252118448848400,
          "coupon_pay_amount": 5174442903597070000,
          "merchant_ticket_amount": 5148557622618503000,
          "list_market_amount": 8371775857193472000
        }
      }
    ]
  }
}

异常响应示例

{
  "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状态码错误码错误码描述排查建议
20028001005
系统内部错误，请重试
请求重试，若依然无解请向平台提交反馈
20028001003
access_token无效
重新请求生成access_token
20028001008
access_token过期,请刷新或重新授权
重新请求生成access_token
20028001016
当前应用已被封禁或下线
clientKey被封禁或者下线
20028001006
网络调用错误，请重试
重试即可
20028001014
应用未授权任何能力
确认应用是否授权能力
20028001018
应用未获得该能力
开通相关能力
20028003017
quota已用完
联系平台处理
20028001019
应用该能力已被封禁
该能力被封禁，联系平台处理
20028001007
参数不合法
根据错误信息检查请求参数是否填写正常