Logo
    立即注册
    开放平台
    产品文档
    品牌查询
    最近更新时间:2023-04-19 18:09:59

    1.接口URL

    https://open.datastory.com.cn/api/datastory.ecommerce.brand.list 请求方式:POST 描述:通过该接口可根据“品牌名”模糊匹配或“品牌别称”精准匹配查看真实准确的品牌数据详情,具体输出内容可查看输出参数示例。

    2. 输入参数

    以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。

    参数名称 必选 默认值 类型 参数示例 描述
    appkey string "predeploy" 权限效验标识
    filters RequestBrandListFilters {"keyword":"vivo"} 筛选条件,json对象
    openStrategy boolean false 是否接受缓存
    page integer 1 分页查询的页码,默认1
    pageSize integer "20" 分页查询的单页数据条数,默认20

    3. 输出参数

    参数名称 必选 类型 参数示例 描述
    code integer 0 返回状态码,内部定义
    data Array of ResponseDataOfBrandListVO (见接口示例) 返回数据
    msg string "接口返回成功!" 接口返回信息说明,在接口返回失败时会有
    openStrategy boolean false 是否接受缓存
    success boolean true 接口返回是否成功

    4.1 Request Data Of RequestBrandListFilters

    参数名称 必选 类型 参数示例 描述
    keyword string "中华" 品牌别名(精确匹配)
    name string "中华" 品牌名(模糊匹配)

    4.2 Response Data Of BrandListVO

    参数名 必选 类型 参数示例 描述
    dataset [Array of BrandListVO] (见接口示例) 查询过滤条件
    dorisTime integer "458" 查询Doris耗时,单位毫秒
    meta array "list" 返回数据格式:list、aggregation、graph
    page integer 1 分页查询的页码
    pageSize integer "20" 分页查询的单页数据条数
    time integer "955" 查询总耗时,单位毫秒
    total integer "34500230" 查询数据总量

    4.2.1 BrandListVO

    参数名 必选 类型 参数示例 描述
    id integer "56" 品牌ID
    itemId string "56" 品牌itemId
    name string "华为" 品牌名称
    url string

    5. 示例

    示例1 查看品类下的评论详情

    根据某个品牌别称来查看该品牌标准名信息。

    输入示例

    {
      "appkey": "predeploy",
      "filters": {
        "name": "雅诗兰黛",
        "keyword": "雅诗lan黛"
      },
      "openStrategy": false,
      "page": 1,
      "pageSize": 20
    }
    

    输出示例

    {
      "success": true,
      "openStrategy": false,
      "code": 0,
      "msg": "接口返回成功!",
      "data": {
        "meta": {
          "datasetType": "list"
        },
        "dataset": [
          {
            "id": 4670,
            "itemId": "6a5143433325faa8048f5dd1d95fa8cd",
            "name": "雅诗兰黛",
            "url": "https://osscdn.datastory.com.cn/brand_picture/雅诗兰黛.jpg",
            "updateTimestamp": 1661875200000
          }
        ],
        "total": 1,
        "time": 113
      }
    }

    6. 状态码

    以下仅列出了接口业务逻辑相关的状态码。

    状态码 描述

    微信扫描二维码在线咨询