# 获取品牌库列表

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：getallbrandslogic

通过该接口可以获取微信小店的品牌库列表。品牌库是微信小店维护的全局品牌数据，新增品牌资质前需先通过本接口获取目标品牌的 brand_id。 

[品牌资质开发指南](/doc/store/shop/guide/catalog/brand)

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/shop/ec/brand/all?access_token=ACCESS_TOKEN
```

### 云调用

- 本接口不支持云调用。

### 第三方调用

- 本接口支持第三方平台代微信小店商家调用。[第三方服务商调用模式介绍](/doc/store/shop/dev_before/third_party_platforms)

- 该接口所属的权限集 id 为：85、129、192

- 服务商获得其中之一权限集授权后，可通过使用 [authorizer_access_token](/doc/oplatform/developers/dev/AuthorizerAccessToken.md) 代微信小店商家进行调用，具体可查看 [第三方调用](/doc/oplatform/Third-party_Platforms/2.0/Before_Develop/call_interface.md) 说明文档。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "示例": "ACCESS_TOKEN",
    "说明": "接口调用凭证，可使用 [access_token](/doc/store/shop/API/apimgnt/common/api_getaccesstoken)（微信小店商家）、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)（服务商代调用）"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "page_size",
    "类型": "number",
    "必填": "是",
    "示例": "5",
    "说明": "每页数量，默认 10，不超过 50"
  },
  {
    "参数名": "next_key",
    "类型": "string",
    "必填": "否",
    "示例": "",
    "说明": "由上次请求返回，记录翻页的上下文，传入时会从上次返回的结果往后翻一页，不传则默认获取第一页数据"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "示例": "0",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "示例": "ok",
    "说明": "错误信息"
  },
  {
    "参数名": "brands",
    "类型": "objarray",
    "示例": "",
    "说明": "品牌库中的品牌信息"
  },
  {
    "参数名": "next_key",
    "类型": "string",
    "示例": "10000005",
    "说明": "本次翻页的上下文，用于请求下一页"
  },
  {
    "参数名": "continue_flag",
    "类型": "boolean",
    "示例": "true",
    "说明": "是否还有下一页内容"
  }
]
```

">

### Res.brands(Array) `Object Payload`

品牌库中的品牌信息

```json
[
  {
    "参数名": "brand_id",
    "类型": "string",
    "示例": "10000000",
    "说明": "品牌库中的品牌编号"
  },
  {
    "参数名": "ch_name",
    "类型": "string",
    "示例": "碧芭宝贝",
    "说明": "品牌商标中文名"
  },
  {
    "参数名": "en_name",
    "类型": "string",
    "示例": "beaba",
    "说明": "品牌商标英文名"
  }
]
```

## 4. 注意事项

本接口无特殊注意事项

## 5. 代码示例

请求示例

```json
{
    "page_size": 5
}
```

返回示例

```json
{
    "errcode": 0,
    "errmsg": "ok",
    "brands": [
        {
            "brand_id": "10000000",
            "ch_name": "碧芭宝贝",
            "en_name": "beaba"
        },
        {
            "brand_id": "10000001",
            "ch_name": "中兴",
            "en_name": "ZTE"
        }
    ],
    "next_key": "10000002",
    "continue_flag": true
}
```

## 6. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/store/shop/dev_before/commErrCode)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

```json
[
  {
    "错误码": "10020050",
    "错误描述": "无权限调用该 api",
    "解决方案": "检查 access_token 与权限集授权"
  },
  {
    "错误码": "10020055",
    "错误描述": "参数有误",
    "解决方案": "检查参数格式"
  }
]
```

## 7. 适用范围

本接口在不同账号类型下的可调用情况：

```json
[
  {
    "微信小店": "✔",
    "小店供货商": "✔"
  }
]
```

- ✔：该账号可调用此接口。
- 其他未明确声明的账号类型，如无特殊说明，均不可调用此接口。