淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	描述
query	TopAlihealthSpuQuery	可选	标品查询条件
└ barcode String 可选 6940577300315 69码 └ approval_number String 可选国药准字H20044865 批准文号 └ title String 可选头孢拉定胶囊通用名称 └ specification String 可选 250mg*20粒规格 └ manufacturer String 可选江苏亚邦强生药业有限公司生产厂商 └ brand_name String 可选亚邦品牌名称 └ only_drug Boolean 可选 true 是否只搜索药品 └ open_id Number 可选 111111 开放id └ offset Number 可选 1 偏移量 └ page_no Number 可选 1 当前页码 └ page_size Number 可选 20 每页条数，0不分页，返回全部 └ spu_id Number 可选 236757657 药品SPUID
options	TopAlihealthSpuQueryOptions	可选	查询选择器
└ include_instruction Boolean 可选 true 查询选择器，是否查询说明书信息

名称	类型	示例值	描述
result	ResponseResult	无	结果
└ success Boolean true 是否成功 └ error_code String 1 错误码 └ error_msg String 访问异常错误信息 result PageResponse 无结果 └ current_page Number 1 当前页码 └ total_page Number 20 总页数 └ total_count Number 20 总条数 spus TopAlihealthSpuQuery [] TopAlihealthSpuQuery 结果列表 └ open_id Number 111111 开放id └ barcode String 6940577300315 69码 └ approval_number String 国药准字H20044865 国药准字 └ title String 头孢拉定胶囊通用名称 └ product_title String 111111 spu标题 └ title_alias String 头孢拉定胶囊别名，也就是商品名称 └ specification String 250mg*20粒规格 └ brand_name String 安邦品牌名称 └ manufacturer String 广州安邦生产厂商 alihealth_drug_instruction_d_t_o TopAlihealthDrugInstructionDto 111111 药物说明书信息 └ purpose String 111111 功能主治 └ taboo String 111111 禁忌 └ notes String 111111 注意事项 └ child_reminder String 111111 儿童提醒 └ gravida_reminder String 111111 孕妇提醒 └ old_man_reminder String 111111 老人提醒 └ adr String 111111 不良反应 └ ingredient String 111111 药物成分 └ traits String 111111 药品性状 └ interaction String 111111 药物相互作用 └ pharmacological_effects String 111111 药理作用 └ dosage String 111111 用法用量 └ spu_id Number 236757657 药品SPUid

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlihealthNrSpuQueryRequest req = new AlibabaAlihealthNrSpuQueryRequest();
AlibabaAlihealthNrSpuQueryRequest.TopAlihealthSpuQuery obj1 = new AlibabaAlihealthNrSpuQueryRequest.TopAlihealthSpuQuery();
obj1.setBarcode("6940577300315");
obj1.setApprovalNumber("国药准字H20044865");
obj1.setTitle("头孢拉定胶囊");
obj1.setSpecification("250mg*20粒");
obj1.setManufacturer("江苏亚邦强生药业有限公司");
obj1.setBrandName("亚邦");
obj1.setOnlyDrug(true);
obj1.setOpenId(111111L);
obj1.setOffset(1L);
obj1.setPageNo(1L);
obj1.setPageSize(20L);
obj1.setSpuId(236757657L);
req.setQuery(obj1);
AlibabaAlihealthNrSpuQueryRequest.TopAlihealthSpuQueryOptions obj2 = new AlibabaAlihealthNrSpuQueryRequest.TopAlihealthSpuQueryOptions();
obj2.setIncludeInstruction(true);
req.setOptions(obj2);
AlibabaAlihealthNrSpuQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlihealthNrSpuQueryRequest req = new AlibabaAlihealthNrSpuQueryRequest();
AlibabaAlihealthNrSpuQueryRequest.TopAlihealthSpuQueryDomain obj1 = new AlibabaAlihealthNrSpuQueryRequest.TopAlihealthSpuQueryDomain();
obj1.Barcode = "6940577300315";
obj1.ApprovalNumber = "国药准字H20044865";
obj1.Title = "头孢拉定胶囊";
obj1.Specification = "250mg*20粒";
obj1.Manufacturer = "江苏亚邦强生药业有限公司";
obj1.BrandName = "亚邦";
obj1.OnlyDrug = true;
obj1.OpenId = 111111L;
obj1.Offset = 1L;
obj1.PageNo = 1L;
obj1.PageSize = 20L;
obj1.SpuId = 236757657L;
req.Query_ = obj1;
AlibabaAlihealthNrSpuQueryRequest.TopAlihealthSpuQueryOptionsDomain obj2 = new AlibabaAlihealthNrSpuQueryRequest.TopAlihealthSpuQueryOptionsDomain();
obj2.IncludeInstruction = true;
req.Options_ = obj2;
AlibabaAlihealthNrSpuQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlihealthNrSpuQueryRequest;
$query = new TopAlihealthSpuQuery;
$query->barcode="6940577300315";
$query->approval_number="国药准字H20044865";
$query->title="头孢拉定胶囊";
$query->specification="250mg*20粒";
$query->manufacturer="江苏亚邦强生药业有限公司";
$query->brand_name="亚邦";
$query->only_drug="true";
$query->open_id="111111";
$query->offset="1";
$query->page_no="1";
$query->page_size="20";
$query->spu_id="236757657";
$req->setQuery(json_encode($query));
$options = new TopAlihealthSpuQueryOptions;
$options->include_instruction="true";
$req->setOptions(json_encode($options));
$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.nr.spu.query' \
-d 'partner_id=apidoc' \
-d 'sign=695EDA4BBA841D16D57B69C133237C05' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-09+19%3A52%3A56' \
-d 'v=2.0' \
-d 'options=null' \
-d 'query=null'

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

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

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

XML示例
JSON示例

<alibaba_alihealth_nr_spu_query_response>
    <result>
        <success>true</success>
        <error_code>1</error_code>
        <error_msg>访问异常</error_msg>
        <result>
            <current_page>1</current_page>
            <total_page>20</total_page>
            <total_count>20</total_count>
            <spus>
                <top_alihealth_spu_query>
                    <open_id>111111</open_id>
                    <barcode>6940577300315</barcode>
                    <approval_number>国药准字H20044865</approval_number>
                    <title>头孢拉定胶囊</title>
                    <product_title>111111</product_title>
                    <title_alias>头孢拉定胶囊</title_alias>
                    <specification>250mg*20粒</specification>
                    <brand_name>安邦</brand_name>
                    <manufacturer>广州安邦</manufacturer>
                    <alihealth_drug_instruction_d_t_o>
                        <purpose>111111</purpose>
                        <taboo>111111</taboo>
                        <notes>111111</notes>
                        <child_reminder>111111</child_reminder>
                        <gravida_reminder>111111</gravida_reminder>
                        <old_man_reminder>111111</old_man_reminder>
                        <adr>111111</adr>
                        <ingredient>111111</ingredient>
                        <traits>111111</traits>
                        <interaction>111111</interaction>
                        <pharmacological_effects>111111</pharmacological_effects>
                        <dosage>111111</dosage>
                    </alihealth_drug_instruction_d_t_o>
                    <spu_id>236757657</spu_id>
                </top_alihealth_spu_query>
            </spus>
        </result>
    </result>
</alibaba_alihealth_nr_spu_query_response>

{
    "alibaba_alihealth_nr_spu_query_response":{
        "result":{
            "success":true,
            "error_code":"1",
            "error_msg":"访问异常",
            "result":{
                "current_page":1,
                "total_page":20,
                "total_count":20,
                "spus":{
                    "top_alihealth_spu_query":[
                        {
                            "open_id":111111,
                            "barcode":"6940577300315",
                            "approval_number":"国药准字H20044865",
                            "title":"头孢拉定胶囊",
                            "product_title":"111111",
                            "title_alias":"头孢拉定胶囊",
                            "specification":"250mg*20粒",
                            "brand_name":"安邦",
                            "manufacturer":"广州安邦",
                            "alihealth_drug_instruction_d_t_o":{
                                "purpose":"111111",
                                "taboo":"111111",
                                "notes":"111111",
                                "child_reminder":"111111",
                                "gravida_reminder":"111111",
                                "old_man_reminder":"111111",
                                "adr":"111111",
                                "ingredient":"111111",
                                "traits":"111111",
                                "interaction":"111111",
                                "pharmacological_effects":"111111",
                                "dosage":"111111"
                            },
                            "spu_id":236757657
                        }
                    ]
                }
            }
        }
    }
}

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.nr.spu.query (获取标品库标品信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ