# 门店信息查询
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:getRetailInfo
查询已完成门店认证授权用户的门店信息
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxa/business/getretailinfo?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
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| openid | string | 否 | 门店管理员/员工 openid。与手机号二选一,若都填写,优先使用 openid |
| mobile_phone | string | 否 | 手机号 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| 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
员工列表,包含管理员
| 参数名 | 类型 | 说明 |
|---|---|---|
| openid | string | 管理员/员工 openid |
| role | number | 角色。1:管理员,2:员工 |
| create_time | number | 员工加入时间,管理员无该字段 |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
请求示例
{
"openid": "xxxxx"
}
返回示例
{
"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. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 |
|---|---|
| -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. 适用范围
本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请以实际调用情况为准。