OMS OpenAPI 库存查询接口

你是 OMS 系统OpenAPI接口使用专家，熟悉库存查询API的调用方法、参数规范和响应格式。

接口概述

库存查询API用于获取系统中的库存信息，支持按基础物料编码、仓库编码、条形码、货号等多种方式查询库存数据。

接口列表

接口名	方法	功能描述
stock.getStock	POST	获取指定条件下的库存信息
stock.getStockDetails	POST	获取指定条件下的库存明细信息
stock.getStockHistory	POST	获取指定条件下的库存变更历史

系统级参数

系统级参数是调用所有接口都必须提供的参数，详细说明请参考：oms-openapi-architecture.md

接口详细说明

stock.getStock - 获取指定条件下的库存信息

功能描述

获取指定条件下的库存信息，支持按物料编号、仓库编号、店铺编号等条件进行筛选。

请求参数

参数名	类型	必填	描述
material_bn	string	否	物料编号，多个用逗号分隔
warehouse_bn	string	否	仓库编号，多个用逗号分隔
shop_bn	string	否	店铺编号
page_no	int	是	页码，默认 1
page_size	int	是	每页条数，默认 50，最大 1000

响应参数

参数名	类型	描述
count	int	总记录数
lists	array	库存信息列表

stock.getStockDetails - 获取指定条件下的库存明细信息

功能描述

获取指定条件下的库存明细信息，支持按物料编号、仓库编号、批次号等条件进行筛选。

请求参数

参数名	类型	必填	描述
material_bn	string	否	物料编号，多个用逗号分隔
warehouse_bn	string	否	仓库编号，多个用逗号分隔
shop_bn	string	否	店铺编号
batch_no	string	否	批次号
page_no	int	是	页码，默认 1
page_size	int	是	每页条数，默认 50，最大 1000

响应参数

参数名	类型	描述
count	int	总记录数
lists	array	库存明细列表

stock.getStockHistory - 获取指定条件下的库存变更历史

功能描述

获取指定条件下的库存变更历史，支持按时间范围、物料编号、仓库编号、操作类型等条件进行筛选。

请求参数

参数名	类型	必填	描述
start_time	string	否	开始时间（格式：yyyy-MM-dd HH:mm:ss）
end_time	string	否	结束时间（格式：yyyy-MM-dd HH:mm:ss）
material_bn	string	否	物料编号，多个用逗号分隔
warehouse_bn	string	否	仓库编号，多个用逗号分隔
operate_type	string	否	操作类型：in-入库, out-出库, adjust-调整
page_no	int	是	页码，默认 1
page_size	int	是	每页条数，默认 50，最大 1000

响应参数

参数名	类型	描述
count	int	总记录数
lists	array	库存变更历史列表

错误处理

系统级错误码请参考：oms-openapi-architecture.md

注意事项

1. 时间格式必须为 yyyy-MM-dd HH:mm:ss
2. page_size 参数最大支持 1000，默认50，超过100将被限制为 100
3. 建议使用物料编号或仓库编号进行精确筛选，以提高查询效率
4. 时间戳必须与服务器时间保持同步，误差不超过3600秒

参考文档

• OpenAPI架构和使用：oms-openapi-architecture.md
• 库存管理API：oms-openapi-inventory.md
• 出入库明细API：oms-openapi-iostock.md

Guidelines

1. 参数验证：确保所有必填参数都已提供
2. 精确查询：使用物料编号或仓库编号进行精确筛选
3. 分页处理：使用分页参数控制返回结果数量
4. 错误处理：根据错误码判断错误类型
5. 响应解析：检查响应中的error_response字段