淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
mah_ref_ent_id	String	必须	cb14553ed7654ff586b87b637ba23e2c	mah企业refEntId
batch_no	String	必须	xxx	批次号
produce_ref_ent_id	String	必须	cb14553ed7654ff586b87b637ba23e2c	生产企业refEntId
ref_ent_id	String	必须	cb14553ed7654ff586b87b637ba23e2c	调用者企业id

名称	类型	示例值	描述
result	ResultModel		返回结果
└ response_success Boolean true 是否响应成功 model OnenetDrugInfoDTO [] 结果 └ drug_id String xxx1 药品id └ batch_no String xxx0 批次 └ mah_name String 测试1 mah名字 └ produce_ent_name String xxx 生产企业名称 └ mah_ref_ent_id String xxx mahRefEntId └ produce_ref_ent_id String xxxx 生产企业refEntId └ active_status String 1 是否激活:0未激活，1激活 └ physic_name String xxxx 药品名称 └ prepn_spec String xxxx 制剂规格 └ pkg_spec String xxxx 包装规格 └ produce_date String 2024-08-10 生产日期 └ expire_date String 2024-08-10 有效期至 └ msg_info String 调用成功状态值 └ msg_code String SUCCESS 状态码

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlihealthSynergyYzwDruginfoQueryRequest req = new AlibabaAlihealthSynergyYzwDruginfoQueryRequest();
req.setMahRefEntId("cb14553ed7654ff586b87b637ba23e2c");
req.setBatchNo("xxx");
req.setProduceRefEntId("cb14553ed7654ff586b87b637ba23e2c");
req.setRefEntId("cb14553ed7654ff586b87b637ba23e2c");
AlibabaAlihealthSynergyYzwDruginfoQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlihealthSynergyYzwDruginfoQueryRequest req = new AlibabaAlihealthSynergyYzwDruginfoQueryRequest();
req.MahRefEntId = "cb14553ed7654ff586b87b637ba23e2c";
req.BatchNo = "xxx";
req.ProduceRefEntId = "cb14553ed7654ff586b87b637ba23e2c";
req.RefEntId = "cb14553ed7654ff586b87b637ba23e2c";
AlibabaAlihealthSynergyYzwDruginfoQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlihealthSynergyYzwDruginfoQueryRequest;
$req->setMahRefEntId("cb14553ed7654ff586b87b637ba23e2c");
$req->setBatchNo("xxx");
$req->setProduceRefEntId("cb14553ed7654ff586b87b637ba23e2c");
$req->setRefEntId("cb14553ed7654ff586b87b637ba23e2c");
$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.synergy.yzw.druginfo.query' \
-d 'partner_id=apidoc' \
-d 'sign=4AC5C48D7FF2B481F541EA2C224A868B' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-21+20%3A00%3A45' \
-d 'v=2.0' \
-d 'batch_no=xxx' \
-d 'mah_ref_ent_id=cb14553ed7654ff586b87b637ba23e2c' \
-d 'produce_ref_ent_id=cb14553ed7654ff586b87b637ba23e2c' \
-d 'ref_ent_id=cb14553ed7654ff586b87b637ba23e2c'

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

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

req.mah_ref_ent_id="cb14553ed7654ff586b87b637ba23e2c"
req.batch_no="xxx"
req.produce_ref_ent_id="cb14553ed7654ff586b87b637ba23e2c"
req.ref_ent_id="cb14553ed7654ff586b87b637ba23e2c"
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.synergy.yzw.druginfo.query");
add_param(pRequest,"mah_ref_ent_id","cb14553ed7654ff586b87b637ba23e2c");
add_param(pRequest,"batch_no","xxx");
add_param(pRequest,"produce_ref_ent_id","cb14553ed7654ff586b87b637ba23e2c");
add_param(pRequest,"ref_ent_id","cb14553ed7654ff586b87b637ba23e2c");
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.synergy.yzw.druginfo.query', {
	'mah_ref_ent_id':'cb14553ed7654ff586b87b637ba23e2c',
	'batch_no':'xxx',
	'produce_ref_ent_id':'cb14553ed7654ff586b87b637ba23e2c',
	'ref_ent_id':'cb14553ed7654ff586b87b637ba23e2c'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_alihealth_synergy_yzw_druginfo_query_response>
    <result>
        <response_success>true</response_success>
        <model>
            <onenet_drug_info_d_t_o>
                <drug_id>xxx1</drug_id>
                <batch_no>xxx0</batch_no>
                <mah_name>测试1</mah_name>
                <produce_ent_name>xxx</produce_ent_name>
                <mah_ref_ent_id>xxx</mah_ref_ent_id>
                <produce_ref_ent_id>xxxx</produce_ref_ent_id>
                <active_status>1</active_status>
                <physic_name>xxxx</physic_name>
                <prepn_spec>xxxx</prepn_spec>
                <pkg_spec>xxxx</pkg_spec>
                <produce_date>2024-08-10</produce_date>
                <expire_date>2024-08-10</expire_date>
            </onenet_drug_info_d_t_o>
        </model>
        <msg_info>调用成功</msg_info>
        <msg_code>SUCCESS</msg_code>
    </result>
</alibaba_alihealth_synergy_yzw_druginfo_query_response>

{
    "alibaba_alihealth_synergy_yzw_druginfo_query_response":{
        "result":{
            "response_success":true,
            "model":{
                "onenet_drug_info_d_t_o":[
                    {
                        "drug_id":"xxx1",
                        "batch_no":"xxx0",
                        "mah_name":"测试1",
                        "produce_ent_name":"xxx",
                        "mah_ref_ent_id":"xxx",
                        "produce_ref_ent_id":"xxxx",
                        "active_status":"1",
                        "physic_name":"xxxx",
                        "prepn_spec":"xxxx",
                        "pkg_spec":"xxxx",
                        "produce_date":"2024-08-10",
                        "expire_date":"2024-08-10"
                    }
                ]
            },
            "msg_info":"调用成功",
            "msg_code":"SUCCESS"
        }
    }
}

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下载

开放平台

阿里健康追溯码

alibaba.alihealth.synergy.yzw.druginfo.query (查询一张网药品信息通过mah、生产企业和批次号)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ