淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
fields	String	必须	pic_url,num,props,valid_thru		需返回的字段列表。可选值为 Item 商品结构体中的以下字段： approve_status,num_iid,title,nick,type,cid,pic_url,num,props,valid_thru, list_time,price,has_discount,has_invoice,has_warranty,has_showcase, modified,delist_time,postage_id,seller_cids,outer_id；字段之间用“,”分隔。不支持其他字段，如果需要获取其他字段数据，调用taobao.item.seller.get。
q	String	可选	nike		搜索字段。搜索商品的title。
cid	Number	可选	1232		商品类目ID。ItemCat中的cid字段。可以通过taobao.itemcats.get取到
seller_cids	String	可选	12,123		卖家店铺内自定义类目ID。多个之间用“,”分隔。可以根据taobao.sellercats.list.get获得.(注：目前最多支持32个ID号传入)
page_no	Number	可选	2	默认值：1	页码。取值范围:大于零小于等于101的整数;默认值为1，即返回第一页数据。当页码超过101页时系统就会报错，故请大家在用此接口获取数据时尽可能的细化自己的搜索条件，例如根据修改时间分段获取商品。
page_size	Number	可选	40	默认值：40	每页条数。取值范围:大于零的整数;最大值：200；默认值：40。
order_by	String	可选	list_time:desc	默认值：list_time:desc	排序方式。格式为column:asc/desc ，column可选值:list_time(上架时间),delist_time(下架时间),num(商品数量)，modified(最近修改时间);默认上架时间降序(即最新上架排在前面)。如按照上架时间降序排序方式为list_time:desc
has_discount	Boolean	可选	true		是否参与会员折扣。可选值：true，false。默认不过滤该条件
is_taobao	Boolean	可选	true		商品是否在淘宝显示
is_ex	Boolean	可选	true		商品是否在外部网店显示
banner	String	可选	for_shelved		分类字段。可选值: regular_shelved(定时上架) never_on_shelf(从未上架) off_shelf(我下架的) for_shelved(等待所有上架) sold_out(全部卖完) violation_off_shelf(违规下架的) 默认查询for_shelved(等待所有上架)这个状态的商品注：for_shelved(等待所有上架)=regular_shelved(定时上架)+never_on_shelf(从未上架)+off_shelf(我下架的)
start_modified	Date	可选	2000-01-01 00:00:00		商品起始修改时间
end_modified	Date	可选	2000-01-01 00:00:00		商品结束修改时间
is_cspu	Boolean	可选	true		是否挂接了达尔文标准产品体系。
auction_type	String	可选	a		商品类型 a: 拍卖;b: 一口价

名称	类型	示例值	描述
items	Item []		搜索到底商品列表，具体字段根据设定的fields决定，不包括desc,stuff_status字段
└ approve_status String onsale 商品上传后的状态。onsale出售中，instock库中 └ iid String 569a64fce2e98bce187bcbbb4a4d262a 商品id(注意：iid近期即将废弃，请用num_iid参数) └ num_iid Number 1489161932 商品数字id └ title String Google test item 商品标题,不能超过60字节 └ nick String tbtest561 卖家昵称 └ type String fixed 商品类型(fixed:一口价;auction:拍卖)注：取消团购 └ cid Number 132443 商品所属的叶子类目 id └ seller_cids String 2234445,3344466,446434 商品所属的店铺内卖家自定义类目列表 └ pic_url String http://img03.taobao.net/bao/uploaded/i3/T1HXdXXgPSt0JxZ2.8_070458.jpg 商品主图片地址 └ num Number 8888 商品数量 └ props String 135255:344454 商品属性格式：pid:vid;pid:vid └ valid_thru Number 7 有效期,7或者14（默认是14天） └ list_time Date 2009-10-22 14:22:06 上架时间（格式：yyyy-MM-dd HH:mm:ss） └ price String 5.00 商品价格，格式：5.00；单位：元；精确到：分 └ has_discount Boolean true 支持会员打折,true/false └ has_invoice Boolean true 是否有发票,true/false └ has_warranty Boolean true 是否有保修,true/false └ has_showcase Boolean true 橱窗推荐,true/false └ modified Date 2000-01-01 00:00:00 商品修改时间（格式：yyyy-MM-dd HH:mm:ss） └ delist_time Date 2000-01-01 00:00:00 下架时间（格式：yyyy-MM-dd HH:mm:ss） └ postage_id Number 32 宝贝所属的运费模板ID，如果没有返回则说明没有使用运费模板 └ outer_id String 34143554352 商家外部编码(可与商家外部系统对接) └ is_taobao Boolean true 是否在淘宝显示 └ is_ex Boolean true 是否在外部网店显示 └ is_virtual Boolean true 虚拟商品的状态字段 └ with_hold_quantity Number 12 withHoldQuantity └ is_cspu Boolean true 是否为达尔文挂接成功了的商品 └ first_starts_time Date 2000-01-01 00:00:00 商品首次上架时间
total_results	Number	1	搜索到符合条件的结果总数

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
ItemsInventoryGetTmallRequest req = new ItemsInventoryGetTmallRequest();
req.setFields("pic_url,num,props,valid_thru");
req.setQ("nike");
req.setCid(1232L);
req.setSellerCids("12,123");
req.setPageNo(2L);
req.setPageSize(40L);
req.setOrderBy("list_time:desc");
req.setHasDiscount(true);
req.setIsTaobao(true);
req.setIsEx(true);
req.setBanner("for_shelved");
req.setStartModified(StringUtils.parseDateTime("2000-01-01 00:00:00"));
req.setEndModified(StringUtils.parseDateTime("2000-01-01 00:00:00"));
req.setIsCspu(true);
req.setAuctionType("a");
ItemsInventoryGetTmallResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
ItemsInventoryGetTmallRequest req = new ItemsInventoryGetTmallRequest();
req.Fields = "pic_url,num,props,valid_thru";
req.Q = "nike";
req.Cid = 1232L;
req.SellerCids = "12,123";
req.PageNo = 2L;
req.PageSize = 40L;
req.OrderBy = "list_time:desc";
req.HasDiscount = true;
req.IsTaobao = true;
req.IsEx = true;
req.Banner = "for_shelved";
req.StartModified = DateTime.Parse("2000-01-01 00:00:00");
req.EndModified = DateTime.Parse("2000-01-01 00:00:00");
req.IsCspu = true;
req.AuctionType = "a";
ItemsInventoryGetTmallResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new ItemsInventoryGetTmallRequest;
$req->setFields("pic_url,num,props,valid_thru");
$req->setQ("nike");
$req->setCid("1232");
$req->setSellerCids("12,123");
$req->setPageNo("2");
$req->setPageSize("40");
$req->setOrderBy("list_time:desc");
$req->setHasDiscount("true");
$req->setIsTaobao("true");
$req->setIsEx("true");
$req->setBanner("for_shelved");
$req->setStartModified("2000-01-01 00:00:00");
$req->setEndModified("2000-01-01 00:00:00");
$req->setIsCspu("true");
$req->setAuctionType("a");
$resp = $c->execute($req, $sessionKey);

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=taobao.items.inventory.get.tmall' \
-d 'partner_id=apidoc' \
-d 'session=bacd942f-a8bf-4018-b89b-907a75ee3bc4' \
-d 'sign=2ABA19E6EA30645C47E5361528590DF9' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-29+20%3A29%3A40' \
-d 'v=2.0' \
-d 'auction_type=a' \
-d 'banner=for_shelved' \
-d 'cid=1232' \
-d 'end_modified=2000-01-01+00%3A00%3A00' \
-d 'fields=pic_url%2Cnum%2Cprops%2Cvalid_thru' \
-d 'has_discount=true' \
-d 'is_cspu=true' \
-d 'is_ex=true' \
-d 'is_taobao=true' \
-d 'order_by=list_time%3Adesc' \
-d 'page_no=2' \
-d 'page_size=40' \
-d 'q=nike' \
-d 'seller_cids=12%2C123' \
-d 'start_modified=2000-01-01+00%3A00%3A00'

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

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

req.fields="pic_url,num,props,valid_thru"
req.q="nike"
req.cid=1232
req.seller_cids="12,123"
req.page_no=2
req.page_size=40
req.order_by="list_time:desc"
req.has_discount=true
req.is_taobao=true
req.is_ex=true
req.banner="for_shelved"
req.start_modified="2000-01-01 00:00:00"
req.end_modified="2000-01-01 00:00:00"
req.is_cspu=true
req.auction_type="a"
try:
	resp= req.getResponse(sessionkey)
	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,"taobao.items.inventory.get.tmall");
add_param(pRequest,"fields","pic_url,num,props,valid_thru");
add_param(pRequest,"q","nike");
add_param(pRequest,"cid","1232");
add_param(pRequest,"seller_cids","12,123");
add_param(pRequest,"page_no","2");
add_param(pRequest,"page_size","40");
add_param(pRequest,"order_by","list_time:desc");
add_param(pRequest,"has_discount","true");
add_param(pRequest,"is_taobao","true");
add_param(pRequest,"is_ex","true");
add_param(pRequest,"banner","for_shelved");
add_param(pRequest,"start_modified","2000-01-01 00:00:00");
add_param(pRequest,"end_modified","2000-01-01 00:00:00");
add_param(pRequest,"is_cspu","true");
add_param(pRequest,"auction_type","a");
pResponse = top_execute(pClient,pRequest,sessionKey);
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('taobao.items.inventory.get.tmall', {
	'fields':'pic_url,num,props,valid_thru',
	'q':'nike',
	'cid':'1232',
	'seller_cids':'12,123',
	'page_no':'2',
	'page_size':'40',
	'order_by':'list_time:desc',
	'has_discount':'true',
	'is_taobao':'true',
	'is_ex':'true',
	'banner':'for_shelved',
	'start_modified':'2000-01-01 00:00:00',
	'end_modified':'2000-01-01 00:00:00',
	'is_cspu':'true',
	'auction_type':'a'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<items_inventory_get_tmall_response>
    <items>
        <item>
            <approve_status>onsale</approve_status>
            <iid>569a64fce2e98bce187bcbbb4a4d262a</iid>
            <num_iid>1489161932</num_iid>
            <title>Google test item</title>
            <nick>tbtest561</nick>
            <type>fixed</type>
            <cid>132443</cid>
            <seller_cids>2234445,3344466,446434</seller_cids>
            <pic_url>http://img03.taobao.net/bao/uploaded/i3/T1HXdXXgPSt0JxZ2.8_070458.jpg</pic_url>
            <num>8888</num>
            <props>135255:344454</props>
            <valid_thru>7</valid_thru>
            <list_time>2009-10-22 14:22:06</list_time>
            <price>5.00</price>
            <has_discount>true</has_discount>
            <has_invoice>true</has_invoice>
            <has_warranty>true</has_warranty>
            <has_showcase>true</has_showcase>
            <modified>2000-01-01 00:00:00</modified>
            <delist_time>2000-01-01 00:00:00</delist_time>
            <postage_id>32</postage_id>
            <outer_id>34143554352</outer_id>
            <is_taobao>true</is_taobao>
            <is_ex>true</is_ex>
            <is_virtual>true</is_virtual>
            <with_hold_quantity>12</with_hold_quantity>
            <is_cspu>true</is_cspu>
            <first_starts_time>2000-01-01 00:00:00</first_starts_time>
        </item>
    </items>
    <total_results>1</total_results>
</items_inventory_get_tmall_response>

{
    "items_inventory_get_tmall_response":{
        "items":{
            "item":[
                {
                    "approve_status":"onsale",
                    "iid":"569a64fce2e98bce187bcbbb4a4d262a",
                    "num_iid":1489161932,
                    "title":"Google test item",
                    "nick":"tbtest561",
                    "type":"fixed",
                    "cid":132443,
                    "seller_cids":"2234445,3344466,446434",
                    "pic_url":"http:\/\/img03.taobao.net\/bao\/uploaded\/i3\/T1HXdXXgPSt0JxZ2.8_070458.jpg",
                    "num":8888,
                    "props":"135255:344454",
                    "valid_thru":7,
                    "list_time":"2009-10-22 14:22:06",
                    "price":"5.00",
                    "has_discount":true,
                    "has_invoice":true,
                    "has_warranty":true,
                    "has_showcase":true,
                    "modified":"2000-01-01 00:00:00",
                    "delist_time":"2000-01-01 00:00:00",
                    "postage_id":32,
                    "outer_id":"34143554352",
                    "is_taobao":true,
                    "is_ex":true,
                    "is_virtual":true,
                    "with_hold_quantity":12,
                    "is_cspu":true,
                    "first_starts_time":"2000-01-01 00:00:00"
                }
            ]
        },
        "total_results":1
    }
}

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"
	}
}

错误码	错误描述	解决方案
code=530>msg=Remote service error>sub_code=isp.item-instant-search-service-unavailable	获取仓库中商品列表异常，检查page_no 是否大于101 ，大于101则报该错误。	细化搜索条件，例如根据修改时间分段获取商品

API测试工具错误码查询工具 SDK下载

开放平台

商品API

taobao.items.inventory.get.tmall (taobao.items.inventory.get.tmall)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ