第1章：概述
1.1 系统背景
本文档是WMS（Warehouse Management System）仓库管理系统的对外开放API接口规范文档，旨在为第三方系统（如ERP、电商平台、OMS订单系统等）提供标准化的数据集成方案。通过本套API，外部系统可实现与WMS系统的业务数据实时同步和流程协同。
1.2 系统目标
- 提供统一的仓储业务 API 接口标准，便于客户系统快速对接。
- 支持多渠道、多客户、多仓库的业务模型。
- 实现商品、库存、入库、出库、退货等核心业务的在线化、数据化管理。
- 提供高性能、可扩展、安全的 API 接口服务。
1.3 核心功能模块
| 模块 | 功能说明 |
|---|
| 商品管理 | 提供商品创建、更新、查询接口，用于同步客户商品主数据。 |
| 入库管理 | 支持入库预报创建、删除，管理客户入库计划。 |
| 出库管理 | 提供出库订单创建、查询、取消、更新、Hold 操作等功能。 |
| 库存管理 | 支持拉取 SKU 库存、序列号库存、退货库存等实时数据。 |
| 退货管理 | 提供退货预报创建、更新及查询接口。 |
1.4 面向用户群体
| 用户类型 | 说明 |
|---|
| 第三方平台/系统集成商 | 与 WMS 系统进行数据同步、自动化仓储作业的系统对接方。 |
| 企业内部开发者 | 负责企业 ERP / OMS 与 WMS 对接的技术团队。 |
| 合作仓储服务商 | 使用 WMS 接口同步订单、库存、出入库状态，实现多方协同。 |
1.5 核心能力概览
- 标准化 RESTful API 设计，支持 JSON 格式请求与响应；
- 统一的认证与签名机制，保障数据传输安全；
- 细粒度的错误码设计，便于问题定位与排查；
- 支持批量操作与异步处理；
- 提供沙箱测试环境，便于快速集成与调试。
1.6 版本信息
| 项目 | 内容 |
|---|
| 文档版本 | v1.0.0 |
| 发布日期 | 2025-11-07 |
| 维护团队 | IWIN技术团队 |
| 联系方式 | |
1.7 接口清单
基础信息接口
| 接口名称 | 接口地址 | 请求方式 | 说明 |
|---|
| 获取仓库信息列表 | /onixport/api/wms/warehouse/info | GET | 获取所有可用仓库信息 |
商品库接口
| 接口名称 | 接口地址 | 请求方式 | 说明 |
|---|
| 创建商品 | /onixport/api/wms/product/create | POST | 创建单个商品 |
| 更新商品 | /onixport/api/wms/product/update | PUT | 按SKU更新商品信息 |
| 拉取商品信息 | /onixport/api/wms/product/info | POST | 批量查询商品，最多200个 |
入库预报接口
| 接口名称 | 接口地址 | 请求方式 | 说明 |
|---|
| 创建入库预报 | /onixport/api/wms/inbound/create | POST | 创建入库预报单 |
| 查询入库预报序列号明细 | /onixport/api/wms/inbound/serialNo/detail | POST | 分页查询序列号预报明细 |
| 查询入库预报SKU明细 | /onixport/api/wms/inbound/sku/detail | POST | 分页查询SKU预报明细 |
| 删除预报单 | /onixport/api/wms/inbound/delete | DELETE | 删除柜号和批次号下的所有预报 |
| 删除序列号预报 | /onixport/api/wms/inbound/deleteSerialNo | DELETE | 删除柜号和批次号下的序列号预报 |
出库订单接口
| 接口名称 | 接口地址 | 请求方式 | 说明 |
|---|
| 出库订单创建 | /onixport/api/wms/outbound/create | POST | 批量创建出库订单，最多100个 |
| 出库订单更新 | /onixport/api/wms/outbound/update/{orderNo} | PUT | 更新出库订单信息 |
| 拉取出库订单信息 | /onixport/api/wms/outbound/info | POST | 批量查询出库订单，最多200个 |
| 出库订单取消 | /onixport/api/wms/outbound/cancel | PUT | 取消出库订单 |
| 出库订单Hold | /onixport/api/wms/outbound/hold | PUT | 暂停出库订单处理 |
| 出库订单删除 | /onixport/api/wms/outbound/delete | DELETE | 删除出库订单 |
库存接口
| 接口名称 | 接口地址 | 请求方式 | 说明 |
|---|
| 拉取SKU库存 | /onixport/api/wms/inventory/sku/list | POST | 分页查询SKU库存 |
| 拉取序列号库存 | /onixport/api/wms/inventory/sn/list | POST | 分页查询序列号库存 |
| 拉取退货库存 | /onixport/api/wms/inventory/returned/list | POST | 分页查询退货库存 |
退货预报接口
| 接口名称 | 接口地址 | 请求方式 | 说明 |
|---|
| 创建退货预报 | /onixport/api/wms/returned/create | POST | 创建退货预报单 |
| 更新退货预报 | /onixport/api/wms/returned/update/{orderNo} | PUT | 更新退货预报单信息 |
| 拉取退货预报信息 | /onixport/api/wms/returned/info | POST | 批量查询退货预报，最多100个 |