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

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
keywords	String	可选	乐坊		查询关键字
status	Number	可选	1	默认值：-1	店铺状态，歇业：0，营业：1，所有：-1
page	Number	必须	1	最小值：1	页码
page_size	Number	必须	20	最小值：1 最大值：20	每页条数

名称	类型	示例值	描述
result	TakeoutShopPage		数据结果集
└ total_count Number 1000 总条数 └ page Number 1 当前页码 └ page_size Number 20 每页条数 └ total_page Number 500 总页数 └ prev_page Number 1 上一页页码 └ next_page Number 2 下一页页码 takeout_summary_infos TakeoutShopSummaryInfo [] 店铺信息列表 └ sub_name String 西城店店铺分店名 └ shopid Number 1234 外卖店铺id └ name String 天地坊外卖店铺名称 └ city String 杭州城市 └ address String 杭州文一路999号桃花岛店铺地址 └ phone String 18600000000 电话号码 └ wait_confirm Number 12 等待确认配送的订单笔数 └ digital_wait_confirm Number 20 等待确认的兑换券的订单笔数 └ wait_refund Number 2 等待退款的订单笔数 └ is_open Number 1 店铺营业状态，歇业：0，营业：1 └ shopoutid String 1234 店铺与ISV的关联ID

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
DrugShopListRequest req = new DrugShopListRequest();
req.setKeywords("乐坊");
req.setStatus(1L);
req.setPage(1L);
req.setPageSize(20L);
DrugShopListResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
DrugShopListRequest req = new DrugShopListRequest();
req.Keywords = "乐坊";
req.Status = 1L;
req.Page = 1L;
req.PageSize = 20L;
DrugShopListResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new DrugShopListRequest;
$req->setKeywords("乐坊");
$req->setStatus("1");
$req->setPage("1");
$req->setPageSize("20");
$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=taobao.drug.shop.list' \
-d 'partner_id=apidoc' \
-d 'session=be6c8aeb-bcec-4015-95d6-f7617be657cc' \
-d 'sign=A924DA173904BA762D06A5A351B6B017' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-26+14%3A20%3A24' \
-d 'v=2.0' \
-d 'keywords=%E4%B9%90%E5%9D%8A' \
-d 'page=1' \
-d 'page_size=20' \
-d 'status=1'

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

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

req.keywords="乐坊"
req.status=1
req.page=1
req.page_size=20
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,"taobao.drug.shop.list");
add_param(pRequest,"keywords","乐坊");
add_param(pRequest,"status","1");
add_param(pRequest,"page","1");
add_param(pRequest,"page_size","20");
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',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('taobao.drug.shop.list', {
	'keywords':'乐坊',
	'status':'1',
	'page':'1',
	'page_size':'20'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<drug_shop_list_response>
    <result>
        <total_count>1000</total_count>
        <page>1</page>
        <page_size>20</page_size>
        <total_page>500</total_page>
        <prev_page>1</prev_page>
        <next_page>2</next_page>
        <takeout_summary_infos>
            <takeout_shop_summary_info>
                <sub_name>西城店</sub_name>
                <shopid>1234</shopid>
                <name>天地坊</name>
                <city>杭州</city>
                <address>杭州文一路999号桃花岛</address>
                <phone>18600000000</phone>
                <wait_confirm>12</wait_confirm>
                <digital_wait_confirm>20</digital_wait_confirm>
                <wait_refund>2</wait_refund>
                <is_open>1</is_open>
                <shopoutid>1234</shopoutid>
            </takeout_shop_summary_info>
        </takeout_summary_infos>
    </result>
</drug_shop_list_response>

{
    "drug_shop_list_response":{
        "result":{
            "total_count":1000,
            "page":1,
            "page_size":20,
            "total_page":500,
            "prev_page":1,
            "next_page":2,
            "takeout_summary_infos":{
                "takeout_shop_summary_info":[
                    {
                        "sub_name":"西城店",
                        "shopid":1234,
                        "name":"天地坊",
                        "city":"杭州",
                        "address":"杭州文一路999号桃花岛",
                        "phone":"18600000000",
                        "wait_confirm":12,
                        "digital_wait_confirm":20,
                        "wait_refund":2,
                        "is_open":1,
                        "shopoutid":"1234"
                    }
                ]
            }
        }
    }
}

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

taobao.drug.shop.list (查询卖家外卖店列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈