alipay.offline.market.shop.summary.batchquery(门店摘要信息批量查询接口) 在线调试(沙箱环境)

用于进行门店摘要信息批量查询接口。

公共参数

请求地址

环境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 344 商户请求参数的签名串,详见签名 详见示例
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
biz_channel String 可选 64 表示接口查询门店的业务渠道限制:ALL、 POS、不传。不传代表只查询普通门店,传入POS代表只查询简易门店,传入ALL代表查询普通门店和简易门店。 POS、ALL
page_no Number 可选 9 页码,留空标示第一页,默认 20个结果为一页 1
page_size Number 可选 3 每页记录数,默认20,最大 100 20
province_code String 可选 10 省份编码,国标码,如:120000表示天津 120000
city_code String 可选 10 城市编码,国标码,如:120100表示天津市 120100
district_code String 可选 10 区域编码,如:120104表示南开区 120104
brand_name String 可选 512 品牌名 麦当劳

响应参数

参数 类型 是否必填 最大长度 描述 示例值
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 必填 支付宝门店摘要信息列表
shop_id String 必填 32 门店ID 2015052100077000000000120773
main_shop_name String 必填 40 主门店名 海底捞
branch_shop_name String 必填 40 分店名 万塘路店
status String 必填 16 门店状态,OPEN:营业中、PAUSE:暂停营业、FREEZE:已冻结、CLOSE:门店已关闭 OPEN
is_show String 必填 16 门店是否在客户端显示,T表示显示,F表示隐藏 T
category_infos ShopCategoryInfo[] 必填 200 门店类目列表
category_id String 可选 32 类目编号 2015050700000018
category_name String 可选 64 类目名称 美食
category_level String 必填 2 类目层级,目前最多支持1、2、3三级 2
brand_name String 必填 40 品牌名,不填写则默认为其它品牌 肯德基
address String 必填 100 门店地址 万塘路18号黄龙时代广场
province_code String 必填 10 省份编码,国标码,详见国家统计局数据 点此下载 110000
city_code String 必填 10 城市编码,国标码,详见国家统计局数据 点此下载 140500
district_code String 可选 10 区县编码,国标码,详见国家统计局数据 点此下载 140521
longitude String 可选 10 经度,只有在query_type=KB_PROMOTER非空 121.549728
latitude String 可选 10 纬度,只有在query_type=KB_PROMOTER非空 31.226948
business_time String 可选 100 经营时间 10:00-14:00
shop_type String 必填 10 COMMON(普通门店)、MALL(商圈) COMMON
per_pay String 可选 10 人均价格。单位是分。例如:2000,表示20元 100
main_image String 可选 512 门店首图 AM-uJRh2SRKz9N0r9zW4wQAAACMAAQEC
gmt_create String 必填 30 创建时间 2016-06-23 21:15:04.593
pic_coll String 可选 4000 图片集,是map转化成的json串,key是图片id,value是图片url {"IUFIDASFIEUIOFKSFIUFE83IEI":"http://object.alipay.com/getpic.do?kjkdjkjj"}
shop_comment_info ShopCommentInfo 可选 1000 门店评论信息
star String 可选 10 门店星级,0~5,越高,店铺质量越高 4.0
score String 可选 10 门店评分,评分越高,门店质量越高 3.2
avg_popularity String 可选 10 店铺30天平均人气值 76
avg_popularity_name String 可选 64 avg_popularity字段展示文案 口碑人气
ext_info String 可选 1024 json 字符串表示额外信息;

order_biz_mode: 点餐营业模式, REGULAR-正餐、LIGHT_FAST-轻快餐;
pre_order: 预点餐服务可用状态, 1-服务可用、0-服务不可用
order: 到店点餐服务可用状态:1-服务可用、0-服务不可用
{"order_biz_mode":"REGULAR","order":"1","pre_order":"1"}

请求示例

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\"," +
"\"biz_channel\":\"POS、ALL\"," +
"\"page_no\":1," +
"\"page_size\":20," +
"\"province_code\":\"120000\"," +
"\"city_code\":\"120100\"," +
"\"district_code\":\"120104\"," +
"\"brand_name\":\"麦当劳\"" +
"  }");
AlipayOfflineMarketShopSummaryBatchqueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_offline_market_shop_summary_batchquery_response": {
        "code": "10000",
        "msg": "Success",
        "page_size": "20",
        "current_page_no": "1",
        "total_page_no": "3",
        "total_items": "50",
        "shop_summary_infos": [
            {
                "shop_id": "2015052100077000000000120773",
                "main_shop_name": "海底捞",
                "branch_shop_name": "万塘路店",
                "status": "OPEN",
                "is_show": "T",
                "category_infos": [
                    {
                        "category_id": "2015050700000018",
                        "category_name": "美食",
                        "category_level": "2"
                    }
                ],
                "brand_name": "肯德基",
                "address": "万塘路18号黄龙时代广场",
                "province_code": "110000",
                "city_code": "140500",
                "district_code": "140521",
                "longitude": "121.549728",
                "latitude": "31.226948",
                "business_time": "10:00-14:00",
                "shop_type": "COMMON",
                "per_pay": "100",
                "main_image": "AM-uJRh2SRKz9N0r9zW4wQAAACMAAQEC",
                "gmt_create": "2016-06-23 21:15:04.593",
                "pic_coll": "{\"IUFIDASFIEUIOFKSFIUFE83IEI\":\"http://object.alipay.com/getpic.do?kjkdjkjj\"}",
                "shop_comment_info": {
                    "star": "4.0",
                    "score": "3.2",
                    "avg_popularity": "76",
                    "avg_popularity_name": "口碑人气"
                },
                "ext_info": "{\"order_biz_mode\":\"REGULAR\",\"order\":\"1\",\"pre_order\":\"1\"}"
            }
        ]
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
SYSTEM_ERROR 系统繁忙 重试调用查询接口
INVALID_PARAMETER 参数有误参数有误 对照接口文档以及请求参数用例,修改请求参数
ILLEGAL_PRIVILEGE 权限非法 请检查是否有业务权限进行门店摘要信息查询
onlineServer