系统商通过该接口可以查询单个门店的详细信息,包括门店基础信息,门店状态等信息
| 环境 | HTTPS请求地址 |
|---|---|
| 正式环境 | https://openapi.alipay.com/gateway.do |
| 参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
| app_id | String | 是 | 32 | 支付宝分配给开发者的应用ID | 2014072300007148 |
| method | String | 是 | 128 | 接口名称 | alipay.offline.market.shop.querydetail |
| format | String | 否 | 40 | 仅支持JSON | JSON |
| charset | String | 是 | 10 | 请求使用的编码格式,如utf-8,gbk,gb2312等 | utf-8 |
| sign_type | String | 是 | 10 | 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 | RSA2 |
| sign | String | 是 | 256 | 商户请求参数的签名串,详见签名 | 详见示例 |
| timestamp | String | 是 | 19 | 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" | 2014-07-24 03:07:50 |
| version | String | 是 | 3 | 调用的接口版本,固定为:1.0 | 1.0 |
| app_auth_token | String | 否 | 40 | 详见应用授权概述 | |
| biz_content | String | 是 | - | 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档 |
| 参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
| shop_id | String | 必须 | 32 | 支付宝门店ID | 2015052100077000000000120773 |
| op_role | String | 可选 | 32 | 服务商及商户调用情况下务必传递。操作人角色,默认商户操作:MERCHANT;服务商操作:PROVIDER;ISV: 不需要填写 | MERCHANT或PROVIDER |
| 参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
| code | String | 是 | - | 网关返回码,详见文档 | 40004 |
| msg | String | 是 | - | 网关返回码描述,详见文档 | Business Failed |
| sub_code | String | 否 | - | 业务返回码,详见文档 | ACQ.TRADE_HAS_SUCCESS |
| sub_msg | String | 否 | - | 业务返回码描述,详见文档 | 交易已被支付 |
| sign | String | 是 | - | 签名,详见文档 | DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo= |
| 参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
| audit_status | String | 选填 | 16 | 门店审核状态,对于系统商而言,只有三个状态,AUDITING:审核中,AUDIT_FAILED:审核驳回,AUDIT_SUCCESS:审核通过。第一次审核通过会触发门店上架。 | AUDITING |
| audit_desc | String | 选填 | 255 | 门店审核状态描述,如果审核驳回则有相关的驳回理由 | 门店首图不符合规范 |
| is_online | String | 选填 | 16 | 门店是否上架,T表示上架,F表示未上架,第一次门店审核通过后会触发上架 | T |
| is_show | String | 选填 | 16 | 门店是否在客户端显示,T表示显示,F表示隐藏 | T |
| category_id | String | 选填 | 32 | 类目ID,类目初始数据由口碑提供 | 203 |
| brand_name | String | 选填 | 512 | 品牌名称;不填写则默认为“其它品牌” | 其它品牌 |
| brand_logo | String | 选填 | 512 | 品牌LOGO; 图片ID,不填写则默认为门店首图main_image | hOTQ1lT1TtOjcxGflvnUXgAAACMAAQED |
| main_shop_name | String | 选填 | 1024 | 主店名;比如:肯德基 | 肯德基 |
| branch_shop_name | String | 选填 | 1024 | 分店名称,比如:万塘路店,与主门店名合并在客户端显示为:肯德基(万塘路店) | 万塘路店 |
| province_code | String | 选填 | 10 | 省份编码,国标码,详见国家统计局数据 | 330000 |
| city_code | String | 选填 | 10 | 城市编码,国标码,详见国家统计局数据 | 330100 |
| district_code | String | 选填 | 10 | 区县编码,国标码,详见国家统计局数据 | 330101 |
| address | String | 选填 | 1024 | 门店详细地址,注:不含省市区 | 万塘路18号黄龙时代广场 |
| longitude | String | 选填 | 15 | 经度,最长15位字符(包括小数点), 注:高德坐标系 | 104.08296 |
| latitude | String | 选填 | 15 | 纬度,最长15位字符(包括小数点), 注:高德坐标系 | 38.65777 |
| contact_number | String | 选填 | 512 | 门店电话号码;支持座机和手机,在客户端对用户展现,支持多个电话,以英文逗号分隔 | 057126888888,18666668888 |
| store_id | String | 选填 | 32 | 外部门店编号;最长54位字符,该编号将作为收单接口的入参, 请开发者自行确保其唯一性 | hz001 |
| main_image | String | 选填 | 512 | 门店首图;非常重要,推荐尺寸2000*1500 | AM-uJRh2SRKz9N0r9zW4wQAAACMAAQEC |
| audit_images | String | 选填 | 4000 | 门店审核时需要的图片; 至少包含一张门头照片,两张内景照片,必须反映真实的门店情况,审核才能够通过, 多个以英文逗号分隔 | fTwPcLSxSa2VdNag2PqeKQAAACMAAQEC,bGG2pMF-SAGY444rjAEVigAAACMAAQEC |
| business_time | String | 选填 | 256 | 营业时间;支持分段营业时间,以英文逗号分隔 | 10:00-23:00 |
| wifi | String | 选填 | 8 | 门店是否支持WIFI,T表示支持,F表示不支持,不传在客户端不作展示 | T |
| parking | String | 选填 | 8 | 门店是否支持停车,T表示支持,F表示不支持,不传在客户端不作展示 | T |
| no_smoking | String | 选填 | 8 | 是否有无烟区,T表示有无烟区,F表示没有无烟区,不传在客户端不展示 | T |
| box | String | 选填 | 8 | 门店是否有包厢,T表示有,F表示没有,不传在客户端不作展示 | T |
| value_added | String | 选填 | 256 | 门店其他的服务,门店与用户线下兑现 | 生日专享:生日当天美甲享半价优惠 |
| avg_price | String | 选填 | 16 | 人均消费价格,最少1元,最大不超过99999元,请按实际情况填写;单位元; | 63 |
| isv_uid | String | 选填 | 64 | 开发者返佣ID,重要:如果有口碑签订了返佣协议,则该字段作为返佣数据提取的依据,需要与签约协议的PID保持一致, 该字段只能在创建接口中传入,不能在修改接口中被修改 | 2088xxx |
| licence | String | 选填 | 512 | 门店营业执照图片 | AM-uJRh2SRKz9N0r9zW4wQAAACMAAQEC |
| licence_code | String | 选填 | 255 | 门店营业执照编号 | 4406xxx |
| licence_name | String | 选填 | 255 | 门店营业执照名称 | 杭州市西湖区万塘路支小宝美甲店 |
| auth_letter | String | 选填 | 512 | 授权函图片 | AM-uJRh2SRKz9N0r9zW4wQAAACMAAQEC |
| is_operating_online | String | 选填 | 8 | 是否在其他平台开店,T表示有开店,F表示未开店,用于证明其开店资质 | F |
| online_image | String | 选填 | 2000 | 在其他平台的开店图片,支持多张,逗号分隔 | AM-uJRh2SRKz9N0r9zW4wQAAACMAAQEC |
| operate_notify_url | String | 选填 | 512 | 通知发送url;当商户的门店审核状态发生变化时,会向该地址推送消息 | http://example.com/gateway.do |
| implement_id | String | 选填 | 256 | 店铺使用的机具编号,多个以英文逗号分隔 | HA111,HA112 |
| payment_account | String | 选填 | 256 | 门店收款账户,门店收款账户只能被查询,不能通过接口修改。如果为空,则表示门店收款账户为商户签约账户 | testyufabu07@alipay.com |
| qr_code | String | 选填 | 512 | 门店收款二维码裸码 | https://tfs.alipay.com/images/mobilecodec/T1Y***QhXXhBe |
| processed_qr_code | String | 选填 | 512 | 经过加工后的门店收款二维码 | https://tfs.alipay.com/files/alipaygif***/T1WQhXXmtjX***7d20ca1072 |
| provider_xiaoer_uid | String | 选填 | 32 | 门店运营归属人uid | 2088******* |
| notify_mobile | String | 选填 | 512 | 门店店长电话号码;用于接收门店状态变更通知,收款成功通知等通知消息,不在客户端展示;多个以引文逗号分隔 | 13800000000,13688888888 |
| pic_coll | String | 选填 | 4000 | 图片集,是map转化成的json串,key是图片id,value是图片url | {"IUFIDASFIEUIOFKSFIUFE83IEI":"http://object.alipay.com/getpic.do?kjkdjkjj"} |
| business_certificate | String | 选填 | 512 | 经营许可证,只有餐饮类目需要 | hdYiHK85fHks |
| business_certificate_expires | String | 选填 | 64 | 经营许可证有效期,格式:2020-03-20,只有餐饮类目需要 | 长期 |
| licence_expires | String | 选填 | 64 | 营业执照过期时间 | 20200101 或长期 |
| partner_id | String | 选填 | 20 | 门店的签约ID | 2088101117656381 |
| pay_type | String | 选填 | 128 | 默认付款类型;如:付款码、扫码付、声波支付、在线买单、其它 | 付款码 |
| create_channel | String | 选填 | 128 | 门店创建来源;如:开放平台、支付宝客户端、口碑商家app、商家自主开店、服务商开店、全民开店-支付宝客户端、全民开店-商户app、其它 | 开放平台 |
| other_auth_images | String | 选填 | 2000 | 其它资质证明图片集;支持多张,逗号分隔 | AM-uJRh2SRKz9N0r9zW4wQAAACMAAQEC |
| gmt_shop_create | String | 选填 | 32 | 门店创建时间 | 2016-03-13 16:56:45 |
| gmt_shop_modified | String | 选填 | 32 | 门店修改时间 | 2016-03-13 16:56:45 |
| shop_tags | String | 选填 | 4000 | 门店标签;JSON格式。包括:keyMerchant-是否重点商户(T/F);isHallMeal-堂食(T/F);注:若标签 key 不存在,则门店无对应的标签 | {"keyMerchant":"T"} |
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayOfflineMarketShopQuerydetailRequest request = new AlipayOfflineMarketShopQuerydetailRequest();
request.setBizContent("{" +
"\"shop_id\":\"2015052100077000000000120773\"," +
"\"op_role\":\"MERCHANT或PROVIDER\"" +
" }");
AlipayOfflineMarketShopQuerydetailResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}
{
"alipay_offline_market_shop_querydetail_response":{
"msg":"Success",
"branch_shop_name":"万塘路店",
"parking":"T",
"business_certificate_expires":"长期",
"audit_status":"AUDITING",
"brand_logo":"hOTQ1lT1TtOjcxGflvnUXgAAACMAAQED",
"province_code":"330000",
"licence_name":"杭州市西湖区万塘路支小宝美甲店",
"implement_id":"HA111,HA112",
"business_certificate":"hdYiHK85fHks",
"longitude":"104.08296",
"main_shop_name":"肯德基",
"licence":"AM-uJRh2SRKz9N0r9zW4wQAAACMAAQEC",
"wifi":"T",
"licence_code":"4406xxx",
"brand_name":"其它品牌",
"auth_letter":"AM-uJRh2SRKz9N0r9zW4wQAAACMAAQEC",
"audit_desc":"门店首图不符合规范",
"is_operating_online":"F",
"payment_account":"testyufabu07@alipay.com",
"audit_images":"fTwPcLSxSa2VdNag2PqeKQAAACMAAQEC,bGG2pMF-SAGY444rjAEVigAAACMAAQEC",
"district_code":"330101",
"licence_expires":"20200101 或长期",
"code":"10000",
"main_image":"AM-uJRh2SRKz9N0r9zW4wQAAACMAAQEC",
"latitude":"38.65777",
"provider_xiaoer_uid":"2088*******",
"city_code":"330100",
"box":"T",
"avg_price":"63",
"isv_uid":"2088xxx",
"pic_coll":"{\"IUFIDASFIEUIOFKSFIUFE83IEI\":\"http://object.alipay.com/getpic.do?kjkdjkjj\"}",
"value_added":"生日专享:生日当天美甲享半价优惠",
"operate_notify_url":"http://example.com/gateway.do",
"partner_id":"2088101117656381",
"category_id":"203",
"notify_mobile":"13800000000,13688888888",
"qr_code":"https://tfs.alipay.com/images/mobilecodec/T1Y***QhXXhBe",
"shop_tags":"{\"keyMerchant\":\"T\"}",
"pay_type":"付款码",
"is_online":"T",
"store_id":"hz001",
"business_time":"10:00-23:00",
"address":"万塘路18号黄龙时代广场",
"processed_qr_code":"https://tfs.alipay.com/files/alipaygif***/T1WQhXXmtjX***7d20ca1072",
"other_auth_images":"AM-uJRh2SRKz9N0r9zW4wQAAACMAAQEC",
"online_image":"AM-uJRh2SRKz9N0r9zW4wQAAACMAAQEC",
"no_smoking":"T",
"gmt_shop_create":"2016-03-13 16:56:45",
"is_show":"T",
"contact_number":"057126888888,18666668888",
"gmt_shop_modified":"2016-03-13 16:56:45",
"create_channel":"开放平台"
},
"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
{
"alipay_offline_market_shop_querydetail_response":{
"msg":"Service Currently Unavailable",
"code":"20000",
"sub_msg":"系统繁忙",
"sub_code":"isp.unknow-error"
},
"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| INVALID_PARAM | 接口输入参数不合法 | 对照接口文档,检查传入参数 |
| SYSTEM_ERROR | 系统异常,操作失败 | 稍后进行重试 |
| INVALID_SHOPID | 无效的门店ID | 确认门店ID后重新提交查询 |
| NO_PROVIDER_SHOP_RELATION | 没有找到服务商、店铺关系 | 请确认服务商和店铺的关系,服务商没有查询权限 |