淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
param	BrandOrderExternalReq	必须			系统自动生成
└ brand_ids String [] 可选 ["123","234"] 品牌id列表，必填 └ cate_ids String [] 可选 ["123","234"] 叶子类目id列表 └ item_ids String [] 可选 ["123","234"] 货品id列表 └ page_size Number 必须 20 页面显示条数 └ page_num Number 必须 1 页号

名称	类型	示例值	描述
result	PagedResult		返回的翻页信息
data_list BrandOrderExternalRes [] 数据列表 └ sc_item_id String 123 货品id └ sc_item_name String 仁和可立克货品名称 └ cate_level1_id String 1234 一级叶子类目id └ cate_level1_name String 一级叶子类目名称一级叶子类目名称 └ cate_level2_id String 1234 二级叶子类目id └ cate_level2_name String 二级叶子类目名称二级叶子类目名称 └ cate_id String 1234 叶子类目id └ cate_name String 叶子类目名称叶子类目名称 └ brand_id String 123 品牌id └ brand_name String 仁和品牌名称 └ company_name String 阿里健康大药房健康主体公司名称 └ error_message String error 错误信息 └ success Boolean true 是否成功 └ total_count Number 12 总数 └ page_index Number 1 页号 └ total_page Number 1 总页数 └ error_code String 500 错误码 └ current_page Number 1 当前页号 └ page_size Number 20 每页显示的条数 └ error_detail_msg String error msg 错误详细信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlihealthBrandItemQueryRequest req = new AlibabaAlihealthBrandItemQueryRequest();
AlibabaAlihealthBrandItemQueryRequest.BrandOrderExternalReq obj1 = new AlibabaAlihealthBrandItemQueryRequest.BrandOrderExternalReq();
obj1.setBrandIds(""123","234"");
obj1.setCateIds(""123","234"");
obj1.setItemIds(""123","234"");
obj1.setPageSize(20L);
obj1.setPageNum(1L);
req.setParam(obj1);
AlibabaAlihealthBrandItemQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlihealthBrandItemQueryRequest req = new AlibabaAlihealthBrandItemQueryRequest();
AlibabaAlihealthBrandItemQueryRequest.BrandOrderExternalReqDomain obj1 = new AlibabaAlihealthBrandItemQueryRequest.BrandOrderExternalReqDomain();
obj1.BrandIds = ""123","234"";
obj1.CateIds = ""123","234"";
obj1.ItemIds = ""123","234"";
obj1.PageSize = 20L;
obj1.PageNum = 1L;
req.Param_ = obj1;
AlibabaAlihealthBrandItemQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlihealthBrandItemQueryRequest;
$param = new BrandOrderExternalReq;
$param->brand_ids="[\"123\",\"234\"]";
$param->cate_ids="[\"123\",\"234\"]";
$param->item_ids="[\"123\",\"234\"]";
$param->page_size="20";
$param->page_num="1";
$req->setParam(json_encode($param));
$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.alihealth.brand.item.query' \
-d 'partner_id=apidoc' \
-d 'sign=8F1EE1C3E40D26316766796E645FF6A6' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-09+20%3A23%3A30' \
-d 'v=2.0' \
-d 'param=null'

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

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

req.param=""
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.alihealth.brand.item.query");
add_param(pRequest,"param","数据结构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.alihealth.brand.item.query', {
	'param':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_alihealth_brand_item_query_response>
    <result>
        <data_list>
            <brand_order_external_res>
                <sc_item_id>123</sc_item_id>
                <sc_item_name>仁和可立克</sc_item_name>
                <cate_level1_id>1234</cate_level1_id>
                <cate_level1_name>一级叶子类目名称</cate_level1_name>
                <cate_level2_id>1234</cate_level2_id>
                <cate_level2_name>二级叶子类目名称</cate_level2_name>
                <cate_id>1234</cate_id>
                <cate_name>叶子类目名称</cate_name>
                <brand_id>123</brand_id>
                <brand_name>仁和</brand_name>
                <company_name>阿里健康大药房</company_name>
            </brand_order_external_res>
        </data_list>
        <error_message>error</error_message>
        <success>true</success>
        <total_count>12</total_count>
        <page_index>1</page_index>
        <total_page>1</total_page>
        <error_code>500</error_code>
        <current_page>1</current_page>
        <page_size>20</page_size>
        <error_detail_msg>error msg</error_detail_msg>
    </result>
</alibaba_alihealth_brand_item_query_response>

{
    "alibaba_alihealth_brand_item_query_response":{
        "result":{
            "data_list":{
                "brand_order_external_res":[
                    {
                        "sc_item_id":"123",
                        "sc_item_name":"仁和可立克",
                        "cate_level1_id":"1234",
                        "cate_level1_name":"一级叶子类目名称",
                        "cate_level2_id":"1234",
                        "cate_level2_name":"二级叶子类目名称",
                        "cate_id":"1234",
                        "cate_name":"叶子类目名称",
                        "brand_id":"123",
                        "brand_name":"仁和",
                        "company_name":"阿里健康大药房"
                    }
                ]
            },
            "error_message":"error",
            "success":true,
            "total_count":12,
            "page_index":1,
            "total_page":1,
            "error_code":"500",
            "current_page":1,
            "page_size":20,
            "error_detail_msg":"error msg"
        }
    }
}

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.alihealth.brand.item.query (鹿透社对外数据开放货品信息查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ