淘宝开放平台 - 文档中心

请求地址：

环境	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 []	必须	num_iid,title	最大列表长度：999	需返回的字段列表。可选值：Item商品结构体中的以下字段：num_iid,title,nick,cid,；字段之间用“,”分隔，不支持其他字段。
q	String	可选	N97		搜索字段。用于搜索商品的title。
cid	Number	可选	1512		商品类目ID
order_by	String	可选	list_time:desc	默认值：list_time:desc	排序方式。格式为column:asc/desc ，column可选值:list_time(上架时间),delist_time(下架时间),num(商品数量)，modified(最近修改时间)，sold_quantity（商品销量）,;默认上架时间降序(即最新上架排在前面)。如按照上架时间降序排序方式为list_time:desc
page_no	Number	可选	10	默认值：1	页码。取值范围:大于零的整数。默认值为1,即默认返回第一页数据。用此接口获取数据时，当翻页获取的条数（page_no*page_size）超过10万,为了保护后台搜索引擎，接口将报错。所以请大家尽可能的细化自己的搜索条件，例如根据修改时间分段获取商品
page_size	Number	可选	100	默认值：40	每页条数。取值范围:大于零的整数;最大值：200；默认值：40。用此接口获取数据时，当翻页获取的条数（page_no*page_size）超过2万,为了保护后台搜索引擎，接口将报错。所以请大家尽可能的细化自己的搜索条件，例如根据修改时间分段获取商品
start_modified	Date	可选	2000-01-01 00:00:00		起始的修改时间
end_modified	Date	可选	2000-01-01 00:00:00		结束的修改时间

名称	类型	示例值	描述
total_results	Number	150	搜索到符合条件的结果总数
items	Item []		搜索到的商品列表，具体字段根据设定的fields决定
└ cid Number 132443 商品所属的叶子类目id └ nick String tbtest561 卖家昵称 └ title String N97 商品标题 └ num_iid Number 1489161932 商品数字id └ iid String 569a64fce2e98bce187bcbbb4a4d262a 商品id(即将废弃，请使用num_iid) └ outer_id String 34143554352 商家外部编码(可与商家外部系统对接)。需要授权才能获取。 └ props String 135255:344454 商品属性格式：pid:vid;pid:vid └ price String 5.00 商品价格，格式：5.00；单位：元；精确到：分 └ num Number 8888 商品数量 └ approve_status String onsale 商品上传后的状态。onsale出售中，instock库中

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaTjbItemsInventoryGetRequest req = new AlibabaTjbItemsInventoryGetRequest();
req.setFields("num_iid,title");
req.setQ("N97");
req.setCid(1512L);
req.setOrderBy("list_time:desc");
req.setPageNo(10L);
req.setPageSize(100L);
req.setStartModified(StringUtils.parseDateTime("2000-01-01 00:00:00"));
req.setEndModified(StringUtils.parseDateTime("2000-01-01 00:00:00"));
AlibabaTjbItemsInventoryGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaTjbItemsInventoryGetRequest req = new AlibabaTjbItemsInventoryGetRequest();
req.Fields = "num_iid,title";
req.Q = "N97";
req.Cid = 1512L;
req.OrderBy = "list_time:desc";
req.PageNo = 10L;
req.PageSize = 100L;
req.StartModified = DateTime.Parse("2000-01-01 00:00:00");
req.EndModified = DateTime.Parse("2000-01-01 00:00:00");
AlibabaTjbItemsInventoryGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaTjbItemsInventoryGetRequest;
$req->setFields("num_iid,title");
$req->setQ("N97");
$req->setCid("1512");
$req->setOrderBy("list_time:desc");
$req->setPageNo("10");
$req->setPageSize("100");
$req->setStartModified("2000-01-01 00:00:00");
$req->setEndModified("2000-01-01 00:00:00");
$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=alibaba.tjb.items.inventory.get' \
-d 'partner_id=apidoc' \
-d 'session=addd327a-d444-44a8-a888-7df6401eabb1' \
-d 'sign=456CF11D21077817EFC6BE7FFF8AFF8C' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-29+06%3A54%3A24' \
-d 'v=2.0' \
-d 'cid=1512' \
-d 'end_modified=2000-01-01+00%3A00%3A00' \
-d 'fields=num_iid%2Ctitle' \
-d 'order_by=list_time%3Adesc' \
-d 'page_no=10' \
-d 'page_size=100' \
-d 'q=N97' \
-d 'start_modified=2000-01-01+00%3A00%3A00'

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

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

req.fields="num_iid,title"
req.q="N97"
req.cid=1512
req.order_by="list_time:desc"
req.page_no=10
req.page_size=100
req.start_modified="2000-01-01 00:00:00"
req.end_modified="2000-01-01 00:00:00"
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,"alibaba.tjb.items.inventory.get");
add_param(pRequest,"fields","num_iid,title");
add_param(pRequest,"q","N97");
add_param(pRequest,"cid","1512");
add_param(pRequest,"order_by","list_time:desc");
add_param(pRequest,"page_no","10");
add_param(pRequest,"page_size","100");
add_param(pRequest,"start_modified","2000-01-01 00:00:00");
add_param(pRequest,"end_modified","2000-01-01 00:00:00");
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('alibaba.tjb.items.inventory.get', {
	'fields':'num_iid,title',
	'q':'N97',
	'cid':'1512',
	'order_by':'list_time:desc',
	'page_no':'10',
	'page_size':'100',
	'start_modified':'2000-01-01 00:00:00',
	'end_modified':'2000-01-01 00:00:00'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_tjb_items_inventory_get_response>
    <total_results>150</total_results>
    <items>
        <item>
            <cid>132443</cid>
            <nick>tbtest561</nick>
            <title>N97</title>
            <num_iid>1489161932</num_iid>
            <iid>569a64fce2e98bce187bcbbb4a4d262a</iid>
            <outer_id>34143554352</outer_id>
            <props>135255:344454</props>
            <price>5.00</price>
            <num>8888</num>
            <approve_status>onsale</approve_status>
        </item>
    </items>
</alibaba_tjb_items_inventory_get_response>

{
    "alibaba_tjb_items_inventory_get_response":{
        "total_results":150,
        "items":{
            "item":[
                {
                    "cid":132443,
                    "nick":"tbtest561",
                    "title":"N97",
                    "num_iid":1489161932,
                    "iid":"569a64fce2e98bce187bcbbb4a4d262a",
                    "outer_id":"34143554352",
                    "props":"135255:344454",
                    "price":"5.00",
                    "num":8888,
                    "approve_status":"onsale"
                }
            ]
        }
    }
}

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.tjb.items.inventory.get (查询卖家仓库中的商品)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ