OMS OpenAPI 出入库明细管理接口
你是 OMS 系统OpenAPI接口使用专家,熟悉出入库明细管理API的调用方法、参数规范和响应格式。
接口概述
出入库明细管理API用于查询系统中的出入库明细数据,支持按仓库编号和时间范围进行过滤,并支持分页查询。通过该接口可以获取指定时间段内的出入库详细信息,包括物料编码、数量、价格、仓库等信息。
接口列表
| 接口名 | 方法 | 功能描述 |
|---|---|---|
iostock.getIOStockDetailList | POST | 出入库明细列表查询 |
iostock.getIOStockByOrderId | POST | 通过单据号查询出入库记录 |
系统级参数
系统级参数是调用所有接口都必须提供的参数,详细说明请参考:oms-openapi-architecture.md
接口详细说明
iostock.getIOStockDetailList - 出入库明细列表查询
功能描述
出入库明细列表查询,支持按仓库编码、操作类型、物料编码、时间范围、单据类型等条件进行筛选。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
page_no | number | 是 | 页码,默认1 |
page_size | number | 是 | 每页数量,默认50 |
warehouse_bn | string | 否 | 仓库编码 |
operate_type | string | 否 | 操作类型(in:入库/out:出库) |
material_bn | string | 否 | 物料编码 |
start_time | string | 否 | 开始时间,格式:yyyy-MM-dd HH:mm:ss |
end_time | string | 否 | 结束时间,格式:yyyy-MM-dd HH:mm:ss |
order_type | string | 否 | 单据类型 |
响应参数
| 参数名 | 类型 | 描述 |
|---|---|---|
count | number | 总记录数 |
iostock_price_num | decimal | 出入库价格合计 |
unit_cost_num | decimal | 单位成本合计 |
lists | array | 出入库明细列表 |
iostock.getIOStockByOrderId - 通过单据号查询出入库记录
功能描述
通过单据号查询出入库记录,获取指定单据的出入库明细信息。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
order_bn | string | 是 | 单据编号 |
响应参数
| 参数名 | 类型 | 描述 |
|---|---|---|
order_bn | string | 单据编号 |
order_type | string | 单据类型 |
warehouse_bn | string | 仓库编码 |
warehouse_name | string | 仓库名称 |
total_qty | decimal | 总数量 |
detail | array | 明细列表 |
错误处理
系统级错误码请参考:oms-openapi-architecture.md
注意事项
- 时间格式必须为
yyyy-MM-dd HH:mm:ss page_size参数最大支持 1000,默认50,超过100将被限制为 100- 建议使用时间范围或物料编码进行精确筛选,以提高查询效率
- 时间戳必须与服务器时间保持同步,误差不超过3600秒
参考文档
- OpenAPI架构和使用:
oms-openapi-architecture.md - 出入库单API:
oms-openapi-transfer.md - 库存查询API:
oms-openapi-stock.md
Guidelines
- 参数验证:确保所有必填参数都已提供
- 时间范围:使用合理的时间范围进行查询
- 分页处理:使用分页参数控制返回结果数量
- 错误处理:根据错误码判断错误类型
- 响应解析:检查响应中的
error_response字段
