阿里安全开放平台-阿里聚安全

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

名称	类型	是否必须	示例值	更多限制	描述
shop_summary_batch_query_top_request	ShopSummaryBatchQueryTopRequest	必须			请求体
└ district_code String 可选 120104 区域编码，如：120104表示南开区 └ city_code String 可选 120100 城市编码，国标码，如：120100表示天津市 └ related_partner_id String 可选 2088001969784501 query_type查询类型下所关联的商户PID └ page_size String 可选 20 每页记录数，默认20，最大 100 └ op_role String 必须 ISV、PROVIDER 表示接口业务的调用方身份：ISV、服务商身份标识。传入ISV代表系统集成商身份。传入PROVIDER代表服务商。 └ shop_status String 可选 PAUSED 门店状态，传入多个状态，多个状态使用英文逗号隔开，例如：PAUSED,OPEN 店铺状态：OPEN（营业）、PAUSED（暂停）、INIT（初始）、FREEZE（冻结）、CLOSED（关店） └ page_no String 可选 1 页码，留空标示第一页，默认 20个结果为一页 └ shop_id String 可选 2015062100077000000000120773 门店ID └ brand_name String 可选麦当劳品牌名 └ province_code String 可选 120000 省份编码，国标码，如：120000表示天津 └ store_id String 可选 1055022258 淘系门店id └ query_type String 必须 MERCHANT_SELF 门店数据查询类型，根据类型可以返回指定的门店数据，目前支持的类型如下:MERCHANT_SELF:商户自己的门店 └ consume_pid String 可选 2088001969784501 门店所属的商户PID

名称	类型	示例值	描述
result	TopResult		返回结果
└ success Boolean true 是否成功 └ result_code String SYSTEM_ERROR 错误码 value ShopSummaryPageQueryResponse 结果数据 shop_summary_infos ShopSummaryQueryResponse [] 摘要列表 └ shop_id String 2015052100077000000000120773 门店ID └ main_shop_name String 海底捞主门店名 └ branch_shop_name String 万塘路店分店名 └ status String OPEN 门店状态，OPEN：营业中、PAUSE：暂停营业、FREEZE：已冻结、CLOSE:门店已关闭 └ is_show String T 门店是否在客户端显示，T表示显示，F表示隐藏 └ brand_name String 肯德基品牌名，不填写则默认为其它品牌 └ address String 万塘路18号黄龙时代广场门店地址 └ province_code String 110000 省份编码，国标码，详见国家统计局数据 └ city_code String 140500 城市编码，国标码，详见国家统计局数据 └ district_code String 140521 区县编码，国标码，详见国家统计局数据 └ business_time String 10:00-14:00 经营时间 └ shop_type String COMMON COMMON（普通门店）、MALL（商圈） └ main_image String https://img.alicdn.com/i4/2207474112147/O1CN019Bbk4G1RjN7Wdzi7V_!!2207474112147-0-koubei.jpg 门店首图 └ gmt_create String 2016-06-23 21:15:04.593 创建时间 category_infos ShopCategoryInfo [] 类目信息 └ category_id String 2015050700000018 类目编号 └ category_name String 美食类目名称 └ category_level String 2 类目层级,目前最多支持1、2、3三级 └ store_id String 1069424158 淘侧门店id └ ext_info String {\"alipayShopId\":\"2023072700502007010099547256\", \"externalShopId\":\"test100\"} 门店扩展信息 └ current_page_no Number 1 当前页码 └ page_size Number 10 分页大小 └ total_page_no Number 30 总页码 └ total_items Number 100 结果总数 └ error_msg String 系统异常错误文案 └ ext_info String null 扩展字段

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlscShopSummaryBatchqueryRequest req = new AlibabaAlscShopSummaryBatchqueryRequest();
AlibabaAlscShopSummaryBatchqueryRequest.ShopSummaryBatchQueryTopRequest obj1 = new AlibabaAlscShopSummaryBatchqueryRequest.ShopSummaryBatchQueryTopRequest();
obj1.setDistrictCode("120104");
obj1.setCityCode("120100");
obj1.setRelatedPartnerId("2088001969784501");
obj1.setPageSize("20");
obj1.setOpRole("ISV、PROVIDER");
obj1.setShopStatus("PAUSED");
obj1.setPageNo("1");
obj1.setShopId("2015062100077000000000120773");
obj1.setBrandName("麦当劳");
obj1.setProvinceCode("120000");
obj1.setStoreId("1055022258");
obj1.setQueryType("MERCHANT_SELF");
obj1.setConsumePid("2088001969784501");
req.setShopSummaryBatchQueryTopRequest(obj1);
AlibabaAlscShopSummaryBatchqueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlscShopSummaryBatchqueryRequest req = new AlibabaAlscShopSummaryBatchqueryRequest();
AlibabaAlscShopSummaryBatchqueryRequest.ShopSummaryBatchQueryTopRequestDomain obj1 = new AlibabaAlscShopSummaryBatchqueryRequest.ShopSummaryBatchQueryTopRequestDomain();
obj1.DistrictCode = "120104";
obj1.CityCode = "120100";
obj1.RelatedPartnerId = "2088001969784501";
obj1.PageSize = "20";
obj1.OpRole = "ISV、PROVIDER";
obj1.ShopStatus = "PAUSED";
obj1.PageNo = "1";
obj1.ShopId = "2015062100077000000000120773";
obj1.BrandName = "麦当劳";
obj1.ProvinceCode = "120000";
obj1.StoreId = "1055022258";
obj1.QueryType = "MERCHANT_SELF";
obj1.ConsumePid = "2088001969784501";
req.ShopSummaryBatchQueryTopRequest_ = obj1;
AlibabaAlscShopSummaryBatchqueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlscShopSummaryBatchqueryRequest;
$shop_summary_batch_query_top_request = new ShopSummaryBatchQueryTopRequest;
$shop_summary_batch_query_top_request->district_code="120104";
$shop_summary_batch_query_top_request->city_code="120100";
$shop_summary_batch_query_top_request->related_partner_id="2088001969784501";
$shop_summary_batch_query_top_request->page_size="20";
$shop_summary_batch_query_top_request->op_role="ISV、PROVIDER";
$shop_summary_batch_query_top_request->shop_status="PAUSED";
$shop_summary_batch_query_top_request->page_no="1";
$shop_summary_batch_query_top_request->shop_id="2015062100077000000000120773";
$shop_summary_batch_query_top_request->brand_name="麦当劳";
$shop_summary_batch_query_top_request->province_code="120000";
$shop_summary_batch_query_top_request->store_id="1055022258";
$shop_summary_batch_query_top_request->query_type="MERCHANT_SELF";
$shop_summary_batch_query_top_request->consume_pid="2088001969784501";
$req->setShopSummaryBatchQueryTopRequest(json_encode($shop_summary_batch_query_top_request));
$resp = $c->execute($req);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=alibaba.alsc.shop.summary.batchquery' \
-d 'partner_id=apidoc' \
-d 'sign=3E1EBF51FF71EFE46022E943841D1CA1' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-19+15%3A03%3A15' \
-d 'v=2.0' \
-d 'shop_summary_batch_query_top_request=null'

# -*- coding: utf-8 -*-
import top.api

req=top.api.AlibabaAlscShopSummaryBatchqueryRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.shop_summary_batch_query_top_request="数据结构示例JSON格式"
try:
	resp= req.getResponse()
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"alibaba.alsc.shop.summary.batchquery");
add_param(pRequest,"shop_summary_batch_query_top_request","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,NULL);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('alibaba.alsc.shop.summary.batchquery', {
	'shop_summary_batch_query_top_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_alsc_shop_summary_batchquery_response>
    <result>
        <success>true</success>
        <result_code>SYSTEM_ERROR</result_code>
        <value>
            <shop_summary_infos>
                <shop_summary_query_response>
                    <shop_id>2015052100077000000000120773</shop_id>
                    <main_shop_name>海底捞</main_shop_name>
                    <branch_shop_name>万塘路店</branch_shop_name>
                    <status>OPEN</status>
                    <is_show>T</is_show>
                    <brand_name>肯德基</brand_name>
                    <address>万塘路18号黄龙时代广场</address>
                    <province_code>110000</province_code>
                    <city_code>140500</city_code>
                    <district_code>140521</district_code>
                    <business_time>10:00-14:00</business_time>
                    <shop_type>COMMON</shop_type>
                    <main_image>https://img.alicdn.com/i4/2207474112147/O1CN019Bbk4G1RjN7Wdzi7V_!!2207474112147-0-koubei.jpg</main_image>
                    <gmt_create>2016-06-23 21:15:04.593</gmt_create>
                    <category_infos>
                        <shop_category_info>
                            <category_id>2015050700000018</category_id>
                            <category_name>美食</category_name>
                            <category_level>2</category_level>
                        </shop_category_info>
                    </category_infos>
                    <store_id>1069424158</store_id>
                    <ext_info>{\&quot;alipayShopId\&quot;:\&quot;2023072700502007010099547256\&quot;,     \&quot;externalShopId\&quot;:\&quot;test100\&quot;}</ext_info>
                </shop_summary_query_response>
            </shop_summary_infos>
            <current_page_no>1</current_page_no>
            <page_size>10</page_size>
            <total_page_no>30</total_page_no>
            <total_items>100</total_items>
        </value>
        <error_msg>系统异常</error_msg>
        <ext_info>null</ext_info>
    </result>
</alibaba_alsc_shop_summary_batchquery_response>

{
    "alibaba_alsc_shop_summary_batchquery_response":{
        "result":{
            "success":true,
            "result_code":"SYSTEM_ERROR",
            "value":{
                "shop_summary_infos":{
                    "shop_summary_query_response":[
                        {
                            "shop_id":"2015052100077000000000120773",
                            "main_shop_name":"海底捞",
                            "branch_shop_name":"万塘路店",
                            "status":"OPEN",
                            "is_show":"T",
                            "brand_name":"肯德基",
                            "address":"万塘路18号黄龙时代广场",
                            "province_code":"110000",
                            "city_code":"140500",
                            "district_code":"140521",
                            "business_time":"10:00-14:00",
                            "shop_type":"COMMON",
                            "main_image":"https:\/\/img.alicdn.com\/i4\/2207474112147\/O1CN019Bbk4G1RjN7Wdzi7V_!!2207474112147-0-koubei.jpg",
                            "gmt_create":"2016-06-23 21:15:04.593",
                            "category_infos":{
                                "shop_category_info":[
                                    {
                                        "category_id":"2015050700000018",
                                        "category_name":"美食",
                                        "category_level":"2"
                                    }
                                ]
                            },
                            "store_id":"1069424158",
                            "ext_info":"{\\\"alipayShopId\\\":\\\"2023072700502007010099547256\\\",     \\\"externalShopId\\\":\\\"test100\\\"}"
                        }
                    ]
                },
                "current_page_no":1,
                "page_size":10,
                "total_page_no":30,
                "total_items":100
            },
            "error_msg":"系统异常",
            "ext_info":"null"
        }
    }
}

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码	错误描述	解决方案

API测试工具错误码查询工具 SDK下载

本地生活API

alibaba.alsc.shop.summary.batchquery (门店摘要信息批量查询接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈