用于进行门店摘要信息批量查询接口。
| 环境 | HTTPS请求地址 |
|---|---|
| 正式环境 | https://openapi.alipay.com/gateway.do |
| 参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
| app_id | String | 是 | 32 | 支付宝分配给开发者的应用ID | 2014072300007148 |
| method | String | 是 | 128 | 接口名称 | alipay.offline.market.shop.summary.batchquery |
| 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 | 是 | - | 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档 |
| 参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
| op_role | String | 必须 | 16 | 表示接口业务的调用方身份:ISV、 服务商身份标识。传入ISV代表系统集成商身份。传入PROVIDER代表服务商。 | ISV、PROVIDER |
| query_type | String | 必须 | 20 | 门店数据查询类型,根据类型可以返回指定的门店数据,目前支持的类型如下:
BRAND_RELATION : 品牌商关联店铺 MALL_SELF :MALL自己的门店 MALL_RELATION:MALL关联下的门店 MERCHANT_SELF:商户自己的门店 KB_PROMOTER:口碑客推广者 |
BRAND_RELATION |
| related_partner_id | String | 可选 | 16 | query_type查询类型下所关联的商户PID | 2088001969784501 |
| shop_id | String | 可选 | 32 | 门店ID | 2015062100077000000000120773 |
| shop_status | String | 可选 | 50 | 门店状态,传入多个状态,多个状态使用英文逗号隔开,例如:PAUSED,OPEN
店铺状态:OPEN(营业)、PAUSED(暂停)、INIT(初始)、FREEZE(冻结)、CLOSED(关店) |
PAUSED |
| page_no | Number | 可选 | 9 | 页码,留空标示第一页,默认 20个结果为一页 | 1 |
| page_size | Number | 可选 | 3 | 每页记录数,默认20,最大 100 | 20 |
| 参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
| 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= |
| 参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
| page_size | String | 必填 | 3 | 每页记录数 | 20 |
| current_page_no | String | 必填 | 9 | 当前页码 | 1 |
| total_page_no | String | 必填 | 9 | 总页码数目 | 3 |
| total_items | String | 必填 | 9 | 总记录数 | 50 |
| shop_summary_infos | ShopSummaryQueryResponse [] | 必填 | - | 支付宝门店摘要信息列表 | |
|
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayOfflineMarketShopSummaryBatchqueryRequest request = new AlipayOfflineMarketShopSummaryBatchqueryRequest();
request.setBizContent("{" +
"\"op_role\":\"ISV、PROVIDER\"," +
"\"query_type\":\"BRAND_RELATION\"," +
"\"related_partner_id\":\"2088001969784501\"," +
"\"shop_id\":\"2015062100077000000000120773\"," +
"\"shop_status\":\"PAUSED\"," +
"\"page_no\":1," +
"\"page_size\":20" +
" }");
AlipayOfflineMarketShopSummaryBatchqueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}
{
"alipay_offline_market_shop_summary_batchquery_response":{
"msg":"Success",
"code":"10000",
"total_page_no":"3",
"shop_summary_infos":[
{
"branch_shop_name":"万塘路店",
"per_pay":"100",
"gmt_create":"2016-06-23 21:15:04.593",
"main_shop_name":"海底捞",
"business_time":"10:00-14:00",
"address":"万塘路18号黄龙时代广场",
"main_image":"AM-uJRh2SRKz9N0r9zW4wQAAACMAAQEC",
"latitude":"31.226948",
"category_infos":[
{
"category_level":"2",
"category_name":"美食",
"category_id":"2015050700000018"
}
],
"city_code":"140500",
"brand_name":"肯德基",
"pic_coll":"{\"IUFIDASFIEUIOFKSFIUFE83IEI\":\"http://object.alipay.com/getpic.do?kjkdjkjj\"}",
"province_code":"110000",
"is_show":"T",
"shop_id":"2015052100077000000000120773",
"shop_comment_info":{
"score":"3.2",
"star":"4.0"
},
"district_code":"140521",
"shop_type":"COMMON",
"status":"OPEN",
"longitude":"121.549728"
}
],
"current_page_no":"1",
"total_items":"50",
"page_size":"20"
},
"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
{
"alipay_offline_market_shop_summary_batchquery_response":{
"msg":"Service Currently Unavailable",
"code":"20000",
"sub_msg":"系统繁忙",
"sub_code":"isp.unknow-error"
},
"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| SYSTEM_ERROR | 系统繁忙 | 重试调用查询接口 |
| INVALID_PARAMETER | 参数有误参数有误 | 对照接口文档以及请求参数用例,修改请求参数 |
| ILLEGAL_PRIVILEGE | 权限非法 | 请检查是否有业务权限进行门店摘要信息查询 |