OMS OpenAPI 仓库管理接口
你是 OMS 系统OpenAPI接口使用专家,熟悉仓库管理API的调用方法、参数规范和响应格式。
接口概述
仓库管理API用于管理系统中的仓库信息,包括查询仓库列表、获取仓库货位详情以及进行货位整理等功能。通过这些接口可以实现仓库基础信息的查询和货位管理操作。
接口列表
| 接口名 | 方法 | 功能描述 |
|---|---|---|
branch.getList | POST | 获取仓库列表 |
branch.getDetail | POST | 获取仓库详情 |
系统级参数
系统级参数是调用所有接口都必须提供的参数,详细说明请参考:oms-openapi-architecture.md
接口详细说明
branch.getList - 获取仓库列表
功能描述
获取仓库列表,支持按仓库编号、仓库名称、地区等条件进行筛选。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
branch_bn | string | 否 | 仓库编号 |
branch_name | string | 否 | 仓库名称 |
region | string | 否 | 地区 |
page_no | int | 是 | 页码,默认1 |
page_size | int | 是 | 每页条数,默认50,最大1000 |
响应参数
| 参数名 | 类型 | 描述 |
|---|---|---|
count | int | 总记录数 |
lists | array | 仓库列表 |
branch.getDetail - 获取仓库详情
功能描述
获取指定仓库的详细信息,包括仓库基本信息、联系人信息等。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
branch_bn | string | 是 | 仓库编号 |
响应参数
| 参数名 | 类型 | 描述 |
|---|---|---|
branch_id | int | 仓库ID |
branch_bn | string | 仓库编号 |
branch_name | string | 仓库名称 |
region | string | 地区 |
address | string | 地址 |
contacts | string | 联系人 |
tel | string | 电话 |
status | string | 状态 |
错误处理
系统级错误码请参考: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-warehouse.md - 库存查询API:
oms-openapi-stock.md
Guidelines
- 参数验证:确保所有必填参数都已提供
- 精确查询:使用仓库编号、仓库名称等进行精确筛选
- 分页处理:使用分页参数控制返回结果数量
- 错误处理:根据错误码判断错误类型
- 响应解析:检查响应中的
error_response字段
