文档中心 > API类目 > 淘宝物流API

qimen.taobao.logistics.wms.inventory.batchquery (仓实时批次库存查询)

发起对仓WMS实时库存批量分页查询

公共参数

请求地址：

环境	HTTP请求地址
正式环境	http://qimen.api.taobao.com/router/qm
测试环境	http://qimen.api.taobao.com/router/qmtest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
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。
customerId	String	是	WMS颁发给用户的ID
sign_method	String	是	签名的摘要算法，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
request	Request	可选			请求
└ ownerCode String 必须 AX766232 货主编码 └ warehouseCodes String [] 必须 STA 仓编码清单 └ itemCodes String [] 必须 750097723 货品清单,不超过20个 └ pageNum Number 必须 1 当前页 └ pageSize Number 必须 200 每页数量 └ extendProps Map 可选 - 扩展属性

响应参数

名称	类型	示例值	描述
response	Response		返回
└ success Boolean true 是否成功，true-成功; false-失败 └ biz_error_code String E0001 错误编码 └ biz_error_msg String invalid app key 错误描述 └ retry Boolean false 是否可重试 true-可重试 └ pageSize Number 20 每页数量 └ pageNum Number 1 当前页 └ totalCount Number 36 总数量 items ItemDetail [] 库存行明细列表 └ ownerCode String AX88772 货主编码 └ itemCode String 788722331 商品编码 └ warehouseCode String STA 仓库编码 └ batchCode String B7766 入库批次编码 └ inventoryType String ZP 库存类型 └ produceDate String 2023-09-09 生产日期（YYYY-MM-DD） └ expiryDate String 2026-09-08 失效日期（YYYY-MM-DD） └ shelfLifeDay Number 720 保质期天数（天） └ quantity Number 25 批次库存总数量 └ lockQuantity Number 0 批次库存占用数量。当实物无占用时填写0 └ inboundDate String 2023-09-20 入库日期（YYYY-MM-DD） └ produceCode String D9886 生产批次号 └ warningDay Number 500 预警天数,即距离失效日期多少天，便开始预警 └ bannedDay Number 550 禁收天数，即距离失效日期多少天，仓库便不再收货 └ lockupDay Number 600 禁售天数，即距离失效日期多少天，仓库便不再售卖这批货 └ validityStatus String 正常效期状态（正常、已预警、已禁售） └ inventoryAge Number 82 实物批次库龄(天) └ extendProps String - 扩展属性, Map对应的JsonString

请求示例

{"request":{"itemCodes":["750097723"],"ownerCode":"AX766232","warehouseCodes":["STA"],"pageSize":200,"extendProps":"-","pageNum":1}}

响应示例

{
    "response":{
        "success":true,
        "biz_error_code":"E0001",
        "biz_error_msg":"invalid app key",
        "retry":false,
        "pageSize":20,
        "pageNum":1,
        "totalCount":36,
        "items":[
            {
                    "ownerCode":"AX88772",
                    "itemCode":"788722331",
                    "warehouseCode":"STA",
                    "batchCode":"B7766",
                    "inventoryType":"ZP",
                    "produceDate":"2023-09-09",
                    "expiryDate":"2026-09-08",
                    "shelfLifeDay":720,
                    "quantity":25,
                    "lockQuantity":0,
                    "inboundDate":"2023-09-20",
                    "produceCode":"D9886",
                    "warningDay":500,
                    "bannedDay":550,
                    "lockupDay":600,
                    "validityStatus":"正常",
                    "inventoryAge":82,
                    "extendProps":"-"
            }
        ]
    }
}

验签示例

{"response":{"biz_error_msg":"Illegal request","success":"不等于true","biz_error_code":"sign-check-failure"}}

错误码解释

错误码	错误描述	解决方案

API工具

错误码查询工具 SDK下载

FAQ

有用( 0 ) 我要提问

返回
顶部