alipay.offline.market.shop.create(创建门店信息) 在线调试(沙箱环境)

系统商需要通过该接口在口碑平台帮助商户创建门店信息。

公共参数

请求地址

环境HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.offline.market.shop.create
format String 40 仅支持JSON JSON
charset String 10 请求使用的编码格式,如utf-8,gbk,gb2312等 utf-8
sign_type String 10 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 RSA2
sign String 344 商户请求参数的签名串,详见签名 详见示例
timestamp String 19 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 2014-07-24 03:07:50
version String 3 调用的接口版本,固定为:1.0 1.0
notify_url String 256 支付宝服务器主动通知商户服务器里指定的页面http/https路径。 http://api.test.alipay.net/atinterface/receive_notify.htm
app_auth_token String 40 详见应用授权概述
biz_content String 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
store_id String 必选 32 外部门店编号;最长32位字符,该编号将作为收单接口的入参, 请开发者自行确保其唯一性。 hz001
category_id String 必选 32 类目id,请参考商户入驻要求 2015050700000018
brand_name String 可选 512 品牌名,不填写则默认为“其它品牌”。 肯德基
brand_logo String 可选 512 品牌LOGO; 图片ID,不填写则默认为门店首图main_image。 1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC
main_shop_name String 必选 20 主门店名 比如:肯德基;主店名里不要包含分店名,如“万塘路店”。主店名长度不能超过20个字符。 海底捞
branch_shop_name String 可选 20 分店名称,比如:万塘路店,与主门店名合并在客户端显示为:肯德基(万塘路店)。 万塘路店
province_code String 必选 10 省份编码,国标码,详见国家统计局数据 点此下载 110000
city_code String 必选 10 城市编码,国标码,详见国家统计局数据 点此下载 140500
district_code String 必选 10 区县编码,国标码,详见国家统计局数据 点此下载 140521
address String 必选 50 门店详细地址,地址字符长度在4-50个字符,注:不含省市区。门店详细地址按规范格式填写地址,以免影响门店搜索及活动报名:例1:道路+门牌号,“人民东路18号”;例2:道路+门牌号+标志性建筑+楼层,“四川北路1552号欢乐广场1楼”。 万塘路18号黄龙时代广场
longitude Number 必选 15 经度;最长15位字符(包括小数点), 注:高德坐标系。经纬度是门店搜索和活动推荐的重要参数,录入时请确保经纬度参数准确。高德经纬度查询:http://lbs.amap.com/console/show/picker 114.266418
latitude String 必选 15 纬度;最长15位字符(包括小数点), 注:高德坐标系。经纬度是门店搜索和活动推荐的重要参数,录入时请确保经纬度参数准确。高德经纬度查询:http://lbs.amap.com/console/show/picker 30.548828
contact_number String 必选 512 门店电话号码;支持座机和手机,只支持数字和+-号,在客户端对用户展现, 支持多个电话, 以英文逗号分隔。 13612344321,021-12336754
notify_mobile String 可选 512 门店店长电话号码;用于接收门店状态变更通知,收款成功通知等通知消息, 不在客户端展示。 13867498729
main_image String 必选 512 门店首图,非常重要,推荐尺寸2000*1500。 1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC
audit_images String 可选 4000 门店审核时需要的图片;至少包含一张门头照片,两张内景照片,必须反映真实的门店情况,审核才能够通过;多个图片之间以英文逗号分隔。 1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC,4Q8Pp00AT7eo9NoAJkMR3AAAACMAAUYT
business_time String 可选 256 请严格按"周一-周五 09:00-20:00,周六-周日 10:00-22:00"的格式进行填写,时间段不能重复,最多支持两个时间段,24小时营业请填写"00:00-23:59" 周一-周五 09:00-20:00,周六-周日 10:00-22:00
wifi String 可选 8 门店是否支持WIFI,T表示支持,F表示不支持,不传在客户端不作展示。 T
parking String 可选 8 门店是否支持停车,T表示支持,F表示不支持,不传在客户端不作展示。 F
value_added String 可选 256 门店其他的服务,门店与用户线下兑现。 免费茶水、免费糖果
isv_uid String 必选 16 ISV返佣id,门店创建、或者门店交易的返佣将通过此账号反给ISV,如果有口碑签订了返佣协议,则该字段作为返佣数据提取的依据。此字段必须是个合法uid,2088开头的16位支付宝会员账号,如果传入错误将无法创建门店。 2088001969784501
licence String 可选 512 门店营业执照图片,各行业所需的证照资质参见商户入驻要求 1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC
licence_code String 可选 255 门店营业执照编号,只支持输入中文,英文和数字,营业执照信息与is_operating_online至少填一项。 H001232
licence_name String 可选 255 门店营业执照名称。 来伊份上海分公司
business_certificate String 可选 512 许可证,各行业所需的证照资质参见商户入驻要求;该字段只能上传一张许可证,一张以外的许可证、除营业执照和许可证之外其他证照请放在其他资质字段上传。 1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC
business_certificate_expires String 可选 64 许可证有效期,格式:2020-03-20或长期。严格按照格式填写。 2020-03-20
auth_letter String 可选 512 门店授权函,营业执照与签约账号主体不一致时需要。 1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC
is_operating_online String 可选 8 是否在其他平台开店,T表示有开店,F表示未开店。 T
online_url String 可选 2000 其他平台开店的店铺链接url,多个url使用英文逗号隔开,isv迁移到新接口使用此字段,与is_operating_online=T配套使用。 http://www.******.com/shop/21831830
operate_notify_url String 可选 512 当商户的门店审核状态发生变化时,会向该地址推送消息。 http://abc.com
implement_id String 可选 256 机具号,多个之间以英文逗号分隔。 HU002,HT002
no_smoking String 可选 8 是否有无烟区,T表示有无烟区,F表示没有无烟区,不传在客户端不展示。 T
box String 可选 8 门店是否有包厢,T表示有,F表示没有,不传在客户端不作展示。 T
request_id String 必选 64 支持英文字母和数字,由开发者自行定义(不允许重复),在门店notify消息中也会带有该参数,以此标明本次notify消息是对哪个请求的回应。 2015123235324534
other_authorization String 可选 500 其他资质。用于上传营业证照、许可证照外的其他资质,除已上传许可证外的其他许可证也可以在该字段上传。 1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC,1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC
licence_expires String 可选 64 营业执照过期时间。格式:2020-10-20或长期。严格按照格式填写。 2020-10-20
op_role String 可选 16 表示以系统集成商的身份开店,开放平台现在统一传入ISV。 ISV
biz_version String 必选 10 店铺接口业务版本号,新接入的ISV,请统一传入2.0。 2.0

响应参数

参数 类型 是否必填 最大长度 描述 示例值
audit_status String 必填 16 同步请求如果支付宝受理成功,将返回AUDITING状态。 AUDITING
result_code String 选填 64 开店请求结果码:
WAIT_MERCHANT_CONFIRM:等待商户确认
当开店需要商户确认时返回此结果码,商户需要登录到商家中心e.alipay.com进行开店确认。例如,ISV帮商户开店时,出现需要改签口碑当面付主体,接口同步返回此错误码,并且支付宝发送短信告知商户登录商家中心进行改签确认,确认后进入到后续审核流程。
WAIT_MERCHANT_CONFIRM
apply_id String 选填 32 开店请求受理成功后返回的支付宝流水ID,根据此ID调用接口
alipay.offline.market.applyorder.batchquery,能够获取当前开店请求审核状态、驳回原因等信息。
2015111410223410000001
rate String 选填 8 门店费率值,指定的ISV可用。创建门店时,为符合情况的门店,进行费率单独设置。若费率不符合门店类目的设置,则会创建门店失败。 0.006

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayOfflineMarketShopCreateRequest request = new AlipayOfflineMarketShopCreateRequest();
request.setBizContent("{" +
"\"store_id\":\"hz001\"," +
"\"category_id\":\"2015050700000018\"," +
"\"brand_name\":\"肯德基\"," +
"\"brand_logo\":\"1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC\"," +
"\"main_shop_name\":\"海底捞\"," +
"\"branch_shop_name\":\"万塘路店\"," +
"\"province_code\":\"110000\"," +
"\"city_code\":\"140500\"," +
"\"district_code\":\"140521\"," +
"\"address\":\"万塘路18号黄龙时代广场\"," +
"\"longitude\":114.266418," +
"\"latitude\":\"30.548828\"," +
"\"contact_number\":\"13612344321,021-12336754\"," +
"\"notify_mobile\":\"13867498729\"," +
"\"main_image\":\"1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC\"," +
"\"audit_images\":\"1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC,4Q8Pp00AT7eo9NoAJkMR3AAAACMAAUYT\"," +
"\"business_time\":\"周一-周五 09:00-20:00,周六-周日 10:00-22:00\"," +
"\"wifi\":\"T\"," +
"\"parking\":\"F\"," +
"\"value_added\":\"免费茶水、免费糖果\"," +
"\"isv_uid\":\"2088001969784501\"," +
"\"licence\":\"1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC\"," +
"\"licence_code\":\"H001232\"," +
"\"licence_name\":\"来伊份上海分公司\"," +
"\"business_certificate\":\"1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC\"," +
"\"business_certificate_expires\":\"2020-03-20\"," +
"\"auth_letter\":\"1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC\"," +
"\"is_operating_online\":\"T\"," +
"\"online_url\":\"http://www.******.com/shop/21831830\"," +
"\"operate_notify_url\":\"http://abc.com\"," +
"\"implement_id\":\"HU002,HT002\"," +
"\"no_smoking\":\"T\"," +
"\"box\":\"T\"," +
"\"request_id\":\"2015123235324534\"," +
"\"other_authorization\":\"1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC,1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC\"," +
"\"licence_expires\":\"2020-10-20\"," +
"\"op_role\":\"ISV\"," +
"\"biz_version\":\"2.0\"" +
"  }");
AlipayOfflineMarketShopCreateResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_offline_market_shop_create_response": {
        "code": "10000",
        "msg": "Success",
        "audit_status": "AUDITING",
        "result_code": "WAIT_MERCHANT_CONFIRM",
        "apply_id": "2015111410223410000001",
        "rate": "0.006"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

{
    "alipay_offline_market_shop_create_response": {
        "code": "20000",
        "msg": "Service Currently Unavailable",
        "sub_code": "isp.unknow-error",
        "sub_msg": "系统繁忙"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

业务错误码

公共错误码

错误码错误描述解决方案
SHOP_CREATE_SYSTEM_ERROR 系统异常,操作失败 进行重试。
SHOP_CREATE_INVALID_PARAM 接口输入参数不合法 对照接口文档,检查传入参数。
SHOP_CREATE_UNIQUE_CONSTRAINT_SHOP_ERROR 当前门店已存在,可修改店名/品牌/地址重新尝试。 确认该店铺是否已经被开店,如未开店,可修改传入的品牌+店铺名称+店铺地址信息,再次尝试。
SHOP_CREATE_UNIQUE_CONSTRAINT_IMPLEMENTID_ERROR 机具号已经被使用,请使用其他未绑定门店的机具号。 使用其他未绑定的机具号,或删除机具号。
SHOP_CREATE_UNIQUE_CONSTRAINT_OUTSHOPID_ERROR 该外部门店编号已被当前商户使用,请勿重复。 使用其他外部门店编号。
SHOP_CREATE_CATOGORY_NOT_EXISTS 门店品类不存在,请重新选择品类。 使用接口(链接:https://doc.open.alipay.com/doc2/detail.htm?treeId=78&articleId=104497&docType=1)能够识别的品类ID。
SHOP_CREATE_SHOP_JUDGE_FAIL 当前门店已存在,请勿重复开店。 确认该店铺是否已经被开店。
SHOP_CREATE_LICENSE_EXPIRES 营业执照已过期。 检查营业执照是否过期。
SHOP_CREATE_CTU_FAIL 您创建的门店存在风险,请检查。 检查门店是否存在风险,比如商户PID是否存在诈骗记录等。
LICENSE_IS_REQUIRED 请填写营业执照认证信息。 请检查门店营业执照编号、营业执照图片、营业执照名称或营业执照有效期是否按要求填写。
CERTIFICATE_IS_REQUIRED 请填写许可证认证信息。 填写经营许可证信息。
SHOP_CATEGORY_NOT_MATCH_CITY 当前类目不允许在此城市运营。 当前类目在当前城市不开放,可以更换开店类目。
BRAND_CATEGORY_NOT_MATCH 您选择的品牌不属于该类目,请重新选择。 可以更换类目,或者更换品牌。
IMPLEMENT_ID_INVALID 机具号错误,请更换机具号或删除机具号。 检查机具号是否正确,可以更换机具号或删除机具号。
EXIST_FORBIDDEN_WORD 您填写的内容包含敏感词,请修改。 去除违禁词。
MERCHANT_NOT_EXIST 商户不存在,请使用正确的支付宝账号。 使用正确的支付宝账号。
LICENSE_CODE_REPEAT_ERROR 该证照已被使用,不可重复用于开店。 检查证照是否曾经开过店,部分类目不允许一证多开。
SHOP_CREATE_LICENSE_PRINCIPAL_NOT_MATCH 营业执照主体与商户账户不一致。 创建门店的商户账号信息需要跟营业执照主体账号信息一致。
SHOP_CREATE_LOCATION_VALIDATE_FAIL 您填写的地址与地图定位差距太大,请修改。 调整门店地址,或调整门店地图定位。
MERCHANT_NOT_A_CERTIFIED 商户没有做A类认证。 商户需要进行A类认证,认证后再开店。
SHOP_CREATE_REPEAT_REQUEST 店铺创建场景下重复请求。 商户重复提交开店请求,可以通过流水查询接口查询流水审核状态,后者等待开店审核结果通知。
MERCHANT_CAN_NOT_SIGN_KOUBEI 是否是口碑签约商户校验。 开店的商户必须是签约口碑主体当面付的商户,如果是支付宝主体会报错,需要商户改签。
AREA_CAN_NOT_NULL 店铺省市区信息不可为空。 填写省市区信息。
AREA_NOT_LEGALITY 店铺省市区信息不合法。 检查省市区编码填写是否正确,检查市编码与区编码不能相同。
LICENSE_NO_RULE_ERROR 营业执照格式有误,只能使用汉字、数字或者英文 查看开放平台请求中的营业执照编号字段,是否出现了非法字符
BUSINESS_TIME_RULE_ERROR 营业时间格式有误 查看开放平台传入的营业时间字段,现在只支持"周一-周五 09:00-20:00,周六-周日 10:00-22:00"这种格式
OUT_SHOP_ID_RULE_ERROR 外部门店编号格式有误 查看开发平台接口中外部门店store_id的字段,是否超过32位字符,其中中文2个字符,英文和数字1个字符
VALIDITYDATE_RULE_ERROR 经营许可证或营业执照有效期格式有误 查看开放平台经营许可证或营业执照有效期,只支持"2020-10-20"或者"长期"
RATE_STANDARD_NOT_EXIST 标准价格不存在 门店对应类目标准价格不存在,不要传费率
RATE_EXCEED_STANDARD_RANGE 定价超出范围 门店费率入参,超过门店类目的标准费率范围。请联系业务选取合适费率或不传费率。
SUBJECT_NO_SUPPORT_RATE 开店主体不支持定价 开店人不允许创建门店费率,请联系业务确定是否为名单内ISV
RATE_PATTERN_ERROR 费率格式有误 门店费率入参格式不匹配,必须为浮点数String且小数点后不超过4位
RATE_PAY_CATEGORY_ERROR 支付类目不支持定价 支付宝类目,口碑门店不支持设置门店费率。请不要传门店费率。

触发通知示例

https://www.merchant.com/receive_notify.htm?notify_type=trade_status_sync&notify_id=91722adff935e8cfa58b3aabf4dead6ibe&notify_time=2017-02-16 21:46:15&sign_type=RSA2&sign=WcO+t3D8Kg71dTlKwN7r9PzUOXeaBJwp8/FOuSxcuSkXsoVYxBpsAidprySCjHCjmaglNcjoKJQLJ28/Asl93joTW39FX6i07lXhnbPknezAlwmvPdnQuI01HZsZF9V1i6ggZjBiAd5lG8bZtTxZOJ87ub2i9GuJ3Nr/NUc9VeY=
onlineServer