第7章:变更日志

本文档记录 WMS API 的版本变更历史,包括新增接口、接口变更、废弃接口等信息。


7.1 版本说明

  • 版本号格式主版本号.次版本号.修订号(如 v1.0.0)
  • 主版本号:不兼容的 API 修改
  • 次版本号:向下兼容的功能性新增
  • 修订号:向下兼容的问题修正

7.2 v1.0.0(2025-11-13)

🎉 初始版本发布

新增接口

基础信息

  • ✅ 获取仓库信息列表:GET /onixport/api/wms/warehouse/info

商品库

  • ✅ 创建商品:POST /onixport/api/wms/product/create
  • ✅ 更新商品:PUT /onixport/api/wms/product/update
  • ✅ 拉取商品信息:POST /onixport/api/wms/product/info

入库预报

  • ✅ 创建入库预报:POST /onixport/api/wms/inbound/create

出库订单

  • ✅ 出库订单创建:POST /onixport/api/wms/outbound/create
  • ✅ 出库订单更新:PUT /onixport/api/wms/outbound/update/{orderNo}
  • ✅ 拉取出库订单信息:POST /onixport/api/wms/outbound/info
  • ✅ 出库订单取消:PUT /onixport/api/wms/outbound/cancel
  • ✅ 出库订单Hold:PUT /onixport/api/wms/outbound/hold
  • ✅ 出库订单删除:DELETE /onixport/api/wms/outbound/delete

库存

  • ✅ 拉取SKU库存:POST /onixport/api/wms/inventory/sku/list
  • ✅ 拉取序列号库存:POST /onixport/api/wms/inventory/sn/list
  • ✅ 拉取退货库存:POST /onixport/api/wms/inventory/returned/list

核心功能

  • ✅ 统一的认证机制(Token 认证)
  • ✅ 统一的返回格式
  • ✅ 支持批量操作(最多200条)
  • ✅ 支持分页查询
  • ✅ 测试环境(Sandbox)和生产环境(Production)

注意事项

  • 所有接口变更将提前至少 30 天 通知
  • 废弃接口将保留至少 90 天 的兼容期
  • 重大变更将提供迁移指南

7.3 变更通知

当 API 发生变更时,我们将通过以下方式通知:

1. 邮件通知:发送至注册邮箱

2. 文档更新:更新本文档和 API 文档

3. 公告通知:在系统公告中发布


7.4 兼容性说明

7.4.1 向后兼容原则

  • 参数新增:新增可选参数不影响现有调用
  • 响应字段新增:新增响应字段不影响现有解析
  • 参数删除:删除参数将视为不兼容变更
  • 必填参数变更:可选参数改为必填将视为不兼容变更
  • 响应结构变更:修改现有响应结构将视为不兼容变更

7.4.2 废弃接口处理

当接口被标记为废弃时:

1. 废弃通知期:至少提前 30 天通知

2. 兼容保留期:废弃后至少保留 90 天

3. 迁移指南:提供详细的迁移方案和替代接口


反馈与建议

如有任何问题或建议,请联系技术支持团队。