# 全量授权门店查询
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:getRetailOpenidList
该接口用于拉取小程序下所有已授权门店信息。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxa/business/getretailopenidlist?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用。
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:158
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String Parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| limit | number | 是 | 分页拉取最大返回结果数。取值范围:1-100 |
| page_context | string | 是 | 分页上下文。每轮遍历的首次调用传空值,后续调用填上一次调用返回参数的 page_context |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| openid_list | array | openid 列表 |
| page_context | string | 分页上下文 |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
请求示例
{
"limit": 100,
"page_context": ""
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"openid_list": ["openid1", "openid2", "..."],
"page_context": "page_context1"
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 |
|---|---|
| 0 | 成功 |
| 40001 | invalid credential, access_token is invalid or not latest。token 无效 |
| 48001 | api unauthorized 小程序无该api权限,反馈给对接人开通 |
| 61007 | api is unauthorized to component |
| 9404151 | 无效的分页拉取最大返回结果数 |
| 9404152 | 无效的分页上下文 |
# 7. 适用范围
本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请以实际调用情况为准。