文档中心 > API类目 > 奇门仓储API

taobao.qimen.stock.query (库存查询接口（多条件）)

ERP调用奇门的接口,查询商品的库存量

公共参数

请求地址：

环境	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	StockQueryRequest	可选
└ warehouseCode String 可选 W1234 仓库编码 └ ownerCode String 可选 H1234 货主编码 └ itemCode String 必须 I1234 商品编码 └ itemId String 可选 C1234 仓储系统商品ID └ inventoryType String 可选 ZP 库存类型(ZP=正品;CC=残次;JS=机损;XS=箱损;ZT=在途库存;默认为查所有类型的库存) └ batchCode String 可选 P1234 批次编码 └ productDate String 可选 2017-09-09 商品生产日期(YYYY-MM-DD) └ expireDate String 可选 2017-09-09 商品过期日期(YYYY-MM-DD) └ page Number 必须 1 当前页(从1开始) └ pageSize Number 必须 10 每页条数(最多100条) └ extendProps Map 可选扩展属性 └ remark String 可选备注备注

响应参数

名称	类型	示例值	描述
response	StockQueryResponse
└ flag String success 响应结果:success\|failure └ code String 0 响应码 └ message String invalid appkey 响应信息 └ totalCount Number 100 总数 items Item [] 商品的库存信息列表 └ warehouseCode String C1234 仓库编码 └ itemCode String I1234 商品编码 └ itemId String W1234 仓储系统商品ID └ inventoryType String ZP 库存类型(ZP=正品;CC=残次;JS=机损;XS= 箱损;ZT=在途库存) └ quantity Number 11 未冻结库存数量 └ lockQuantity Number 1 冻结库存数量 └ batchCode String P1234 批次编码 └ productDate String 2017-09-09 商品生产日期(YYYY-MM-DD) └ expireDate String 2017-09-09 商品过期日期(YYYY-MM-DD) └ produceCode String P1234 生产批号 └ itemName String 天猫精灵商品名称 └ barCode String 69xxxxxxxxx 产品的国际标准条码（69码）

请求示例

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

QimenClient client = new DefaultQimenClient(url, appkey, secret);
StockQueryRequest req = new StockQueryRequest();
req.setCustomerId("stub-cust-code");
req.setVersion("2.0");
req.setWarehouseCode("W1234");
req.setOwnerCode("H1234");
req.setItemCode("I1234");
req.setItemId("C1234");
req.setInventoryType("ZP");
req.setBatchCode("P1234");
req.setProductDate("2017-09-09");
req.setExpireDate("2017-09-09");
req.setPage(1L);
req.setPageSize(10L);
req.setRemark("备注");
StockQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

XML示例
JSON示例

<response>
    <flag>success</flag>
    <code>0</code>
    <message>invalid appkey</message>
    <totalCount>100</totalCount>
    <items>
        <item>
            <warehouseCode>C1234</warehouseCode>
            <itemCode>I1234</itemCode>
            <itemId>W1234</itemId>
            <inventoryType>ZP</inventoryType>
            <quantity>11</quantity>
            <lockQuantity>1</lockQuantity>
            <batchCode>P1234</batchCode>
            <productDate>2017-09-09</productDate>
            <expireDate>2017-09-09</expireDate>
            <produceCode>P1234</produceCode>
            <itemName>天猫精灵</itemName>
            <barCode>69xxxxxxxxx</barCode>
        </item>
    </items>
</response>

异常示例

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>

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

淘宝开放平台

奇门仓储API

taobao.qimen.stock.query (库存查询接口（多条件）)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ