淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
param	BrandOrderSummaryReq	可选			入参对象
└ end_date String 可选 20220530 截止日期-处方日期 └ page_size Number 必须 30 每页显示的条数 └ spu_ids String [] 可选 ["123","234"] SPUID └ start_date String 可选 20220501 开始日期-处方日期 └ page_num Number 必须 1 页号

名称	类型	示例值	描述
result	PagedResult		分页结果
└ error_code String 500 错误码 └ error_message String error 错误信息 └ page_index String 1 页号 └ page_size String 30 每页显示的条数 result BrandOrderSummaryRes [] 数据列表 └ brand_id String 123 品牌ID └ brand_name String 韦瑞德品牌名称 └ company_name String 阿里健康大药房健康主体公司名称 └ hosp_id String 12345 医院编码 └ hospital_city_name String 宝鸡市医院所在城市 └ hospital_name String 宝鸡市中心医院医院名称 └ hospital_prov_name String 陕西省医院所在省 └ outbound_quantity Number 50 正向销售出库盒数 └ quantity Number 48 实际销售盒数(正向出库-逆向销退) └ reverse_quantity Number 2 逆向销退盒数 └ sc_item_id String 123456 货品id └ sc_item_name String 富马酸替诺福韦二吡呋酯片货品名称 └ sc_item_spec String 300mg*30片/盒货品规格 └ seller_id String 12345 店铺ID └ seller_nick String 阿里健康药品旗舰店店铺名称 └ spu_id String 325381086 SPUID └ stat_date String 20220610 统计日期-处方日期 └ success String true 是否成功 └ total_count String 6300 总数 └ total_page String 200 总页数

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlihealthBrandHuyiOutboundQueryRequest req = new AlibabaAlihealthBrandHuyiOutboundQueryRequest();
AlibabaAlihealthBrandHuyiOutboundQueryRequest.BrandOrderSummaryReq obj1 = new AlibabaAlihealthBrandHuyiOutboundQueryRequest.BrandOrderSummaryReq();
obj1.setEndDate("20220530");
obj1.setPageSize(30L);
obj1.setSpuIds(""123","234"");
obj1.setStartDate("20220501");
obj1.setPageNum(1L);
req.setParam(obj1);
AlibabaAlihealthBrandHuyiOutboundQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlihealthBrandHuyiOutboundQueryRequest req = new AlibabaAlihealthBrandHuyiOutboundQueryRequest();
AlibabaAlihealthBrandHuyiOutboundQueryRequest.BrandOrderSummaryReqDomain obj1 = new AlibabaAlihealthBrandHuyiOutboundQueryRequest.BrandOrderSummaryReqDomain();
obj1.EndDate = "20220530";
obj1.PageSize = 30L;
obj1.SpuIds = ""123","234"";
obj1.StartDate = "20220501";
obj1.PageNum = 1L;
req.Param_ = obj1;
AlibabaAlihealthBrandHuyiOutboundQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlihealthBrandHuyiOutboundQueryRequest;
$param = new BrandOrderSummaryReq;
$param->end_date="20220530";
$param->page_size="30";
$param->spu_ids="[\"123\",\"234\"]";
$param->start_date="20220501";
$param->page_num="1";
$req->setParam(json_encode($param));
$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.brand.huyi.outbound.query' \
-d 'partner_id=apidoc' \
-d 'sign=3952B35463E2F734D315ED0A352CE324' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-09+20%3A38%3A08' \
-d 'v=2.0' \
-d 'param=null'

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

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

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

XML示例
JSON示例

<alibaba_alihealth_brand_huyi_outbound_query_response>
    <result>
        <error_code>500</error_code>
        <error_message>error</error_message>
        <page_index>1</page_index>
        <page_size>30</page_size>
        <result>
            <brand_order_summary_res>
                <brand_id>123</brand_id>
                <brand_name>韦瑞德</brand_name>
                <company_name>阿里健康大药房</company_name>
                <hosp_id>12345</hosp_id>
                <hospital_city_name>宝鸡市</hospital_city_name>
                <hospital_name>宝鸡市中心医院</hospital_name>
                <hospital_prov_name>陕西省</hospital_prov_name>
                <outbound_quantity>50</outbound_quantity>
                <quantity>48</quantity>
                <reverse_quantity>2</reverse_quantity>
                <sc_item_id>123456</sc_item_id>
                <sc_item_name>富马酸替诺福韦二吡呋酯片</sc_item_name>
                <sc_item_spec>300mg*30片/盒</sc_item_spec>
                <seller_id>12345</seller_id>
                <seller_nick>阿里健康药品旗舰店</seller_nick>
                <spu_id>325381086</spu_id>
                <stat_date>20220610</stat_date>
            </brand_order_summary_res>
        </result>
        <success>true</success>
        <total_count>6300</total_count>
        <total_page>200</total_page>
    </result>
</alibaba_alihealth_brand_huyi_outbound_query_response>

{
    "alibaba_alihealth_brand_huyi_outbound_query_response":{
        "result":{
            "error_code":"500",
            "error_message":"error",
            "page_index":"1",
            "page_size":"30",
            "result":{
                "brand_order_summary_res":[
                    {
                        "brand_id":"123",
                        "brand_name":"韦瑞德",
                        "company_name":"阿里健康大药房",
                        "hosp_id":"12345",
                        "hospital_city_name":"宝鸡市",
                        "hospital_name":"宝鸡市中心医院",
                        "hospital_prov_name":"陕西省",
                        "outbound_quantity":50,
                        "quantity":48,
                        "reverse_quantity":2,
                        "sc_item_id":"123456",
                        "sc_item_name":"富马酸替诺福韦二吡呋酯片",
                        "sc_item_spec":"300mg*30片\/盒",
                        "seller_id":"12345",
                        "seller_nick":"阿里健康药品旗舰店",
                        "spu_id":"325381086",
                        "stat_date":"20220610"
                    }
                ]
            },
            "success":"true",
            "total_count":"6300",
            "total_page":"200"
        }
    }
}

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.brand.huyi.outbound.query (互联网医院DDI-处方销售)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ