淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
auth_ref_ent_id	String	必须	320000000000127967		验证权限企业id
ref_ent_id	String	必须	320000000000127967		企业refEntId
search_source	String	必须	hospital		标示医院业务
code_list	String []	必须	83003850000000131888	最大列表长度：20	追溯码
cert_isv_no	String	可选	12345		证件编号
invocation	String	可选	formal		调用方式：formal-正式、test-测试
terminal_type	String	可选	1		终端类型 1：零售
terminal_name	String	可选	漱玉		调用零售药店名称
bureau_name	String	可选	北京		城市名称
error_message	String	可选	医院错误		错误信息

名称	类型	示例值	描述
result	ResultModel	最外层结果	最外层结果
models CodeFullInfoDto [] 内层大对象内层大对象 └ msg_code String 1000 表示成功 code_produce_info_d_t_o CodeProduceInfoDto 码生产信息对象码生产信息对象 └ produce_date Date 2018-10-08 00:00:00 码生产日期 └ produce_batch_no String 特药激活1810110001-1 码批次号 └ produce_info_id String d7975d7348964cb2bd8a179012069baa 码生产信息id └ pkg_ratio String 1:3:9 包装比例 produce_info_list ProduceInfoDto [] 生产信息集合生产信息集合 └ batch_no String 有效期等于2年显示批次号 └ produce_date Date 20180730000000 生产日期 └ expire_date String 20200730 有效期至 └ pkg_amount String 10 最小包装数量 drug_ent_base_d_t_o DrugEntBaseDto 药品基本信息对象药品基本信息对象 └ drug_ent_base_id String 000000000000001100 药品信息id └ drug_ent_base_info_id String 000000000000001100 药品基本信息id └ approval_licence_no String 国药准字H13024467X 批准文号 └ physic_name String 葡萄糖氯化钠注射液药品名称 └ physic_type_desc String 普通药品药品类型描述 └ pkg_spec_crit String 100支/盒包装规格 └ prepn_spec String 500ml:葡萄糖25g,氯化纳4.5g（玻瓶）制剂规格 └ prepn_type_desc String 注射剂剂型描述 └ exprie String 2年有效期长度 └ prod_name String 尼美舒利分散片商品名称 └ pkg_num Number 12 包装数量 └ sdc_code String 1234 批准文号 └ prepn_unit_desc String 盒制剂单位类型描述 └ prod_code String 6343946701 药品子类编码 └ physic_code String 6343946 药品编码 └ physic_detail_type Number 10 药品详细类型 p_user_ent_d_t_o PUserEntDto 企业信息对象企业信息对象 └ org_code String 634394670 机构编码 └ ent_name String 中信测试21世纪制药厂北京分公司1 原企业名称 └ ent_name_new String 中信测试21世纪制药厂北京分公司1 新企业名称 └ ref_ent_id String 6343946701 企业refid └ ent_id String 6343946701 企业id code_status_type_d_t_o CodeStatusTypeDto 无追溯码状态对象 └ verification_type String A 追溯码状态 └ last_biz_date String 2018-10-08 00:00:00 最后业务日期 └ code String 83003850000000131888 码 └ check_count Number 2 医保核销次数 └ include_produce_code_count Number 11 父码下子码的数量 └ code_status_num String 激活码状态 parent_code_info_list ParentCodeInfo [] 当前码的所有父码和packageLevel 当前码的所有父码和packageLevel └ package_level Number 2 码级别 └ parent_code String 88003850000000131888 父码 child_codes Childcodes [] 当前码的子码当前码的子码 └ pkg_level Number 88003850100000131888 子码 └ code String 1 子码级别 └ package_level Number 2 码包装层级 code_active_info_list_api_d_t_o CodeActiveInfoListApiDto 码激活信息码激活信息 └ pkg_ratio String 1:10 包装比例 └ code String 88003850100000131888 追溯码 └ msg_code String 1000 消息码 └ msg_info String 查询成功消息提示内容 └ success Boolean true 查询成功失败标记

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlihealthDrugCodeCommonListCodeinfoRequest req = new AlibabaAlihealthDrugCodeCommonListCodeinfoRequest();
req.setAuthRefEntId("320000000000127967");
req.setRefEntId("320000000000127967");
req.setSearchSource("hospital");
req.setCodeList("83003850000000131888");
req.setCertIsvNo("12345");
req.setInvocation("formal");
req.setTerminalType("1");
req.setTerminalName("漱玉");
req.setBureauName("北京");
req.setErrorMessage("医院错误");
AlibabaAlihealthDrugCodeCommonListCodeinfoResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlihealthDrugCodeCommonListCodeinfoRequest req = new AlibabaAlihealthDrugCodeCommonListCodeinfoRequest();
req.AuthRefEntId = "320000000000127967";
req.RefEntId = "320000000000127967";
req.SearchSource = "hospital";
req.CodeList = "83003850000000131888";
req.CertIsvNo = "12345";
req.Invocation = "formal";
req.TerminalType = "1";
req.TerminalName = "漱玉";
req.BureauName = "北京";
req.ErrorMessage = "医院错误";
AlibabaAlihealthDrugCodeCommonListCodeinfoResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlihealthDrugCodeCommonListCodeinfoRequest;
$req->setAuthRefEntId("320000000000127967");
$req->setRefEntId("320000000000127967");
$req->setSearchSource("hospital");
$req->setCodeList("83003850000000131888");
$req->setCertIsvNo("12345");
$req->setInvocation("formal");
$req->setTerminalType("1");
$req->setTerminalName("漱玉");
$req->setBureauName("北京");
$req->setErrorMessage("医院错误");
$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.drug.code.common.list.codeinfo' \
-d 'partner_id=apidoc' \
-d 'sign=8F45E9B19EC23C32C78010860915F7B5' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-02+10%3A57%3A04' \
-d 'v=2.0' \
-d 'auth_ref_ent_id=320000000000127967' \
-d 'bureau_name=%E5%8C%97%E4%BA%AC' \
-d 'cert_isv_no=12345' \
-d 'code_list=83003850000000131888' \
-d 'error_message=%E5%8C%BB%E9%99%A2%E9%94%99%E8%AF%AF' \
-d 'invocation=formal' \
-d 'ref_ent_id=320000000000127967' \
-d 'search_source=hospital' \
-d 'terminal_name=%E6%BC%B1%E7%8E%89' \
-d 'terminal_type=1'

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

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

req.auth_ref_ent_id="320000000000127967"
req.ref_ent_id="320000000000127967"
req.search_source="hospital"
req.code_list="83003850000000131888"
req.cert_isv_no="12345"
req.invocation="formal"
req.terminal_type="1"
req.terminal_name="漱玉"
req.bureau_name="北京"
req.error_message="医院错误"
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.drug.code.common.list.codeinfo");
add_param(pRequest,"auth_ref_ent_id","320000000000127967");
add_param(pRequest,"ref_ent_id","320000000000127967");
add_param(pRequest,"search_source","hospital");
add_param(pRequest,"code_list","83003850000000131888");
add_param(pRequest,"cert_isv_no","12345");
add_param(pRequest,"invocation","formal");
add_param(pRequest,"terminal_type","1");
add_param(pRequest,"terminal_name","漱玉");
add_param(pRequest,"bureau_name","北京");
add_param(pRequest,"error_message","医院错误");
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.drug.code.common.list.codeinfo', {
	'auth_ref_ent_id':'320000000000127967',
	'ref_ent_id':'320000000000127967',
	'search_source':'hospital',
	'code_list':'83003850000000131888',
	'cert_isv_no':'12345',
	'invocation':'formal',
	'terminal_type':'1',
	'terminal_name':'漱玉',
	'bureau_name':'北京',
	'error_message':'医院错误'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_alihealth_drug_code_common_list_codeinfo_response>
    <result>
        <models>
            <code_full_info_dto>
                <msg_code>1000</msg_code>
                <code_produce_info_d_t_o>
                    <produce_date>2018-10-08 00:00:00</produce_date>
                    <produce_batch_no>特药激活1810110001-1</produce_batch_no>
                    <produce_info_id>d7975d7348964cb2bd8a179012069baa</produce_info_id>
                    <pkg_ratio>1:3:9</pkg_ratio>
                    <produce_info_list>
                        <produce_info_dto>
                            <batch_no>有效期等于2年显示</batch_no>
                            <produce_date>20180730000000</produce_date>
                            <expire_date>20200730</expire_date>
                            <pkg_amount>10</pkg_amount>
                        </produce_info_dto>
                    </produce_info_list>
                </code_produce_info_d_t_o>
                <drug_ent_base_d_t_o>
                    <drug_ent_base_id>000000000000001100</drug_ent_base_id>
                    <drug_ent_base_info_id>000000000000001100</drug_ent_base_info_id>
                    <approval_licence_no>国药准字H13024467X</approval_licence_no>
                    <physic_name>葡萄糖氯化钠注射液</physic_name>
                    <physic_type_desc>普通药品</physic_type_desc>
                    <pkg_spec_crit>100支/盒</pkg_spec_crit>
                    <prepn_spec>500ml:葡萄糖25g,氯化纳4.5g（玻瓶）</prepn_spec>
                    <prepn_type_desc>注射剂</prepn_type_desc>
                    <exprie>2年</exprie>
                    <prod_name>尼美舒利分散片</prod_name>
                    <pkg_num>12</pkg_num>
                    <sdc_code>1234</sdc_code>
                    <prepn_unit_desc>盒</prepn_unit_desc>
                    <prod_code>6343946701</prod_code>
                    <physic_code>6343946</physic_code>
                    <physic_detail_type>10</physic_detail_type>
                </drug_ent_base_d_t_o>
                <p_user_ent_d_t_o>
                    <org_code>634394670</org_code>
                    <ent_name>中信测试21世纪制药厂北京分公司1</ent_name>
                    <ent_name_new>中信测试21世纪制药厂北京分公司1</ent_name_new>
                    <ref_ent_id>6343946701</ref_ent_id>
                    <ent_id>6343946701</ent_id>
                </p_user_ent_d_t_o>
                <code_status_type_d_t_o>
                    <verification_type>A</verification_type>
                    <last_biz_date>2018-10-08 00:00:00</last_biz_date>
                    <code>83003850000000131888</code>
                    <check_count>2</check_count>
                    <include_produce_code_count>11</include_produce_code_count>
                    <code_status_num>激活</code_status_num>
                    <parent_code_info_list>
                        <parent_code_info>
                            <package_level>2</package_level>
                            <parent_code>88003850000000131888</parent_code>
                        </parent_code_info>
                    </parent_code_info_list>
                    <child_codes>
                        <childcodes>
                            <pkg_level>88003850100000131888</pkg_level>
                            <code>1</code>
                        </childcodes>
                    </child_codes>
                </code_status_type_d_t_o>
                <package_level>2</package_level>
                <code_active_info_list_api_d_t_o>
                    <pkg_ratio>1:10</pkg_ratio>
                </code_active_info_list_api_d_t_o>
                <code>88003850100000131888</code>
            </code_full_info_dto>
        </models>
        <msg_code>1000</msg_code>
        <msg_info>查询成功</msg_info>
        <success>true</success>
    </result>
</alibaba_alihealth_drug_code_common_list_codeinfo_response>

{
    "alibaba_alihealth_drug_code_common_list_codeinfo_response":{
        "result":{
            "models":{
                "code_full_info_dto":[
                    {
                        "msg_code":"1000",
                        "code_produce_info_d_t_o":{
                            "produce_date":"2018-10-08 00:00:00",
                            "produce_batch_no":"特药激活1810110001-1",
                            "produce_info_id":"d7975d7348964cb2bd8a179012069baa",
                            "pkg_ratio":"1:3:9",
                            "produce_info_list":{
                                "produce_info_dto":[
                                    {
                                        "batch_no":"有效期等于2年显示",
                                        "produce_date":"20180730000000",
                                        "expire_date":"20200730",
                                        "pkg_amount":"10"
                                    }
                                ]
                            }
                        },
                        "drug_ent_base_d_t_o":{
                            "drug_ent_base_id":"000000000000001100",
                            "drug_ent_base_info_id":"000000000000001100",
                            "approval_licence_no":"国药准字H13024467X",
                            "physic_name":"葡萄糖氯化钠注射液",
                            "physic_type_desc":"普通药品",
                            "pkg_spec_crit":"100支\/盒",
                            "prepn_spec":"500ml:葡萄糖25g,氯化纳4.5g（玻瓶）",
                            "prepn_type_desc":"注射剂",
                            "exprie":"2年",
                            "prod_name":"尼美舒利分散片",
                            "pkg_num":12,
                            "sdc_code":"1234",
                            "prepn_unit_desc":"盒",
                            "prod_code":"6343946701",
                            "physic_code":"6343946",
                            "physic_detail_type":10
                        },
                        "p_user_ent_d_t_o":{
                            "org_code":"634394670",
                            "ent_name":"中信测试21世纪制药厂北京分公司1",
                            "ent_name_new":"中信测试21世纪制药厂北京分公司1",
                            "ref_ent_id":"6343946701",
                            "ent_id":"6343946701"
                        },
                        "code_status_type_d_t_o":{
                            "verification_type":"A",
                            "last_biz_date":"2018-10-08 00:00:00",
                            "code":"83003850000000131888",
                            "check_count":2,
                            "include_produce_code_count":11,
                            "code_status_num":"激活",
                            "parent_code_info_list":{
                                "parent_code_info":[
                                    {
                                        "package_level":2,
                                        "parent_code":"88003850000000131888"
                                    }
                                ]
                            },
                            "child_codes":{
                                "childcodes":[
                                    {
                                        "pkg_level":88003850100000131888,
                                        "code":"1"
                                    }
                                ]
                            }
                        },
                        "package_level":2,
                        "code_active_info_list_api_d_t_o":{
                            "pkg_ratio":"1:10"
                        },
                        "code":"88003850100000131888"
                    }
                ]
            },
            "msg_code":"1000",
            "msg_info":"查询成功",
            "success":true
        }
    }
}

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.drug.code.common.list.codeinfo (通用查询码接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ