淘宝开放平台 - 文档中心

请求地址：

环境	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。

名称	类型	是否必须	示例值	更多限制	描述
xsd_store_query_reqeust	XsdStoreQueryRequest	必须			门店查询请求参数
└ scroll_id String 可选 eJxNT8FOwzAM/Zr0UiG5SZO2hx7GKg4cuJ 查询游标，默认有效时间1min，查询第一页的时候不需要传值，后续查询从返回结果获取上一次返回的最新的scroll_id └ page_size Number 可选 20 页面大小，默认20，最大20 └ store_ids String [] 可选 ["123456"] 门店ID列表，最多20个

名称	类型	示例值	描述
result	ApiScrollPageResult		查询结果
└ success Boolean true 是否成功 true-成功;flase-失败 └ err_code String PARAMS_ERROR 错误码 └ err_msg String 参数错误错误原因 └ scroll_id String eJxNT8FOwzAM/Zr0UiG5SZO2hx7GKg4cuJ 分页游标 └ page_size Number 20 页面大小 └ total Number 100 数量总条数 store_list XsdStoreResultDTO [] 门店列表 └ store_id String 1121894104 门店ID └ store_name String opal测试门店0801 门店名称 └ status Number 1 门店状态 1 - 开业;非1 -闭店 └ city String 浙江省杭州市余杭区城市地区名称 └ lng String 120.025512 门店地址经度 └ lat String 29.535313 门店地址纬度 └ business_time String 06:00-14:00 营业时段 └ category_name String 流行男鞋门店经营类目 └ business_day String 1,2,3,4 营业日 └ phone String 0571-88699876 门店联系方式 └ address String 五常街道文一西路969号门店详细地址 └ contact String 张三门店负责人 └ store_code String TB_XSD_NR_3SLEW 门店编码，系统生成 └ out_biz_code String test 商家自定义编码，新零售商家建店自定义，远转近暂不支持 └ custom_code String TM0011 商家内部管理使用的门店id，以便与闪购门店关联 └ guide_desc String 大厅扶梯上4楼左边第二家门店位置引导，方便骑手快速找到门店 └ guide_desc_pic_list String "[https://img.alicdn.com/imgextra/i1/2217628244067/O1CN01IM7lgy1fujmABd9ir_!!2217628244067.jpg]" 门店位置指引图，json格式 └ distributor_name String xxxx有限公司门店所属经销商名称 └ business_mode Number 1 仅支持远转近门店，门店经营模式 0 直营 1 经销

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaXsdStoresQueryRequest req = new AlibabaXsdStoresQueryRequest();
AlibabaXsdStoresQueryRequest.XsdStoreQueryRequest obj1 = new AlibabaXsdStoresQueryRequest.XsdStoreQueryRequest();
obj1.setScrollId("eJxNT8FOwzAM/Zr0UiG5SZO2hx7GKg4cuJ");
obj1.setPageSize(20L);
obj1.setStoreIds(""123456"");
req.setXsdStoreQueryReqeust(obj1);
AlibabaXsdStoresQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaXsdStoresQueryRequest req = new AlibabaXsdStoresQueryRequest();
AlibabaXsdStoresQueryRequest.XsdStoreQueryRequestDomain obj1 = new AlibabaXsdStoresQueryRequest.XsdStoreQueryRequestDomain();
obj1.ScrollId = "eJxNT8FOwzAM/Zr0UiG5SZO2hx7GKg4cuJ";
obj1.PageSize = 20L;
obj1.StoreIds = ""123456"";
req.XsdStoreQueryReqeust_ = obj1;
AlibabaXsdStoresQueryResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaXsdStoresQueryRequest;
$xsd_store_query_reqeust = new XsdStoreQueryRequest;
$xsd_store_query_reqeust->scroll_id="eJxNT8FOwzAM/Zr0UiG5SZO2hx7GKg4cuJ";
$xsd_store_query_reqeust->page_size="20";
$xsd_store_query_reqeust->store_ids="[\"123456\"]";
$req->setXsdStoreQueryReqeust(json_encode($xsd_store_query_reqeust));
$resp = $c->execute($req, $sessionKey);

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.xsd.stores.query' \
-d 'partner_id=apidoc' \
-d 'session=dfc76fd5-dd70-4732-bd4f-ac2d3c56469e' \
-d 'sign=2ACDBD6EABC1C9A964A18F18A1770DD4' \
-d 'sign_method=hmac' \
-d 'timestamp=2026-06-14+11%3A19%3A38' \
-d 'v=2.0' \
-d 'xsd_store_query_reqeust=null'

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

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

req.xsd_store_query_reqeust="数据结构示例JSON格式"
try:
	resp= req.getResponse(sessionkey)
	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.xsd.stores.query");
add_param(pRequest,"xsd_store_query_reqeust","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,sessionKey);
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',
	'url': 'http://gw.api.taobao.com/router/rest'
});

client.execute('alibaba.xsd.stores.query', {
	'xsd_store_query_reqeust':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_xsd_stores_query_response>
    <result>
        <success>true</success>
        <err_code>PARAMS_ERROR</err_code>
        <err_msg>参数错误</err_msg>
        <scroll_id>eJxNT8FOwzAM/Zr0UiG5SZO2hx7GKg4cuJ</scroll_id>
        <page_size>20</page_size>
        <total>100</total>
        <store_list>
            <xsd_store_result_d_t_o>
                <store_id>1121894104</store_id>
                <store_name>opal测试门店0801</store_name>
                <status>1</status>
                <city>浙江省杭州市余杭区</city>
                <lng>120.025512</lng>
                <lat>29.535313</lat>
                <business_time>06:00-14:00</business_time>
                <category_name>流行男鞋</category_name>
                <business_day>1,2,3,4</business_day>
                <phone>0571-88699876</phone>
                <address>五常街道文一西路969号</address>
                <contact>张三</contact>
                <store_code>TB_XSD_NR_3SLEW</store_code>
                <out_biz_code>test</out_biz_code>
                <custom_code>TM0011</custom_code>
                <guide_desc>大厅扶梯上4楼左边第二家</guide_desc>
                <guide_desc_pic_list>&quot;[https://img.alicdn.com/imgextra/i1/2217628244067/O1CN01IM7lgy1fujmABd9ir_!!2217628244067.jpg]&quot;</guide_desc_pic_list>
                <distributor_name>xxxx有限公司</distributor_name>
                <business_mode>1</business_mode>
            </xsd_store_result_d_t_o>
        </store_list>
    </result>
</alibaba_xsd_stores_query_response>

{
    "alibaba_xsd_stores_query_response":{
        "result":{
            "success":true,
            "err_code":"PARAMS_ERROR",
            "err_msg":"参数错误",
            "scroll_id":"eJxNT8FOwzAM\/Zr0UiG5SZO2hx7GKg4cuJ",
            "page_size":20,
            "total":100,
            "store_list":{
                "xsd_store_result_d_t_o":[
                    {
                        "store_id":"1121894104",
                        "store_name":"opal测试门店0801",
                        "status":1,
                        "city":"浙江省杭州市余杭区",
                        "lng":"120.025512",
                        "lat":"29.535313",
                        "business_time":"06:00-14:00",
                        "category_name":"流行男鞋",
                        "business_day":"1,2,3,4",
                        "phone":"0571-88699876",
                        "address":"五常街道文一西路969号",
                        "contact":"张三",
                        "store_code":"TB_XSD_NR_3SLEW",
                        "out_biz_code":"test",
                        "custom_code":"TM0011",
                        "guide_desc":"大厅扶梯上4楼左边第二家",
                        "guide_desc_pic_list":"\"[https:\/\/img.alicdn.com\/imgextra\/i1\/2217628244067\/O1CN01IM7lgy1fujmABd9ir_!!2217628244067.jpg]\"",
                        "distributor_name":"xxxx有限公司",
                        "business_mode":1
                    }
                ]
            }
        }
    }
}

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.xsd.stores.query (小时达商家门店批量查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ