# 预录入门店信息
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:batchcreateretail
通过本API可提前预录入门店信息。
场景说明:对于已提前预录入门店信息的用户,在登录小程序进行门店认证授权流程时,会默认拉起展示预录入的门店信息,用户一键确认即可完成认证授权,减少用户操作成本,提示认证授权成功率。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxa/business/batchcreateretail?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
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| retail_info_list | objarray | 是 | 门店信息列表。每次调用最多可导入 100 个门店 |
# Body.retail_info_list(Array) Object Payload
门店信息列表。每次调用最多可导入 100 个门店
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| mobile_phone | string | 是 | 手机号 |
| retail_name | string | 是 | 门店名称。长度限制 1-100 个字符,一个中文字等于 2 个字符 |
| retail_type | string | 否 | 一级门店类型。可选项:"杂货店"、"便利店"、"超市"、"餐饮店"、"母婴店"、"烟酒店"、"其他" |
| sub_retail_type | string | 否 | 二级门店类型。一级类型为 "其他" 时必填 |
| address_province | string | 是 | 门店地址,省 |
| address_city | string | 是 | 门店地址,市 |
| address_region | string | 是 | 门店地址,区县 |
| address_street | string | 是 | 门店地址,街道详细地址 |
| registration_number | string | 是 | 营业执照注册号 |
| biz_name | string | 否 | 企业名称 |
| corporation_name | string | 否 | 法人姓名 |
| latitude | number | 否 | 纬度 |
| longitude | number | 否 | 经度 |
| business_type | array | 否 | 一级主营商品。可选项:"食品饮料", "餐饮", "生鲜果蔬(含鲜花)", "烟酒", "鞋服内衣", "个护美妆", "3C数码", "家用电器", "汽修/汽配", "医药/医疗器械", "家装/五金/建材", "家居家纺", "文具玩具", "母婴", "宠物", "其他" |
| other_business_type | string | 否 | 二级主营商品。一级主营商品包含 "其他" 时必填 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| num_success | number | num_success |
| num_failure | number | num_failure |
| failure_record_list | objarray | failure_record_list |
# Res.failure_record_list(Array) Object Payload
failure_record_list
| 参数名 | 类型 | 说明 | 枚举 |
|---|---|---|---|
| mobile_phone | string | 手机号 | - |
| registration_number | string | 营业执照注册号 | - |
| failure_code | number | failure_code | 枚举值 |
# 4. 枚举信息
# Res.failure_record_list(Array).failure_code Enum
failure_code
| 枚举值 | 描述 |
|---|---|
| 2 | 无效的手机号 |
| 3 | 无效的门店类型 |
| 4 | 地址解析失败 |
| 5 | 手机号已被录入门店信息 |
| 6 | 无效的门店名称(长度限制为 1-100 个字符,一个中文字等于 2 个字符) |
| 7 | 无效的主营商品 |
# 5. 注意事项
# 常见QA
1、预录入门店信息后,调取信息完成认证正确方式,以及为什么会出现报错情况?
答:①品牌帮预录入门店信息:假设手机A被品牌预录入门店信息,任何微信号都可以登录手机A+验证码获取门店信息。一旦门店信息被调取,就需要用最初登录手机A调取门店信息的微信号继续完成认证,否则使用其他微信号会报错。
②门店自行预录入门店信息:假设微信号A登录手机B+验证码预录入过门店部分信息后退出插件,后面使用别的微信号登录手机B+验证码调取之前预录入信息继续完成认证是会报错的,需要用最初微信号A登录手机号B+验证码方可调取。
注:无论是哪种预录入情况,完成门店认证流程并认证成功,任何微信都可以调取同一个手机号+验证码获取已认证门店信息和进行门店信息修改
# 6. 代码示例
请求示例
{
"retail_info_list": [
{
"mobile_phone": "12345678910",
"retail_name": "张三烧烤店",
"retail_type": "餐饮店",
"address_province": "广东省",
"address_city": "广州市",
"address_region": "海珠区",
"address_street": "新港中路397号TIT创意园",
"longitude": 113.32531,
"latitude": 23.0996132
},
{
"mobile_phone": "a123456789",
"retail_type": "便利店",
"address_province": "广东省",
"address_city": "广州市",
"address_region": "海珠区",
"address_street": "新港中路397号TIT创意园",
"registration_number": "xxxxx",
"biz_name": "xxxxx",
"corporation_name": "xxxxx"
}
]
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"num_success": 1,
"num_failure": 1,
"failure_record_list": [
{
"mobile_phone": "a123456789",
"registration_number": "",
"failure_code": 6
}
]
}
# 7. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 |
|---|---|
| -1 | 系统繁忙,请稍后重试 |
| 0 | 成功 |
| 40001 | invalid credential, access_token is invalid or not latest。 token 无效 |
| 41001 | access_token missing |
| 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 |
| 9404000 | 上传数量过多 |
| 9404001 | 门店信息参数缺失 |
# 8. 适用范围
本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请以实际调用情况为准。