淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
bill_code	String	必须	DR000_001	单据编号（唯一）
bill_time	Date	必须	2019-02-02 02:21:21	单据生成时间（一般写当前时间）
bill_type	Number	必须	321	单据类型[321,零售出库][322,疫苗接种]
physic_type	Number	可选	3	药品类型[2,特药，3,普药]
ref_user_id	String	必须	320000000000127971	码上放心平台企业唯一编码（门店或医疗机构）
from_user_id	String	可选	320000002332	发货企业(可为空)
oper_ic_code	String	可选	2100000345	单据提交者(appkey编号)
oper_ic_name	String	可选	张三	单据提交者姓名(可为空)
trace_codes	String	必须	2	20位追溯码（多个时用半角逗号分隔）
customer_id_type	String	可选	5	购买人证件类型【1身份证2护照3 军官证4 医保卡5接种卡6学生证9其它】
customer_id	String	可选	60123456789	购买人证件编号
user_tel	String	可选	15081226604	用药人名称
network_bill_flag	String	可选	1	互联网标志 1是 0否
medic_doctor	String	可选	张三	医师名称
medic_dispenser	String	可选	李四	药品发药人
user_name	String	可选	王五	药品使用者
user_agent	String	可选	胡	药品使用者代理人
ignore_part_success_flag	String	可选	0	码解析策略,1代表整单解析成功(任一码解析失败，上传时整单返回错误),传其他值或者不传代表部分解析成功(跳过无法解析的码，其余正常处理并上传)

名称	类型	示例值	描述
model	String	421342341	上传单据文件队列表标识
msg_code	String	BILL_DECODE_ERROR	错误码(BILL_DECODE_ERROR 单据转码失败 2.BILL_FILE_NAME_DUPLICATE_UPLOAD 文件名重复)
msg_info	String	单据转码失败	错误信息
response_success	Boolean	false	操作是否成功(true 成功 ,false失败)
sub_msg_code	String	SUCCESS	结果子编码
operation_info_map	OperationInfoMap	{"codeCheckErrorInfo":"{\"3\":\"86443150000000180533,86443160000000568910,84312420000002824318\",\"6\":\"84312420000002824318（下级）;86443160000000568910（上级）,86443160000000568910（下级）;86443150000000180533（上级）\"}"}	错误信息明细,便于后续操作
└ code_check_error_info String {"3":"86443150000000180533,86443160000000568910,84312420000002824318","6":"84312420000002824318（下级）;86443160000000568910（上级）,86443160000000568910（下级）;86443150000000180533（上级）"} json,key是错误类型编码,value是具体得信息,详细参考文档

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlihealthDrugKytVaUploadretailRequest req = new AlibabaAlihealthDrugKytVaUploadretailRequest();
req.setBillCode("DR000_001");
req.setBillTime(StringUtils.parseDateTime("2019-02-02 02:21:21"));
req.setBillType(321L);
req.setPhysicType(3L);
req.setRefUserId("320000000000127971");
req.setFromUserId("320000002332");
req.setOperIcCode("2100000345");
req.setOperIcName("张三");
req.setTraceCodes("2");
req.setCustomerIdType("5");
req.setCustomerId("60123456789");
req.setUserTel("15081226604");
req.setNetworkBillFlag("1");
req.setMedicDoctor("张三");
req.setMedicDispenser("李四");
req.setUserName("王五");
req.setUserAgent("胡");
req.setIgnorePartSuccessFlag("0");
AlibabaAlihealthDrugKytVaUploadretailResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlihealthDrugKytVaUploadretailRequest req = new AlibabaAlihealthDrugKytVaUploadretailRequest();
req.BillCode = "DR000_001";
req.BillTime = DateTime.Parse("2019-02-02 02:21:21");
req.BillType = 321L;
req.PhysicType = 3L;
req.RefUserId = "320000000000127971";
req.FromUserId = "320000002332";
req.OperIcCode = "2100000345";
req.OperIcName = "张三";
req.TraceCodes = "2";
req.CustomerIdType = "5";
req.CustomerId = "60123456789";
req.UserTel = "15081226604";
req.NetworkBillFlag = "1";
req.MedicDoctor = "张三";
req.MedicDispenser = "李四";
req.UserName = "王五";
req.UserAgent = "胡";
req.IgnorePartSuccessFlag = "0";
AlibabaAlihealthDrugKytVaUploadretailResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlihealthDrugKytVaUploadretailRequest;
$req->setBillCode("DR000_001");
$req->setBillTime("2019-02-02 02:21:21");
$req->setBillType("321");
$req->setPhysicType("3");
$req->setRefUserId("320000000000127971");
$req->setFromUserId("320000002332");
$req->setOperIcCode("2100000345");
$req->setOperIcName("张三");
$req->setTraceCodes("2");
$req->setCustomerIdType("5");
$req->setCustomerId("60123456789");
$req->setUserTel("15081226604");
$req->setNetworkBillFlag("1");
$req->setMedicDoctor("张三");
$req->setMedicDispenser("李四");
$req->setUserName("王五");
$req->setUserAgent("胡");
$req->setIgnorePartSuccessFlag("0");
$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.kyt.va.uploadretail' \
-d 'partner_id=apidoc' \
-d 'sign=7A91CA744C48F2D63A7B7AD17C442C3C' \
-d 'sign_method=hmac' \
-d 'timestamp=2026-04-04+07%3A21%3A05' \
-d 'v=2.0' \
-d 'bill_code=DR000_001' \
-d 'bill_time=2019-02-02+02%3A21%3A21' \
-d 'bill_type=321' \
-d 'customer_id=60123456789' \
-d 'customer_id_type=5' \
-d 'from_user_id=320000002332' \
-d 'ignore_part_success_flag=0' \
-d 'medic_dispenser=%E6%9D%8E%E5%9B%9B' \
-d 'medic_doctor=%E5%BC%A0%E4%B8%89' \
-d 'network_bill_flag=1' \
-d 'oper_ic_code=2100000345' \
-d 'oper_ic_name=%E5%BC%A0%E4%B8%89' \
-d 'physic_type=3' \
-d 'ref_user_id=320000000000127971' \
-d 'trace_codes=2' \
-d 'user_agent=%E8%83%A1' \
-d 'user_name=%E7%8E%8B%E4%BA%94' \
-d 'user_tel=15081226604'

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

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

req.bill_code="DR000_001"
req.bill_time="2019-02-02 02:21:21"
req.bill_type=321
req.physic_type=3
req.ref_user_id="320000000000127971"
req.from_user_id="320000002332"
req.oper_ic_code="2100000345"
req.oper_ic_name="张三"
req.trace_codes="2"
req.customer_id_type="5"
req.customer_id="60123456789"
req.user_tel="15081226604"
req.network_bill_flag="1"
req.medic_doctor="张三"
req.medic_dispenser="李四"
req.user_name="王五"
req.user_agent="胡"
req.ignore_part_success_flag="0"
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.kyt.va.uploadretail");
add_param(pRequest,"bill_code","DR000_001");
add_param(pRequest,"bill_time","2019-02-02 02:21:21");
add_param(pRequest,"bill_type","321");
add_param(pRequest,"physic_type","3");
add_param(pRequest,"ref_user_id","320000000000127971");
add_param(pRequest,"from_user_id","320000002332");
add_param(pRequest,"oper_ic_code","2100000345");
add_param(pRequest,"oper_ic_name","张三");
add_param(pRequest,"trace_codes","2");
add_param(pRequest,"customer_id_type","5");
add_param(pRequest,"customer_id","60123456789");
add_param(pRequest,"user_tel","15081226604");
add_param(pRequest,"network_bill_flag","1");
add_param(pRequest,"medic_doctor","张三");
add_param(pRequest,"medic_dispenser","李四");
add_param(pRequest,"user_name","王五");
add_param(pRequest,"user_agent","胡");
add_param(pRequest,"ignore_part_success_flag","0");
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',
	'url': 'http://gw.api.taobao.com/router/rest'
});

client.execute('alibaba.alihealth.drug.kyt.va.uploadretail', {
	'bill_code':'DR000_001',
	'bill_time':'2019-02-02 02:21:21',
	'bill_type':'321',
	'physic_type':'3',
	'ref_user_id':'320000000000127971',
	'from_user_id':'320000002332',
	'oper_ic_code':'2100000345',
	'oper_ic_name':'张三',
	'trace_codes':'2',
	'customer_id_type':'5',
	'customer_id':'60123456789',
	'user_tel':'15081226604',
	'network_bill_flag':'1',
	'medic_doctor':'张三',
	'medic_dispenser':'李四',
	'user_name':'王五',
	'user_agent':'胡',
	'ignore_part_success_flag':'0'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_alihealth_drug_kyt_va_uploadretail_response>
    <model>421342341</model>
    <msg_code>BILL_DECODE_ERROR</msg_code>
    <msg_info>单据转码失败</msg_info>
    <response_success>false</response_success>
    <sub_msg_code>SUCCESS</sub_msg_code>
    <operation_info_map>
        <code_check_error_info>{&quot;3&quot;:&quot;86443150000000180533,86443160000000568910,84312420000002824318&quot;,&quot;6&quot;:&quot;84312420000002824318（下级）;86443160000000568910（上级）,86443160000000568910（下级）;86443150000000180533（上级）&quot;}</code_check_error_info>
    </operation_info_map>
</alibaba_alihealth_drug_kyt_va_uploadretail_response>

{
    "alibaba_alihealth_drug_kyt_va_uploadretail_response":{
        "model":"421342341",
        "msg_code":"BILL_DECODE_ERROR",
        "msg_info":"单据转码失败",
        "response_success":false,
        "sub_msg_code":"SUCCESS",
        "operation_info_map":{
            "code_check_error_info":"{\"3\":\"86443150000000180533,86443160000000568910,84312420000002824318\",\"6\":\"84312420000002824318（下级）;86443160000000568910（上级）,86443160000000568910（下级）;86443150000000180533（上级）\"}"
        }
    }
}

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.kyt.va.uploadretail (零售单据上传接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ