微信门店接口
更新日志:
版本号 | 更新内容 | 更新时间 |
V2.1 | 创建门店可以返回临时poiid | 2016.7.18 |
http://lbs.qq.com/tool/getpoint/index.html
注意:经纬度坐标需要转换为腾讯地图坐标。
详见链接:
http://lbs.qq.com/webservice_v1/guide-convert.html
新创建的门店在审核通过后,会以事件形式推送给商户填写的回调URL(登陆公众平台进入“开发者中心”设置)
微信服务器在五秒内收不到响应会断掉连接,并且重新发起请求,总共重试三次。 关于重试的消息排重,推荐使用FromUserName + CreateTime 排重。
假如服务器无法保证在五秒内处理并回复,可以直接回复空串,微信服务器不会对此作任何处理,并且不会发起重试。
推送XML数据包示例:
<xml>
<ToUserName><![CDATA[toUser]]></ToUserName>
<FromUserName><![CDATA[fromUser]]></FromUserName>
<CreateTime>1408622107</CreateTime>
<MsgType><![CDATA[event]]></MsgType>
<Event><![CDATA[poi_check_notify]]></Event>
<UniqId><![CDATA[123adb]]></UniqId>
<PoiId><![CDATA[123123]]></PoiId>
<Result><![CDATA[fail]]></Result>
<msg><![CDATA[xxxxxx]]></msg>
</xml>
参数说明:
字段 | 说明 |
ToUserName | 发送方帐号(一个OpenID) |
FromUserName | 错误信息 |
CreateTime | 消息创建时间(整型) |
MsgType | 消息类型,event |
Event | 事件类型,poi_check_notify |
UniqId | 商户自己内部ID,即字段中的sid |
PoiId | 微信的门店ID,微信内门店唯一标示ID |
Result | 审核结果,成功succ 或失败fail |
msg | 成功的通知信息,或审核失败的驳回理由 |
接口说明
创建门店后获取poi_id 后,商户可以利用poi_id,查询具体某条门店的信息。 若在查询时,update_status 字段为1,表明在5 个工作日内曾用update 接口修改过门店扩展字段,该扩展字段为最新的修改字段,尚未经过审核采纳,因此不是最终结果。最终结果会在5 个工作日内,最终确认是否采纳,并前端生效(但该扩展字段的采纳过程不影响门店的可用性,即available_state仍为审核通过状态)
注:扩展字段为公共编辑信息(大家都可修改),修改将会审核,并决定是否对修改建议进行采纳,但不会影响该门店的生效可用状态。
接口调用请求说明
协议 | https |
http请求方式 | POST |
请求Url | http://api.weixin.qq.com/cgi-bin/poi/getpoi?access_token=TOKEN |
POST数据格式 | json |
请求参数说明
参数 | 说明 | 是否必填 |
access_token | 调用接口凭证 | 是 |
buffer | json数据 | 是 |
POST数据示例
{
"poi_id":"271262077"
}
返回数据说明
数据示例
{
"errcode":0,
"errmsg":"ok",
"business ":{
"base_info":{
"sid":"001",
"business_name":"麦当劳",
"branch_name":"艺苑路店",
"province":"广东省",
"city":"广州市",
"address":"海珠区艺苑路11 号",
"telephone":"020-12345678",
"categories":["美食,小吃快餐"],
"offset_type":1,
"longitude":115.32375,
"latitude":25.097486,
"photo_list":[{"photo_url":"https:// XXX.com"} , {"photo_url":"https://XXX.com"}],
"recommend":"麦辣鸡腿堡套餐,麦乐鸡,全家桶",
"special":"免费wifi,外卖服务",
"introduction":"麦当劳是全球大型跨国连锁餐厅,1940 年创立于美国,在世界上大
约拥有3 万间分店。主要售卖汉堡包,以及薯条、炸鸡、汽水、冰品、沙拉、水果等快餐食品",
"open_time":"8:00-20:00",
"avg_price":35
"available_state":3
"update_status":0
}
}
}
字段 | 说明 |
errcode | 错误码,0为正常 |
errmsg | 错误信息 |
available_state | 门店是否可用状态。1 表示系统错误、2 表示审核中、3 审核通过、4 审核驳回。当该字段为1、2、4 状态时,poi_id 为空 |
update_status | 扩展字段是否正在更新中。1 表示扩展字段正在更新中,尚未生效,不允许再次更新; 0 表示扩展字段没有在更新中或更新已生效,可以再次更新 |
business | 门店信息,字段内容同前 |
*注其他字段同前
接口说明
商户可以通过该接口,批量查询自己名下的门店list,并获取已审核通过的poi_id(所有状态均会返回poi_id,但该poi_id不一定为最终id)、商户自身sid 用于对应、商户名、分店名、地址字段。
接口调用请求说明
协议 | https |
http请求方式 | POST |
请求Url | https://api.weixin.qq.com/cgi-bin/poi/getpoilist?access_token=TOKEN |
POST数据格式 | json |
请求参数说明
参数 | 说明 | 是否必填 |
access_token | 调用接口凭证 | 是 |
buffer | json数据 | 是 |
POST数据示例
{
"begin":0,
"limit":10
}
字段说明
字段 | 说明 | 是否必填 |
begin | 开始位置,0 即为从第一条开始查询 | 是 |
limit | 返回数据条数,最大允许50,默认为20 | 是 |
返回数据说明
数据示例:
为审核通过,有poi_id,全部字段;第二条为审核不通过,仅有基础字段;第三条为审核中,仅有基础字段。
{
"errcode":0,
"errmsg":"ok"
"business_list":[
{"base_info":{
"sid":"101",
"business_name":"麦当劳",
"branch_name":"艺苑路店",
"address":"艺苑路11号",
"telephone":"020-12345678",
"categories":["美食,快餐小吃"],
"city":"广州市",
"province":"广东省",
"offset_type":1,
"longitude":115.32375,
"latitude":25.097486,
"photo_list":[{"photo_url":"http: ...."}],
"introduction":"麦当劳是全球大型跨国连锁餐厅,1940 年创立于美国,在世界上大约拥有3 万间分店。主要售卖汉堡包,以及薯条、炸鸡、汽水、冰品、沙拉、水果等快餐食品",
"recommend":"麦辣鸡腿堡套餐,麦乐鸡,全家桶",
"special":"免费wifi,外卖服务",
"open_time":"8:00-20:00",
"avg_price":35,
"poi_id":"285633617",
"available_state":3,
"district":"海珠区",
"update_status":0
}},
{"base_info":{
"sid":"101",
"business_name":"麦当劳",
"branch_name":"北京路店",
"address":"北京路12号",
"telephone":"020-12345689",
"categories":["美食,快餐小吃"],
"city":"广州市",
"province":"广东省",
"offset_type":1,
"longitude":115.3235,
"latitude":25.092386,
"photo_list":[{"photo_url":"http: ...."}],
"introduction":"麦当劳是全球大型跨国连锁餐厅,1940 年创立于美国,在世界上大约拥有3 万间分店。主要售卖汉堡包,以及薯条、炸鸡、汽水、冰品、沙拉、水果等快餐食品",
"recommend":"麦辣鸡腿堡套餐,麦乐鸡,全家桶",
"special":"免费wifi,外卖服务",
"open_time":"8:00-20:00",
"avg_price":35,
"poi_id":"285633618",
"available_state":4,
"district":"越秀区",
"update_status":0
}},
{"base_info":{
"sid":"101",
"business_name":"麦当劳",
"branch_name":"龙洞店",
"address":"迎龙路122号",
"telephone":"020-12345659",
"categories":["美食,快餐小吃"],
"city":"广州市",
"province":"广东省",
"offset_type":1,
"longitude":115.32345,
"latitude":25.056686,
"photo_list":[{"photo_url":"http: ...."}],
"introduction":"麦当劳是全球大型跨国连锁餐厅,1940 年创立于美国,在世界上大约拥有3 万间分店。主要售卖汉堡包,以及薯条、炸鸡、汽水、冰品、沙拉、水果等快餐食品",
"recommend":"麦辣鸡腿堡套餐,麦乐鸡,全家桶",
"special":"免费wifi,外卖服务",
"open_time":"8:00-20:00",
"avg_price":35,
"poi_id":"285633619",
"available_state":2,
"district":"天河区",
"update_status":0
}},
],
"total_count":"3",
}
参数 | 说明 |
access_token | 调用接口凭证 |
buffer | json数据 |
total_count | 门店总数量 |
接口说明
商户可以通过该接口,修改门店的服务信息,包括:sid、图片列表、营业时间、推荐、特色服务、简介、人均价格、电话8个字段(名称、坐标、地址等不可修改)修改后需要人工审核。
接口调用请求说明
协议 | https |
http请求方式 | POST/FROM |
请求Url | https://api.weixin.qq.com/cgi-bin/poi/updatepoi?access_token=TOKEN |
POST数据格式 | buffer |
请求参数说明
参数 | 说明 | 是否必填 |
access_token | 调用接口凭证 | 是 |
buffer | json数据 | 是 |
POST数据示例
{"business ":{
"base_info":{
"poi_id ":"271864249"
"sid":"A00001"
"telephone ":"020-12345678"
"photo_list":[{"photo_url":"https:// XXX.com"},{"photo_url":"https://XXX.com"}],
"recommend":"麦辣鸡腿堡套餐,麦乐鸡,全家桶",
"special":"免费wifi,外卖服务",
"introduction":"麦当劳是全球大型跨国连锁餐厅,1940 年创立于美国,在世界上大约拥有3 万间分店。主要售卖汉堡包,以及薯条、炸鸡、汽水、冰品、沙拉、水果等快餐食品",
"open_time":"8:00-20:00",
"avg_price":35
}
}
}
字段说明:
全部字段内容同前。
特别注意:
以上8个字段,若有填写内容则为覆盖更新,若无内容则视为不修改,维持原有内容。 photo_list 字段为全列表覆盖,若需要增加图片,需将之前图片同样放入list 中,在其后增加新增图片。如:已有A、B、C 三张图片,又要增加D、E 两张图,则需要调用该接口,photo_list 传入A、B、C、D、E 五张图片的链接。
返回数据说明
数据示例:
{
"errcode":0,
"errmsg":"ok"
}
字段 | 说明 |
errcode | 错误码,0为正常 |
errmsg | 错误信息 |
接口说明
商户可以通过该接口,删除已经成功创建的门店。请商户慎重调用该接口。
接口调用请求说明
协议 | https |
http请求方式 | POST/FROM |
请求Url | https://api.weixin.qq.com/cgi-bin/poi/delpoi?access_token=TOKEN |
POST数据格式 | buffer |
请求参数说明
参数 | 说明 |
access_token | 调用接口凭证 |
POST | json数据 |
POST数据示例
{
"poi_id": "271262077"
}
字段说明:
字段 | 说明 |
poi_id | 门店ID |
返回数据说明
数据示例:
{
"errcode":0,
"errmsg":"ok"
}
字段 | 说明 |
errcode | 错误码,0为正常 |
errmsg | 错误信息 |
接口说明
类目名称接口是为商户提供自己门店类型信息的接口。门店类目定位的越规范,能够精准的吸引更多用户,提高曝光率。
接口调用的请求说明
协议 | https |
http请求方式 | GET |
请求Url | http://api.weixin.qq.com/cgi-bin/poi/getwxcategory?access_token=TOKEN |
返回数据说明
{
"category_list":
["美食,江浙菜,上海菜","美食,江浙菜,淮扬菜","美食,江浙菜,浙江菜","美食,江浙菜,南京菜 ","美食,江浙菜,苏帮菜…"]
}
错误码 | errmsg | 说明 |
-1 | system error | 系统错误,请稍后重试 |
40009 | Invalid image size | 图片大小为0或者超过1M |
40097 | invalid args | 参数不正确,请参考字段要求检查json 字段 |
65104 | invalid category | 门店的类型不合法,必须严格按照附表的分类填写 |
65105 | invalid photo url | 图片url 不合法,必须使用接口1 的图片上传接口所获取的url |
65106 | poi audit state must be approved | 门店状态必须未审核通过 |
65107 | not allow modify | 扩展字段为不允许修改的状态 |
65109 | invalid business | 门店名为空 |
65110 | invalid address | 门店所在详细街道地址为空 |
65111 | invalid telephone | 门店的电话为空 |
65112 | invalid city | 门店所在的城市为空 |
65113 | invalid province | 门店所在的省份为空 |
65114 | empty photo list | 图片列表为空 |
65115 | invalid poi id | poi_id 不正确 |
更多错误码请参考“基础支持-全局返回码说明”
遇到问题,可以加入开发者交流群 463320265联系我们,验证请说明所属商家和业务。