# 查询区域仓库列表

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

接口英文名：getwarehouselist

通过该接口可对区域仓库列表进行查询，查询结果将按照创建时间升序排序。

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/channels/ec/warehouse/list/get?access_token=ACCESS_TOKEN
```

### 云调用

- 调用方法：channels.ec.warehouse.list.get

- 出入参和 HTTPS 调用相同，调用方式可查看 [云调用](/doc/oplatform/developers/dev/cloudCall.md) 说明文档。

### 第三方调用

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

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

- 服务商获得其中之一权限集授权后，可通过使用 [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",
    "必填": "是",
    "说明": "每页数量（最大不超过10）"
  },
  {
    "参数名": "next_key",
    "类型": "string",
    "必填": "否",
    "说明": "由上次请求返回，记录翻页的上下文。传入时会从上次返回的结果往后翻一页，不传默认获取第一页数据"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息"
  },
  {
    "参数名": "data",
    "类型": "object",
    "说明": "data"
  }
]
```

### Res.data `Object Payload`

data

```json
[
  {
    "参数名": "out_warehouse_ids",
    "类型": "array",
    "说明": "外部仓库ID"
  },
  {
    "参数名": "next_key",
    "类型": "string",
    "说明": "本次翻页的上下文，用于请求下一页，如果是空，则当前是最后一页"
  }
]
```

## 4. 注意事项

本接口无特殊注意事项

## 5. 代码示例

请求示例

```json
{
    "page_size": 1,
    "next_key": ""
}

```

返回示例

```json
{
    "errcode": 0,
    "errmsg": "ok",
    "data": {
        "out_warehouse_ids": ["test1"],
        "next_key": "CK+h/+vJMA=="
    }
}

```

## 6. 错误码

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

## 7. 适用范围

本接口支持「微信小店」账号类型调用。其他账号类型如无特殊说明，均不可调用。