# 门店信息查询

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

接口英文名：getRetailInfo

查询已完成门店认证授权用户的门店信息

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/wxa/business/getretailinfo?access_token=ACCESS_TOKEN
```

### 云调用

- 本接口不支持云调用。

### 第三方调用

- 本接口支持第三方平台代商家调用。

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

- 服务商获得其中之一权限集授权后，可通过使用 [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](/miniprogram/dev/server/API/mp-access-token/api_getaccesstoken)、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "openid",
    "类型": "string",
    "必填": "否",
    "说明": "门店管理员/员工 openid。与手机号二选一，若都填写，优先使用 openid"
  },
  {
    "参数名": "mobile_phone",
    "类型": "string",
    "必填": "否",
    "说明": "手机号"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "mobile_phone",
    "类型": "string",
    "说明": "手机号"
  },
  {
    "参数名": "retail_type",
    "类型": "string",
    "说明": "一级门店类型"
  },
  {
    "参数名": "sub_retail_type",
    "类型": "string",
    "说明": "二级门店类型"
  },
  {
    "参数名": "retail_address",
    "类型": "string",
    "说明": "门店地址"
  },
  {
    "参数名": "retail_name",
    "类型": "string",
    "说明": "门店名称"
  },
  {
    "参数名": "identification",
    "类型": "string",
    "说明": "营业执照注册号"
  },
  {
    "参数名": "principal",
    "类型": "string",
    "说明": "企业名称"
  },
  {
    "参数名": "legal_person_name",
    "类型": "string",
    "说明": "法人姓名"
  },
  {
    "参数名": "openid",
    "类型": "string",
    "说明": "门店管理员/员工 openid。手机号查询时返回管理员 openid"
  },
  {
    "参数名": "role",
    "类型": "string",
    "说明": "角色。1：管理员，2：员工。手机号查询时返回管理员"
  },
  {
    "参数名": "status",
    "类型": "number",
    "说明": "认证状态。1：已完成认证"
  },
  {
    "参数名": "auth_time",
    "类型": "number",
    "说明": "认证时间戳"
  },
  {
    "参数名": "grant_time",
    "类型": "number",
    "说明": "授权时间戳"
  },
  {
    "参数名": "longitude",
    "类型": "number",
    "说明": "经度。门店定位信息，若门店未提交定位信息，则返回值里无该字段"
  },
  {
    "参数名": "latitude",
    "类型": "number",
    "说明": "纬度。门店定位信息，若门店未提交定位信息，则返回值里无该字段"
  },
  {
    "参数名": "business_type",
    "类型": "array",
    "说明": "一级主营商品"
  },
  {
    "参数名": "other_business_type",
    "类型": "string",
    "说明": "二级主营商品"
  },
  {
    "参数名": "staff_list",
    "类型": "objarray",
    "说明": "员工列表，包含管理员"
  }
]
```

">

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

员工列表，包含管理员

```json
[
  {
    "参数名": "openid",
    "类型": "string",
    "说明": "管理员/员工 openid"
  },
  {
    "参数名": "role",
    "类型": "number",
    "说明": "角色。1：管理员，2：员工"
  },
  {
    "参数名": "create_time",
    "类型": "number",
    "说明": "员工加入时间，管理员无该字段"
  }
]
```

## 4. 注意事项

本接口无特殊注意事项

## 5. 代码示例

请求示例

```json
{
    "openid": "xxxxx"
}
```

返回示例

```json
{
    "errcode": 0,
    "errmsg": "ok",
    "info": [
        {
            "mobile_phone": "12345678910",
            "retail_type": "餐饮店",
            "sub_retail_type": "",
            "retail_address": "广东省广州市海珠区新港中路397号TIT创意园",
            "retail_name": "张三烧烤店",
            "identification": "100000000000000001",
            "principal": "广州张三烧烤店",
            "legal_person_name": "张*",
            "openid": "xxxxxxxxxx",
            "status": 1,
            "auth_time": 1655458898,
            "grant_time": 1655458909,
            "longitude": 113.32531,
            "latitude": 23.0996132,
            "business_type": ["食品饮料", "餐饮"]
        }
    ]
}
```

## 6. 错误码

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

```json
[
  {
    "错误码": "-1",
    "错误描述": ""
  },
  {
    "错误码": "0",
    "错误描述": "成功"
  },
  {
    "错误码": "40001",
    "错误描述": "invalid credential, access_token is invalid or not latest。token 无效"
  },
  {
    "错误码": "41001",
    "错误描述": "access_token missing"
  },
  {
    "错误码": "42001",
    "错误描述": "access_token expired"
  },
  {
    "错误码": "47001",
    "错误描述": "data format error"
  },
  {
    "错误码": "48001",
    "错误描述": "api unauthorized 小程序无该api权限，反馈给对接人开通"
  },
  {
    "错误码": "61004",
    "错误描述": "access clientip is not registered, not in ip-white-list"
  },
  {
    "错误码": "61007",
    "错误描述": "api is unauthorized to component"
  },
  {
    "错误码": "9404101",
    "错误描述": "非法参数"
  },
  {
    "错误码": "9404102",
    "错误描述": "该店主不存在、未认证或者未授权给你"
  },
  {
    "错误码": "9404103",
    "错误描述": "请求过于频繁，请稍后重试"
  }
]
```

## 7. 适用范围

本接口暂未明确可调用账号类型，或在业务中根据调用传参自行确定是否可调用，请以实际调用情况为准。