淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
request	Request	可选			request
└ ownerCode String 必须货主编码，string(50)，必填货主编码，string(50)，必填 └ warehouseCode String 必须仓库编码，string(50)，必填仓库编码，string(50)，必填 └ itemCode String 可选 ERP 系统商品编码, string(50)，条件必填 ERP 系统商品编码, string(50)，条件必填 └ itemId String 可选仓储系统商品编码, string(50)，条件必填仓储系统商品编码, string(50)，条件必填 └ page Number 必须当前页，从 1 开始，必填当前页，从 1 开始，必填 └ pageSize Number 必须每页条数(最多 100 条)，必填每页条数(最多 100 条)，必填

名称	类型	示例值	描述
response	Response		响应
└ flag String success\|failure success\|failure └ code String 响应码响应码 └ message String 响应信息响应信息 └ totalCount Number 总行数，必填总行数，必填 items Items 明细列表 item Item 明细 └ itemCode String ERP系统商品编码,string（50），条件必填 ERP系统商品编码,string（50），条件必填 └ itemId String 仓储系统商品编码仓储系统商品编码 └ inventoryType Number 库存类型库存类型 └ batchCode String 批次号批次号 └ productDate String 生产日期生产日期 └ expireDate String 失效日期失效日期 └ quantity Number 库存数量库存数量

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

QimenClient client = new DefaultQimenClient(url, appkey, secret);
InventorybatchQueryRequest req = new InventorybatchQueryRequest();
req.setCustomerId("stub-cust-code");
req.setVersion("2.0");
req.setOwnerCode("货主编码，string(50)，必填");
req.setWarehouseCode("仓库编码，string(50)，必填");
req.setItemCode("ERP 系统商品编码, string(50)，条件必填");
req.setItemId("仓储系统商品编码, string(50)，条件必填");
req.setPage(当前页，从 1 开始，必填L);
req.setPageSize(每页条数(最多 100 条)，必填L);
InventorybatchQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

IQimenClient client = new DefaultQimenClient(url, appkey, secret);
InventorybatchQueryRequest req = new InventorybatchQueryRequest();
req.CustomerId = "stub-cust-code";
req.Version = "2.0";
req.OwnerCode = "货主编码，string(50)，必填";
req.WarehouseCode = "仓库编码，string(50)，必填";
req.ItemCode = "ERP 系统商品编码, string(50)，条件必填";
req.ItemId = "仓储系统商品编码, string(50)，条件必填";
req.Page = 当前页，从 1 开始，必填L;
req.PageSize = 每页条数(最多 100 条)，必填L;
InventorybatchQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new QimenInventorybatchQueryRequest;
$request = new Request;
$request->owner_code="货主编码，string(50)，必填";
$request->warehouse_code="仓库编码，string(50)，必填";
$request->item_code="ERP 系统商品编码, string(50)，条件必填";
$request->item_id="仓储系统商品编码, string(50)，条件必填";
$request->page="当前页，从 1 开始，必填";
$request->page_size="每页条数(最多 100 条)，必填";
$req->setRequest(json_encode($request));
$resp = $c->execute($req);

curl -X POST 'http://qimenapi.tbsandbox.com/router/qimen/service?app_key=testerp_appkey&customerId=stub-cust-code&format=xml&method=taobao.qimen.inventorybatch.query&sign=E8EC7C8CA33848C2EE381A4984922F21&sign_method=md5&timestamp=2025-04-28+18%3A23%3A36&v=2.0&version=1' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
--data \
'<request>
  <itemId>仓储系统商品编码, string(50)，条件必填</itemId>
  <ownerCode>货主编码，string(50)，必填</ownerCode>
  <itemCode>ERP 系统商品编码, string(50)，条件必填</itemCode>
  <pageSize>每页条数(最多 100 条)，必填</pageSize>
  <page>当前页，从 1 开始，必填</page>
  <warehouseCode>仓库编码，string(50)，必填</warehouseCode>
</request>'

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

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

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

XML示例
JSON示例

<response>
    <flag>success|failure</flag>
    <code>响应码</code>
    <message>响应信息</message>
    <totalCount>总行数，必填</totalCount>
    <items>
        <item>
            <itemCode>ERP系统商品编码,string（50），条件必填</itemCode>
            <itemId>仓储系统商品编码</itemId>
            <inventoryType>库存类型</inventoryType>
            <batchCode>批次号</batchCode>
            <productDate>生产日期</productDate>
            <expireDate>失效日期</expireDate>
            <quantity>库存数量</quantity>
        </item>
    </items>
</response>

{
    "response":{
        "flag":"success|failure",
        "code":"响应码",
        "message":"响应信息",
        "totalCount":总行数，必填,
        "items":{
            "item":{
                "itemCode":"ERP系统商品编码,string（50），条件必填",
                "itemId":"仓储系统商品编码",
                "inventoryType":库存类型,
                "batchCode":"批次号",
                "productDate":"生产日期",
                "expireDate":"失效日期",
                "quantity":库存数量
            }
        }
    }
}

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

taobao.qimen.inventorybatch.query (商品单仓批次库存查询接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ