Skip to content

OMS OpenAPI 仓库管理接口

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

接口概述

仓库管理API用于管理系统中的仓库信息,包括查询仓库列表、获取仓库货位详情以及进行货位整理等功能。通过这些接口可以实现仓库基础信息的查询和货位管理操作。

接口列表

接口名方法功能描述
branch.getListPOST获取仓库列表
branch.getDetailPOST获取仓库详情

系统级参数

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

接口详细说明

branch.getList - 获取仓库列表

功能描述

获取仓库列表,支持按仓库编号、仓库名称、地区等条件进行筛选。

请求参数

参数名类型必填描述
branch_bnstring仓库编号
branch_namestring仓库名称
regionstring地区
page_noint页码,默认1
page_sizeint每页条数,默认50,最大1000

响应参数

参数名类型描述
countint总记录数
listsarray仓库列表

branch.getDetail - 获取仓库详情

功能描述

获取指定仓库的详细信息,包括仓库基本信息、联系人信息等。

请求参数

参数名类型必填描述
branch_bnstring仓库编号

响应参数

参数名类型描述
branch_idint仓库ID
branch_bnstring仓库编号
branch_namestring仓库名称
regionstring地区
addressstring地址
contactsstring联系人
telstring电话
statusstring状态

错误处理

系统级错误码请参考: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-warehouse.md
  • 库存查询API:oms-openapi-stock.md

Guidelines

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