淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
ddi_query_request	DdiQueryRequest	必须			请求体
└ stat_day String 必须 20250801 库存日期 └ item_ids String [] 可选 [ "612284885084"] 货品ID列表 └ company_name String 可选阿里健康大药房医药连锁有限公司公司主体(仓库所属主体) └ page_size Number 必须 20 分页大小 └ brand_ids String [] 必须 [ "6709552"] 品牌ID列表 └ page_num Number 必须 1 页号

名称	类型	示例值	描述
result	PagedResult		返回的分页信息
└ is_retry Boolean false 是否可重试 └ page_index Number 1 页号 └ total_page Number 12 总页数 └ success Boolean true 是否成功 └ page_size Number 20 每页大小 └ error_code String PARAMS_INVALID 错误码 └ total_count Number 115 总条数 body InventorySnapshotItem [] 数据列表 └ stat_date String 20250801 库存日期 └ store_code String STORE_12093254 仓库编号 └ store_name String 广交物流黄埔医药物流中心仓库名称 └ company_name String 阿里健康大药房医药连锁有限公司公司主体 └ sc_item_id String 612284885084 货品ID └ bar_code String 80021120105008 货品条码 └ sc_item_name String 曲莱曲莱/Trileptal 奥卡西平片 0.15g50片/盒标准装货品名称 └ spec String 0.15g50片/盒货品规格 └ basic_unit String 盒基本单位 └ total_qty Number 20 库存数量 └ in_trans_qty Number 0 调拨在途(30天内的调拨在途数量) └ factory_name String Novartis Farma S.p.A/北京诺华制药有限公司分装生产厂家 └ brand_id String 6709552 品牌ID └ brand_name String 曲莱品牌名称 └ approval_number String 国药准字HJ20171030(原国药准字J20171081 批准文号 └ error_msg String 查询日期不能为空错误描述

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlihealthBrandLsInventoryQueryRequest req = new AlibabaAlihealthBrandLsInventoryQueryRequest();
AlibabaAlihealthBrandLsInventoryQueryRequest.DdiQueryRequest obj1 = new AlibabaAlihealthBrandLsInventoryQueryRequest.DdiQueryRequest();
obj1.setStatDay("20250801");
obj1.setItemIds(" "612284885084"");
obj1.setCompanyName("阿里健康大药房医药连锁有限公司");
obj1.setPageSize(20L);
obj1.setBrandIds(" "6709552"");
obj1.setPageNum(1L);
req.setDdiQueryRequest(obj1);
AlibabaAlihealthBrandLsInventoryQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlihealthBrandLsInventoryQueryRequest req = new AlibabaAlihealthBrandLsInventoryQueryRequest();
AlibabaAlihealthBrandLsInventoryQueryRequest.DdiQueryRequestDomain obj1 = new AlibabaAlihealthBrandLsInventoryQueryRequest.DdiQueryRequestDomain();
obj1.StatDay = "20250801";
obj1.ItemIds = " "612284885084"";
obj1.CompanyName = "阿里健康大药房医药连锁有限公司";
obj1.PageSize = 20L;
obj1.BrandIds = " "6709552"";
obj1.PageNum = 1L;
req.DdiQueryRequest_ = obj1;
AlibabaAlihealthBrandLsInventoryQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlihealthBrandLsInventoryQueryRequest;
$ddi_query_request = new DdiQueryRequest;
$ddi_query_request->stat_day="20250801";
$ddi_query_request->item_ids="[ \"612284885084\"]";
$ddi_query_request->company_name="阿里健康大药房医药连锁有限公司";
$ddi_query_request->page_size="20";
$ddi_query_request->brand_ids="[ \"6709552\"]";
$ddi_query_request->page_num="1";
$req->setDdiQueryRequest(json_encode($ddi_query_request));
$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.ls.inventory.query' \
-d 'partner_id=apidoc' \
-d 'sign=CD597BC2F519881F4043BFBA48988D53' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-08-24+01%3A58%3A49' \
-d 'v=2.0' \
-d 'ddi_query_request=null'

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

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

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

XML示例
JSON示例

<alibaba_alihealth_brand_ls_inventory_query_response>
    <result>
        <is_retry>false</is_retry>
        <page_index>1</page_index>
        <total_page>12</total_page>
        <success>true</success>
        <page_size>20</page_size>
        <error_code>PARAMS_INVALID</error_code>
        <total_count>115</total_count>
        <body>
            <inventory_snapshot_item>
                <stat_date>20250801</stat_date>
                <store_code>STORE_12093254</store_code>
                <store_name>广交物流黄埔医药物流中心</store_name>
                <company_name>阿里健康大药房医药连锁有限公司</company_name>
                <sc_item_id>612284885084</sc_item_id>
                <bar_code>80021120105008</bar_code>
                <sc_item_name>曲莱 曲莱/Trileptal 奥卡西平片 0.15g*50片/盒 标准装</sc_item_name>
                <spec>0.15g*50片/盒</spec>
                <basic_unit>盒</basic_unit>
                <total_qty>20</total_qty>
                <in_trans_qty>0</in_trans_qty>
                <factory_name>Novartis Farma S.p.A/北京诺华制药有限公司分装</factory_name>
                <brand_id>6709552</brand_id>
                <brand_name>曲莱</brand_name>
                <approval_number>国药准字HJ20171030(原国药准字J20171081</approval_number>
            </inventory_snapshot_item>
        </body>
        <error_msg>查询日期不能为空</error_msg>
    </result>
</alibaba_alihealth_brand_ls_inventory_query_response>

{
    "alibaba_alihealth_brand_ls_inventory_query_response":{
        "result":{
            "is_retry":false,
            "page_index":1,
            "total_page":12,
            "success":true,
            "page_size":20,
            "error_code":"PARAMS_INVALID",
            "total_count":115,
            "body":{
                "inventory_snapshot_item":[
                    {
                        "stat_date":"20250801",
                        "store_code":"STORE_12093254",
                        "store_name":"广交物流黄埔医药物流中心",
                        "company_name":"阿里健康大药房医药连锁有限公司",
                        "sc_item_id":"612284885084",
                        "bar_code":"80021120105008",
                        "sc_item_name":"曲莱 曲莱\/Trileptal 奥卡西平片 0.15g*50片\/盒 标准装",
                        "spec":"0.15g*50片\/盒",
                        "basic_unit":"盒",
                        "total_qty":20,
                        "in_trans_qty":0,
                        "factory_name":"Novartis Farma S.p.A\/北京诺华制药有限公司分装",
                        "brand_id":"6709552",
                        "brand_name":"曲莱",
                        "approval_number":"国药准字HJ20171030(原国药准字J20171081"
                    }
                ]
            },
            "error_msg":"查询日期不能为空"
        }
    }
}

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.ls.inventory.query (零售DDI_库存快照查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ