淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	描述
ref_ent_id	String	必须	12345	本企业refEntId
to_ref_user_id	String	可选	e2b4250536eb444581cb9f2ff51	收货企业refEntId
bill_code	String	可选	2024017175	单据号
upload_begin_date	String	必须	2024-03-05	单据上传开始日期，格式：yyyy-MM-dd
upload_end_date	String	必须	2024-05-10	单据上传截止日期，格式：yyyy-MM-dd
page	Number	必须	1	页数
page_size	Number	必须	10	每页

名称	类型	示例值	描述
result	ResultModel	跟节点信息	返回结果
model PageInfoDTO 对象模型信息返回模型 result_list BillReturnInRequestDTO [] 返回结果 └ bill_type String 103 单据类型 └ bill_code String 2024017175 单据号 └ from_ref_user_id String 5e4b071794d02692d 发货企业ID └ from_user_name String 测试零售药店发货企业名称 └ to_ref_user_id String eb444581cb9f2ff5101dba 收货企业ID └ to_user_name String 中信测试21世纪制药厂北京分公司收货企业名称 └ bill_time String 2024-05-09 18:08:34 单据时间 └ crt_date String 2024-05-09 08:36:23 创建时间 bill_code_and_parent_list BillCodeAndParent [] 单据码列表 └ parent_code String 81903850000002262771 父码 └ code_level Number 2 码等级 └ code String 81903850000002570534 码 └ total_num Number 120 总数 └ 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);
AlibabaAlihealthDrugtraceTopBillQueryListreturninbillsRequest req = new AlibabaAlihealthDrugtraceTopBillQueryListreturninbillsRequest();
req.setRefEntId("12345");
req.setToRefUserId("e2b4250536eb444581cb9f2ff51");
req.setBillCode("2024017175");
req.setUploadBeginDate("2024-03-05");
req.setUploadEndDate("2024-05-10");
req.setPage(1L);
req.setPageSize(10L);
AlibabaAlihealthDrugtraceTopBillQueryListreturninbillsResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlihealthDrugtraceTopBillQueryListreturninbillsRequest req = new AlibabaAlihealthDrugtraceTopBillQueryListreturninbillsRequest();
req.RefEntId = "12345";
req.ToRefUserId = "e2b4250536eb444581cb9f2ff51";
req.BillCode = "2024017175";
req.UploadBeginDate = "2024-03-05";
req.UploadEndDate = "2024-05-10";
req.Page = 1L;
req.PageSize = 10L;
AlibabaAlihealthDrugtraceTopBillQueryListreturninbillsResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlihealthDrugtraceTopBillQueryListreturninbillsRequest;
$req->setRefEntId("12345");
$req->setToRefUserId("e2b4250536eb444581cb9f2ff51");
$req->setBillCode("2024017175");
$req->setUploadBeginDate("2024-03-05");
$req->setUploadEndDate("2024-05-10");
$req->setPage("1");
$req->setPageSize("10");
$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.drugtrace.top.bill.query.listreturninbills' \
-d 'partner_id=apidoc' \
-d 'sign=C6A05B501506CD19C4A048C62262505C' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-21+06%3A09%3A33' \
-d 'v=2.0' \
-d 'bill_code=2024017175' \
-d 'page=1' \
-d 'page_size=10' \
-d 'ref_ent_id=12345' \
-d 'to_ref_user_id=e2b4250536eb444581cb9f2ff51' \
-d 'upload_begin_date=2024-03-05' \
-d 'upload_end_date=2024-05-10'

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

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

req.ref_ent_id="12345"
req.to_ref_user_id="e2b4250536eb444581cb9f2ff51"
req.bill_code="2024017175"
req.upload_begin_date="2024-03-05"
req.upload_end_date="2024-05-10"
req.page=1
req.page_size=10
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.drugtrace.top.bill.query.listreturninbills");
add_param(pRequest,"ref_ent_id","12345");
add_param(pRequest,"to_ref_user_id","e2b4250536eb444581cb9f2ff51");
add_param(pRequest,"bill_code","2024017175");
add_param(pRequest,"upload_begin_date","2024-03-05");
add_param(pRequest,"upload_end_date","2024-05-10");
add_param(pRequest,"page","1");
add_param(pRequest,"page_size","10");
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.drugtrace.top.bill.query.listreturninbills', {
	'ref_ent_id':'12345',
	'to_ref_user_id':'e2b4250536eb444581cb9f2ff51',
	'bill_code':'2024017175',
	'upload_begin_date':'2024-03-05',
	'upload_end_date':'2024-05-10',
	'page':'1',
	'page_size':'10'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_alihealth_drugtrace_top_bill_query_listreturninbills_response>
    <result>
        <model>
            <result_list>
                <bill_return_in_request_d_t_o>
                    <bill_type>103</bill_type>
                    <bill_code>2024017175</bill_code>
                    <from_ref_user_id>5e4b071794d02692d</from_ref_user_id>
                    <from_user_name>测试零售药店</from_user_name>
                    <to_ref_user_id>eb444581cb9f2ff5101dba</to_ref_user_id>
                    <to_user_name>中信测试21世纪制药厂北京分公司</to_user_name>
                    <bill_time>2024-05-09 18:08:34</bill_time>
                    <crt_date>2024-05-09 08:36:23</crt_date>
                    <bill_code_and_parent_list>
                        <bill_code_and_parent>
                            <parent_code>81903850000002262771</parent_code>
                            <code_level>2</code_level>
                            <code>81903850000002570534</code>
                        </bill_code_and_parent>
                    </bill_code_and_parent_list>
                </bill_return_in_request_d_t_o>
            </result_list>
            <total_num>120</total_num>
        </model>
        <msg_code>1000</msg_code>
        <msg_info>成功</msg_info>
        <success>true</success>
    </result>
</alibaba_alihealth_drugtrace_top_bill_query_listreturninbills_response>

{
    "alibaba_alihealth_drugtrace_top_bill_query_listreturninbills_response":{
        "result":{
            "model":{
                "result_list":{
                    "bill_return_in_request_d_t_o":[
                        {
                            "bill_type":"103",
                            "bill_code":"2024017175",
                            "from_ref_user_id":"5e4b071794d02692d",
                            "from_user_name":"测试零售药店",
                            "to_ref_user_id":"eb444581cb9f2ff5101dba",
                            "to_user_name":"中信测试21世纪制药厂北京分公司",
                            "bill_time":"2024-05-09 18:08:34",
                            "crt_date":"2024-05-09 08:36:23",
                            "bill_code_and_parent_list":{
                                "bill_code_and_parent":[
                                    {
                                        "parent_code":"81903850000002262771",
                                        "code_level":2,
                                        "code":"81903850000002570534"
                                    }
                                ]
                            }
                        }
                    ]
                },
                "total_num":120
            },
            "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.drugtrace.top.bill.query.listreturninbills (退货入库单据列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ