淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
inventory_request	BrandInventoryRequest	可选			请求参数
└ busi_date String 必须 2022-02-14 日期，yyyy-MM-dd └ page_num Number 可选 1 页码 └ item_ids Number [] 可选商品IDs └ page_size Number 可选 20 每页记录数 └ brand_ids Number [] 可选品牌IDs

名称	类型	示例值	描述
result	ResponseResult		返回数据
result PageResponse 品牌库存明细分页信息 result BrandInventoryDTO [] 品牌库存明细列表 └ brand_id Number 10000 品牌ID └ brand_name String Test品牌1 品牌名 └ busi_date String 2022-02-14 日期 └ seller_id Number 1 公司ID └ seller_name String Test公司公司名称 └ dept_id Number 1 门店ID └ dept_name String Test公司门店1 门店名称 └ item_id Number 1 商品ID └ item_name String Test胶囊1 商品名 └ item_commodity_name String Test胶囊通用名 └ item_spec String 0.25g*50s 规格 └ item_unit String 瓶商品单位 └ item_qty Number 99 数量 └ item_lot String 1 批号 └ item_batch String BN22012182 批次 └ prod_date Date 2020-08-26 00:00:00 生产日期 └ invalid_date Date 2024-07-31 00:00:00 有效期 └ supp_id Number 1 供应商ID └ supp_name String Test供应商1 供应商名称 └ channel Number 1 渠道。 1孔雀翎，2雨诺 └ total_count Number 100 总数量 └ page_size Number 20 每页大小 └ total_page Number 5 总页码 └ page_num Number 1 当前页码 └ success Boolean true 是否成功 └ error_code String 11 错误码 └ error_msg String 参数有误错误信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlihealthCepBrandInventoryListRequest req = new AlibabaAlihealthCepBrandInventoryListRequest();
AlibabaAlihealthCepBrandInventoryListRequest.BrandInventoryRequest obj1 = new AlibabaAlihealthCepBrandInventoryListRequest.BrandInventoryRequest();
obj1.setBusiDate("2022-02-14");
obj1.setPageNum(1L);
obj1.setItemIds(new Long[] {  };
);
obj1.setPageSize(20L);
obj1.setBrandIds(new Long[] {  };
);
req.setInventoryRequest(obj1);
AlibabaAlihealthCepBrandInventoryListResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlihealthCepBrandInventoryListRequest req = new AlibabaAlihealthCepBrandInventoryListRequest();
AlibabaAlihealthCepBrandInventoryListRequest.BrandInventoryRequestDomain obj1 = new AlibabaAlihealthCepBrandInventoryListRequest.BrandInventoryRequestDomain();
obj1.BusiDate = "2022-02-14";
obj1.PageNum = 1L;
obj1.ItemIds = new long[] {  };
;
obj1.PageSize = 20L;
obj1.BrandIds = new long[] {  };
;
req.InventoryRequest_ = obj1;
AlibabaAlihealthCepBrandInventoryListResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlihealthCepBrandInventoryListRequest;
$inventory_request = new BrandInventoryRequest;
$inventory_request->busi_date="2022-02-14";
$inventory_request->page_num="1";
$inventory_request->item_ids="";
$inventory_request->page_size="20";
$inventory_request->brand_ids="";
$req->setInventoryRequest(json_encode($inventory_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.cep.brand.inventory.list' \
-d 'partner_id=apidoc' \
-d 'sign=5EBE6C1C83B0C74A0C7CAFC792D0407C' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-09+20%3A43%3A35' \
-d 'v=2.0' \
-d 'inventory_request=null'

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

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

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

XML示例
JSON示例

<alibaba_alihealth_cep_brand_inventory_list_response>
    <result>
        <result>
            <result>
                <brand_inventory_d_t_o>
                    <brand_id>10000</brand_id>
                    <brand_name>Test品牌1</brand_name>
                    <busi_date>2022-02-14</busi_date>
                    <seller_id>1</seller_id>
                    <seller_name>Test公司</seller_name>
                    <dept_id>1</dept_id>
                    <dept_name>Test公司门店1</dept_name>
                    <item_id>1</item_id>
                    <item_name>Test胶囊1</item_name>
                    <item_commodity_name>Test胶囊</item_commodity_name>
                    <item_spec>0.25g*50s</item_spec>
                    <item_unit>瓶</item_unit>
                    <item_qty>99</item_qty>
                    <item_lot>1</item_lot>
                    <item_batch>BN22012182</item_batch>
                    <prod_date>2020-08-26 00:00:00</prod_date>
                    <invalid_date>2024-07-31 00:00:00</invalid_date>
                    <supp_id>1</supp_id>
                    <supp_name>Test供应商1</supp_name>
                    <channel>1</channel>
                </brand_inventory_d_t_o>
            </result>
            <total_count>100</total_count>
            <page_size>20</page_size>
            <total_page>5</total_page>
            <page_num>1</page_num>
        </result>
        <success>true</success>
        <error_code>11</error_code>
        <error_msg>参数有误</error_msg>
    </result>
</alibaba_alihealth_cep_brand_inventory_list_response>

{
    "alibaba_alihealth_cep_brand_inventory_list_response":{
        "result":{
            "result":{
                "result":{
                    "brand_inventory_d_t_o":[
                        {
                            "brand_id":10000,
                            "brand_name":"Test品牌1",
                            "busi_date":"2022-02-14",
                            "seller_id":1,
                            "seller_name":"Test公司",
                            "dept_id":1,
                            "dept_name":"Test公司门店1",
                            "item_id":1,
                            "item_name":"Test胶囊1",
                            "item_commodity_name":"Test胶囊",
                            "item_spec":"0.25g*50s",
                            "item_unit":"瓶",
                            "item_qty":99,
                            "item_lot":"1",
                            "item_batch":"BN22012182",
                            "prod_date":"2020-08-26 00:00:00",
                            "invalid_date":"2024-07-31 00:00:00",
                            "supp_id":1,
                            "supp_name":"Test供应商1",
                            "channel":1
                        }
                    ]
                },
                "total_count":100,
                "page_size":20,
                "total_page":5,
                "page_num":1
            },
            "success":true,
            "error_code":"11",
            "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.cep.brand.inventory.list (DDI厂商查询已授权品牌的库存明细)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ