OMS OpenAPI 库存管理接口

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

接口概述

盘点管理API用于管理系统中的盘点相关操作，包括查询盘点单列表、盘点申请单详情与列表、店铺商品列表以及店铺商品库存回写等功能。

接口列表

接口名	方法	功能描述
inventory.getList	POST	获取库存列表
inventory.getDetail	POST	获取库存详情

系统级参数

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

接口详细说明

inventory.getList - 获取库存列表

功能描述

获取库存列表，支持按仓库编号、商品编码、商品名称、分类、品牌、供应商编码、店铺编码、库存数量范围等条件进行筛选。

请求参数

参数名	类型	必填	描述
branch_bn	string	否	仓库编号
bn	string	否	商品编码
name	string	否	商品名称
category	string	否	商品分类
brand	string	否	商品品牌
supplier_code	string	否	供应商编码
shop_code	string	否	店铺编码
min_num	int	否	最小库存数量
max_num	int	否	最大库存数量
page_no	int	是	页码，默认1
page_size	int	是	每页条数，默认50，最大1000

响应参数

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

lists 数组中的每个对象包含以下字段：

参数名	类型	描述
branch_bn	string	仓库编号
branch_name	string	仓库名称
bn	string	商品编码
name	string	商品名称
barcode	string	商品条码
category	string	商品分类
brand	string	商品品牌
supplier_code	string	供应商编码
supplier_name	string	供应商名称
store	int	库存数量
freez	int	冻结数量
available	int	可用数量

inventory.getDetail - 获取库存详情

功能描述

获取指定仓库和商品的库存详情，包括库存数量、成本价、市场价、零售价、规格信息、货位信息等。

请求参数

参数名	类型	必填	描述
branch_bn	string	是	仓库编号
bn	string	是	商品编码

响应参数

参数名	类型	描述
branch_bn	string	仓库编号
branch_name	string	仓库名称
bn	string	商品编码
name	string	商品名称
barcode	string	商品条码
store	int	库存数量
freez	int	冻结数量
available	int	可用数量
cost_price	string	成本价
market_price	string	市场价
retail_price	string	零售价
spec_info	string	规格信息
position	array	货位信息

错误处理

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

注意事项

1. 时间格式必须为 yyyy-MM-dd HH:mm:ss，否则可能导致查询失败
2. page_size 参数最大支持 1000，默认50，超过100将被限制为 100
3. 对于大数据量的查询，建议使用仓库编号、商品编码等进行精确筛选，以提高查询效率
4. 时间戳必须与服务器时间保持同步，误差不超过3600秒
5. 每个请求必须生成唯一的签名，避免重复提交
6. 请妥善保管接口密钥，避免泄露

参考文档

• OpenAPI架构和使用：oms-openapi-architecture.md
• 库存查询API：oms-openapi-stock.md
• 出入库明细API：oms-openapi-iostock.md

Guidelines

1. 参数验证：在调用接口前，确保所有必填参数都已提供
2. 精确查询：建议使用仓库编号、商品编码等进行精确筛选
3. 分页处理：对于大数据量查询，使用分页参数控制返回结果数量
4. 错误处理：根据错误码判断错误类型
5. 响应解析：检查响应中的error_response字段，判断请求是否成功