通用场景
用于服务商或商户查询其自己的店铺信息
公共请求参数
业务请求参数
shop_id|门店id条件必选string(32)
【描述】蚂蚁店铺id
【必选条件】store_id和 ip_role_id都为空时,shop_id必选
【示例值】2018011900502000000005124744
store_id|外部门店编号条件必选string(32)
【描述】门店编号,表示该门店在该商户角色id(直连pid,间连smid)下,由商户自己定义的外部门店编号
【必选条件】shop_id为空时, store_id ip_role_id 必须
【示例值】no0001
ip_role_id|商户角色id条件必选string(32)
【描述】商户角色id,表示将要开的店属于哪个商户角色。对于直连开店场景,填写商户pid;对于间连开店场景(线上、线下、直付通),填写商户smid
【必选条件】shop_id为空时, store_id ip_role_id 必须
【示例值】2088301155943087
address_version|行政区划版本可选string(32)
【描述】行政区划版本,当前可传空值(取默认版本)、2022q2、uptodate(取最新版本),其中空值默认为:2020q1版本( address_version=''或null),想要查看版本是2022年2季度版本则传入:(address_version='2022q2'),想要获取最新版本则传入:(address_version ='uptodate')
【枚举值】
默认版本行政区划: 空字符串
2020版本行政区划: 2020
2022q2版本行政区划: 2022q2
【示例值】2022q2
need_recommend|是否返回推荐信息可选string(10)
【描述】门店不置信时,是否需要返回shop_recommend_info
【枚举值】
需要: 1
不需要: 0
【示例值】0
常见请求示例
外部编号查询
内部编号查询
默认示例
curl 'https://openapi.alipay.com/gateway.do?charset=utf-8&method=ant.merchant.expand.shop.query&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=rsa2×tamp=${now}' \
-f 'app_auth_token=${app_auth_token}' \
-f 'biz_content={
"store_id":"no0001",
"ip_role_id":"2088301155943087"
}'
说明:本示例仅供参考。
公共响应参数
业务响应参数
store_id|商户侧门店编号必选string(128)
【描述】商户侧门店编号。表示该门店在该商户角色id(直连pid,间连smid)下,由商户自己定义的外部门店编号。若未传入 shop_id 则本参数与与ip_role_id均必填。
【示例值】no0001
shop_type|店铺经营类型必选string(2)
【描述】店铺经营类型
【枚举值】
直营: 01
加盟: 02
【示例值】01
ip_role_id|商户角色id必选string(32)
【描述】商户角色id,门店属于哪个商户角色。对于直连开店场景,为商户pid;对于间连开店场景(线上、线下、直付通),为商户smid。
【示例值】2088301155943087
shop_name|店铺名称必选string(128)
【描述】店铺名称。
【示例值】肯德基中关村店
shop_id|支付宝侧蚂蚁店铺 id必选string(32)
【描述】支付宝侧蚂蚁店铺 id
【示例值】2018011900502000000005124744
alipay_poiid|门店地址库id必选string(128)
【描述】门店地址库 id,按照一定的平台规则识别出的线下真实存在、真实经营的蚂蚁门店地址库 id,将作用于服务商的返佣激励、商品/券等权益的公域分发。如平台未返回alipay_poiid,请在确认门店信息真实有效后,稍后再进行查询。
【示例值】2022082900502055000000100000
new_shop_category|新版本门店类目标准二级类目code必选string(10)
【描述】新版门店类目标准二级类目code
【注意事项】类目标准及与原shop_category映射关系参见文档
【示例值】b0001
business_address|经营地址可选addressinfo
【描述】经营地址。
city_code|城市编码必选string(10)
【描述】城市编码。
蚂蚁店铺请按照 表格中填写。
直付通商户请按照 表格中内容填写。
【示例值】371000
district_code|区县编码必选string(10)
【描述】区县编码。
蚂蚁店铺请按照 表格中填写。
直付通商户请按照 表格中内容填写。
【示例值】371002
address|地址必选string(256)
【描述】地址。商户详细经营地址或人员所在地点
【示例值】万塘路18号黄龙时代广场b座
province_code|省份编码必选string(10)
【描述】省份编码。
蚂蚁店铺请按照 表格中填写。
直付通商户请按照 表格中内容填写。
【示例值】370000
poiid|高德poiid可选string(16)
【描述】高德poiid
【示例值】b0ffivu189
longitude|经度可选string(11)
【描述】经度,浮点型, 小数点后最多保留6位。
如需要录入经纬度,请以高德坐标系为准,录入时请确保经纬度参数准确。
【示例值】120.760001
latitude|纬度可选string(10)
【描述】纬度,浮点型,小数点后最多保留6位
如需要录入经纬度,请以高德坐标系为准,录入时请确保经纬度参数准确。
【示例值】60.270001
type|地址类型可选string(64)
【描述】地址类型。取值范围:business_address:经营地址(默认)
【枚举值】
经营地址: business_address
【示例值】business_address
shop_category|店铺类目可选string(10)
【描述】店铺类目,取值参见文件中的三级门店类目
【示例值】1001
contact_phone|店铺的联系固话可选string(512)
【描述】店铺的联系固话
【示例值】010-62286228
contact_mobile|店铺联系手机可选string(512)
【描述】店铺联系手机
【示例值】13901390139
cert_no|证件号码可选string(32)
【描述】证件号码
【示例值】9133010608210550xr
out_door_images|门头照链接可选string[](1024)
【描述】门头照,返回值为一个有访问时限的链接
【示例值】["https://mif-pub.alipayobjects.com/c6c0c7a1-b9d5-4e5d-b9d4-9eed39f00e65.jpg"]
cert_type|证件类型可选string(10)
【描述】证件类型,取值范围:201:营业执照;2011:多证合一(统一社会信用代码)。
【枚举值】
营业执照: 201
多证合一(统一社会信用代码): 2011
【示例值】201
cert_name|营业执照名称可选string(64)
【描述】营业执照名称,值为营业执照或统一社会信用代码证上的名称。
【示例值】xxxx小卖铺
cert_image|营业执照图片链接可选string(256)
【描述】营业执照图片url。返回值为一个有访问时限的链接
【示例值】https://mif-pub.alipayobjects.com/c6c0c7a1-b9d5-4e5d-b9d4-9eed39f00e65.jpg
legal_name|法人名称可选string(64)
【描述】法人名称。
【示例值】马云
legal_cert_no|法人身份证号可选string(18)
【描述】法人身份证号。
【示例值】100100198811110001
license_auth_letter_image|营业执照授权函链接可选string(256)
【描述】营业执照授权函。返回值为一个有访问时限的链接
【示例值】https://mif-pub.alipayobjects.com/c6c0c7a1-b9d5-4e5d-b9d4-9eed39f00e65.jpg
settle_alipay_logon_id|结算支付宝账号的登录号可选string(64)
【描述】结算支付宝账号的登录号
【示例值】demo@163.com
ext_infos|扩展信息列表可选shopextinfo[]
【描述】扩展信息列表。key值需要向对应行业的bd进行申请。
key_name|key值必选string(128)
【描述】kv数据对的key,表示该kv对象表示什么含义。
【示例值】shop_slogan
value|value值必选string(256)
【描述】kv对象的值
【示例值】我是标语
business_time|店铺经营时间可选shopbusinesstime[]
【描述】店铺经营时间。
week_day|开放时间必选number(1)
【描述】本对象表示周几的营业时间。1~6表示周一到周六,7表示周日
【示例值】1
open_time|开门时间必选string(16)
【描述】开门时间 格式:hh:mm
【示例值】09:30
close_time|关门时间必选string(16)
【描述】关门时间 格式:hh:mm
【示例值】22:00
contact_infos|联系人信息可选contactinfo[]
【描述】联系人信息。
name|联系人名字必选string(85)
【描述】联系人名字
【示例值】张三
以下参数 三选一 必选
phone|电话string(20)
【描述】电话
【示例值】0571-85022088
mobile|手机号string(20)
【描述】手机号
【示例值】13888888888
email|电子邮箱string(128)
【描述】电子邮箱
【示例值】user@domain.com
id_card_no|身份证号可选string(32)
【描述】身份证号
【示例值】110000199001011234
memo|备注可选string(256)
【描述】备注
【示例值】备注
brand_id|品牌id可选string(32)
【描述】品牌id
【示例值】20181026000001
scene|场景可选string(20)
【描述】场景
【示例值】park
shop_info_status|门店认证状态可选string(10)
【描述】当前名称、地址、经纬度信息准确一致,可用于数字化经营场景消费(如商品、券、消费圈等场域的分发),不影响门店支付结算
【枚举值】
已认证: 01
待优化: 02
审核中: 03
【示例值】01
shop_recommend_info|门店不置信推荐信息可选shoprecommendinfo
【描述】门店不置信推荐信息
unconfidence_reason|门店不置信原因可选string(200)
【描述】门店不置信原因
【示例值】店名不准确
recommend|门店修改建议可选string(200)
【描述】门店修改建议
【示例值】请修改店名为真实经营的门店名称,如有分店,请修改成品牌(分店名),如大润发(杭州西溪店)
recommend_name|建议名称可选string(50)
【描述】推荐门店名称
【示例值】大润发(杭州西溪店)
recommend_longtitude|建议经度可选string(50)
【描述】推荐经度,单位为度
【示例值】120.3333
recommend_latitude|建议纬度可选string(50)
【描述】推荐纬度,单位度
【示例值】30.111
recommend_address|建议地址可选string(200)
【描述】推荐详细地址
【示例值】杭州市西湖区**路**号
响应示例
正常示例
异常示例
{
"ant_merchant_expand_shop_query_response": {
"code": "10000",
"msg": "success",
"business_address": {
"city_code": "371000",
"district_code": "371002",
"address": "万塘路18号黄龙时代广场b座",
"province_code": "370000",
"poiid": "b0ffivu189",
"longitude": "120.760001",
"latitude": "60.270001",
"type": "business_address"
},
"shop_category": "1001",
"store_id": "no0001",
"shop_type": "01",
"ip_role_id": "2088301155943087",
"shop_name": "肯德基中关村店",
"shop_id": "2018011900502000000005124744",
"contact_phone": "010-62286228",
"contact_mobile": "13901390139",
"cert_no": "9133010608210550xr",
"out_door_images": [
"https://mif-pub.alipayobjects.com/c6c0c7a1-b9d5-4e5d-b9d4-9eed39f00e65.jpg"
],
"cert_type": "201",
"cert_name": "xxxx小卖铺",
"cert_image": "https://mif-pub.alipayobjects.com/c6c0c7a1-b9d5-4e5d-b9d4-9eed39f00e65.jpg",
"legal_name": "马云",
"legal_cert_no": "100100198811110001",
"license_auth_letter_image": "https://mif-pub.alipayobjects.com/c6c0c7a1-b9d5-4e5d-b9d4-9eed39f00e65.jpg",
"settle_alipay_logon_id": "demo@163.com",
"ext_infos": [
{
"key_name": "shop_slogan",
"value": "我是标语"
}
],
"business_time": [
{
"week_day": 1,
"open_time": "09:30",
"close_time": "22:00"
}
],
"contact_infos": [
{
"name": "张三",
"phone": "0571-85022088",
"mobile": "13888888888",
"email": "user@domain.com",
"id_card_no": "110000199001011234"
}
],
"memo": "备注",
"brand_id": "20181026000001",
"scene": "park",
"alipay_poiid": "2022082900502055000000100000",
"new_shop_category": "b0001",
"shop_info_status": "01",
"shop_recommend_info": {
"unconfidence_reason": "店名不准确",
"recommend": "请修改店名为真实经营的门店名称,如有分店,请修改成品牌(分店名),如大润发(杭州西溪店)",
"recommend_name": "大润发(杭州西溪店)",
"recommend_longtitude": "120.3333",
"recommend_latitude": "30.111",
"recommend_address": "杭州市西湖区**路**号"
}
},
"sign": "eritjkeijkjhkkkkkkkhjereeeeeeeeeee"
}
说明:本示例仅供参考。
公共错误码
业务错误码
错误码 | 错误描述 | 凯发app官方网站的解决方案 |
---|---|---|
system_error | 系统繁忙 | 服务器异常 可能发生了网络或者系统异常,导致服务调用失败,商户可以用同样的请求发起重试 |
address_version_code_illegal | 地址版本非法 | 地址版本非法,需传入指定的版本号 |
merchant_not_exist | 商户不存在 | 商户不存在,请更换入参参数 |
mer_argument_null | 入参对象为空 | 入参对象为空,请按照接口描述填入正确参数 |
not_allowed_settle | 未经商户ip_role_id授权,不允许进件(查询) | 未经商户ip_role_id授权,不允许进件(查询) |
relation_not_exist | isvpid与店铺无关系 | isvpid与店铺无关系,不能进行本操作 |
shop_not_exist | 店铺不存在 | 店铺不存在,请更换入参参数 |