WMS_MAIN/methods/changes/system.json
liufumingren e73a311076 ok
2026-04-11 17:09:06 +08:00

445 lines
23 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

[
{
"version": "2026.04.07-system-01",
"date": "2026-04-07",
"summary": "修正 warehouse.getAreaRacks 的鉴权/权限链路文档,明确该接口需要 登录并走权限校验。",
"methods": [
"warehouse.getAreaRacks"
],
"notes": [
"对齐当前 system 文档中的 isNeedAuth=true、isNeedLogin=true。",
"用于补充该接口权限链路修正文档的历史上下文,不改变 methods/system.json 的 SSOT 角色。"
]
},
{
"version": "2026.04.07-system-02",
"date": "2026-04-07",
"summary": "补充签约配置相关接口文档,覆盖策略字段元信息查询与面单数量人工调整。",
"methods": [
"storeWarehouse.store.getPolicyConfigFields",
"storeWarehouse.store.adjustPrintQuantity"
],
"notes": [
"getPolicyConfigFields 说明为获取签约策略可配置字段元信息列表。",
"adjustPrintQuantity 说明为人工调整签约关系下的面单余额并记录变更日志,并 明确 id、change_quantity、reason 等关键入参。"
]
},
{
"version": "2026.04.07-system-03",
"date": "2026-04-07",
"summary": "对外命名从 qimenConfig 收口为 apiConfig,并在接口配置文档中强调 interface_type_id 校验。",
"methods": [
"storeWarehouse.store.listApiConfig",
"storeWarehouse.store.saveApiConfig",
"storeWarehouse.store.deleteQimenConfig"
],
"notes": [
"文档对外统一使用 apiConfig / api_config 命名,减少 qimenConfig 历史别名歧义。",
"saveApiConfig 要求 interface_type_id 为必填且必须指向已存在的 wms_interface_type 记录。",
"listApiConfig / deleteQimenConfig 同步补充 interface_type_id 字段说明。"
]
},
{
"version": "2026.04.07-system-04",
"date": "2026-04-07",
"summary": "补充 /api/docs 文档体验增强说明,新增查看变更记录与查看原文 JSON 的入口说明。",
"methods": [
"/api/docs",
"/api/docs/:docName",
"/api/docs/:docName/raw",
"/api/docs/:docName/changes"
],
"notes": [
"sidecar 变更数组用于承载文档历史说明,不替代 methods/system.json 作为 SSOT。",
"原文 JSON 入口继续用于直接查看当前生效文档。"
]
},
{
"version": "2026.04.07-system-05",
"date": "2026-04-07",
"summary": "修正 storeWarehouse.store.adjustPrintQuantity 的面单余额调整语义:由增减/累加改为覆盖设置目标余额。",
"methods": [
"storeWarehouse.store.adjustPrintQuantity"
],
"notes": [
"adjustPrintQuantity 当前兼容 print_quantity、target_quantity、change_quantity、adjust_quantity 作为目标面单余额输入,不再按增减量解释。",
"变更日志中的 change_quantity 由 before/after 自动计算差值,以兼容历史审计与展示。"
]
},
{
"version": "2026.04.07-system-06",
"date": "2026-04-07",
"summary": "按接口类型分类限制必填字段,OPEN_API 创建时自动生成 self_app_key/self_app_secret",
"methods": [
"storeWarehouse.store.saveApiConfig"
],
"notes": [
"QM_WMS 类型须填写 qimen_app_key/qimen_customer_id/qimen_warehouse_code;OPEN_API 类型三个奇门字段非必填,创建时自动生成 self_app_key(WMS+32位HEX)和 self_app_secret(64位HEX),更新时保留已有密钥。"
],
"type": "changed"
},
{
"version": "2026.04.07-system-07",
"date": "2026-04-07",
"summary": "新增接口类型列表查询接口,归属基础模块,无需权限",
"methods": [
"index.listInterfaceTypes"
],
"notes": [
"返回所有已启用的接口类型(wms_interface_type),包含 id、interface_code、interface_name、interface_category、description 字段。设置 isNeedAuth: false, isNeedLogin: true。"
],
"type": "added"
},
{
"version": "2026.04.07-system-08",
"date": "2026-04-07",
"summary": "app_name 改为必传参数",
"methods": [
"storeWarehouse.store.saveApiConfig"
],
"notes": [
"app_name 不再有默认值自动生成逻辑,调用方必须传入非空的 app_name,否则返 回 400 错误。"
],
"type": "changed"
},
{
"version": "2026.04.07-system-09",
"date": "2026-04-07",
"summary": "新增收货单快捷入库上架接口",
"methods": [
"storage.inventory.quickPutaway"
],
"notes": [
"新建 storage.inventory 库存操作模块。quickPutaway 从收货单直接生成入库单 (SCRK)并写入 wms_storage 库存表,同时更新 wms_stock_warehouse 库存数量(悲观行锁),回填收货明细入库状态。要求收货单已完成且所有明细已匹配系统商品。"
],
"type": "added"
},
{
"version": "2026.04.08-system-01",
"date": "2026-04-08",
"summary": "新增收货单与入库单匹配入库接口",
"methods": [
"storage.inventory.matchPutaway"
],
"notes": [
"接收多个收货单和入库单,按商品(stock_warehouse_id)进行数量匹配入库,完 成后根据入库单来源(QM/API)自动触发回传。入参为 receiving_ids(数组)和 entry_order_ids(数组),返回匹配汇总、各收货单入库状态、各入库单状态及回传结果。isNeedAuth=true, isNeedLogin=true, isNeedRight=false。"
],
"type": "added"
},
{
"version": "2026.04.08-system-02",
"date": "2026-04-08",
"summary": "saveApiConfig 新增 callback_url 可选参数",
"methods": [
"storeWarehouse.store.saveApiConfig"
],
"notes": [
"新增 callback_url 参数(VARCHAR(500),可选),用于 OPEN_API 类型入库单的 回调地址配置。"
],
"type": "changed"
},
{
"version": "2026.04.08-system-03",
"date": "2026-04-08",
"summary": "serializeQimenConfig 新增返回 callback_url 字段,影响 list 和 listApiConfig 两个接口",
"methods": [
"storeWarehouse.store.list",
"storeWarehouse.store.listApiConfig"
],
"notes": [
"serializeQimenConfig() 序列化方法新增 callback_url(string)字段。storeWarehouse.store.list 返回的每条记录 api_config 对象中包含 callback_url;storeWarehouse.store.listApiConfig 返回的 list 数组中每条配置包含 callback_url。"
],
"type": "changed"
},
{
"version": "2026.04.08-system-04",
"date": "2026-04-08",
"summary": "新增库存移库(库位转移)接口",
"methods": [
"storage.inventory.transferLocation"
],
"notes": [
"新增 storage.inventory.transferLocation 接口,支持批量多商品多库位移库, 包含部分数量移库与全量移库。入参为 warehouse_id(仓库ID)和 transfers 数组(storage_id、target_space_id、quantity),触发 storage_transfer_completed 通知事件, 每条移库记录独立操作日志。isNeedAuth=true, isNeedLogin=true。"
],
"type": "added"
},
{
"version": "2026.04.08-system-05",
"date": "2026-04-08",
"summary": "简化移库接口入参,从批量 transfers 数组改为单条移库",
"methods": [
"storage.inventory.transferLocation"
],
"notes": [
"移除 warehouse_id 和 transfers 数组入参,改为扁平的 storage_id + target_space_id + quantity 三个顶层参数。warehouse_id 从库存记录自动获取,接口从批量移库简化为单商品单库位移库。响应结构同步简化为单条结果对象。"
],
"type": "modified"
},
{
"version": "2026.04.08-system-06",
"date": "2026-04-08",
"summary": "新增商品库存明细查询接口",
"methods": [
"stock.warehouse.getStockDetail"
],
"notes": [
"新增 stock.warehouse.getStockDetail 接口,按库位/批次维度查询商品库存分布。入参为 stock_id(必填,商品库存ID)和 pagination(可选,含 page/pageSize)。返回 stockItem(商品概要)、storageList(wms_storage 明细数组,含批次号、库位、数 量、锁定数量、生产日期、过期日期等,关联 location_space 库位信息)、pagination 分页信息。isNeedAuth=false, isNeedLogin=true。底层调用 stockStore.getStockDetail,自动校验商品归属当前仓库。"
],
"type": "added"
},
{
"version": "2026.04.08-system-07",
"date": "2026-04-08",
"summary": "新增入参 group_by_batch,支持按批次维度切换库存明细聚合方式",
"methods": [
"stock.warehouse.getStockDetail"
],
"notes": [
"新增可选布尔参数 group_by_batch(默认 false)。false 时按库位合并数量,批次相关字段(batch_no, production_date, expiry_date, inbound_time, inbound_order_no, supplier_batch_no)置 null;true 时保持原逻辑返回每条明细。出参结构不变,但 storageList 中批次字段在合并模式下为 null。"
],
"type": "modified"
},
{
"version": "2026.04.08-system-08",
"date": "2026-04-08",
"summary": "新增按商品维度移库接口",
"methods": [
"storage.inventory.transferByProduct"
],
"notes": [
"新增 storage.inventory.transferByProduct 接口,按库位+商品查找所有库存记 录合并移动。入参为 space_id(原库位ID)、stock_id(商品SKU ID,即 wms_stock_warehouse.id)、target_space_id(目标库位ID)、quantity(移库数量)。开启批次管理(is_batch_mgmt=Y)的商品会被拒绝,需使用 transferLocation 按库存记录精确移库。复用 storage_transfer_completed 通知事件,操作日志编码 STORAGE_TRANSFER_BY_PRODUCT。isNeedAuth=true, isNeedLogin=true。"
],
"type": "added"
},
{
"version": "2026.04.08-system-09",
"date": "2026-04-08",
"summary": "补充 storeWarehouse.store.list 完整 response 输出字段说明,移除 api_config / apiConfig",
"methods": [
"storeWarehouse.store.list"
],
"notes": [
"从返回结果中移除 api_config 和 apiConfig 字段(代码中 delete serialized.api_config / delete serialized.apiConfig),文档 response 补充完整输出字段列表:id, store_id, store_name, warehouse_id, warehouse_name, counterparty_id, counterparty_name, current_subject_role, auth_status, auth_status_label, apply_reason, review_comment, apply_time, review_time, auth_start, auth_end, actual_end, print_quantity, applied_by, reviewed_by, ended_by, remask, use_status, policy_config, is_auth_valid, remaining_days 以及分页和 current_subject 信息。"
],
"type": "updated"
},
{
"version": "2026.04.08-system-10",
"date": "2026-04-08",
"summary": "货主列表返回新增 has_qimen_config 布尔字段",
"methods": [
"storeWarehouse.store.list"
],
"notes": [
"storeWarehouse.store.list 返回的 data.list[] 中新增 has_qimen_config(boolean),表示该货主是否已配置奇门。"
],
"type": "changed"
},
{
"version": "2026.04.08-system-11",
"date": "2026-04-08",
"summary": "补全 stock.warehouse.search 接口文档,新增 params / response / errors 完整说明",
"methods": [
"stock.warehouse.search"
],
"notes": [
"入参补充 keyword(string,模糊匹配 item_code / item_name / goods_code / barcode)和 store_id(number,按货主筛选)。响应补充 data 数组各字段(id, item_code, goods_code, item_name, sku_property, stock_unit, quantity, locked_quantity, brand_name, item_type, barcodes, store_stock)以及 total。errors 补充 code=0 搜 索失败场景。"
],
"type": "updated"
},
{
"version": "2026.04.08-system-12",
"date": "2026-04-08",
"summary": "新增 with_stock / is_batch 参数,支持返回关联库存明细(按库位分 组或按批次逐条)",
"methods": [
"stock.warehouse.search"
],
"notes": [
"入参新增 with_stock(boolean,默认 false,是否返回关联库存数据)和 is_batch(boolean,默认 false,仅 with_stock=true 时生效,按批次明细返回)。响应 data[] 新增 storage[] 字段:is_batch=false 时按库位分组汇总(含 space_id、space、inventory_type、quantity、locked_quantity、available_quantity);is_batch=true 时逐 条返回批次明细(含 id、stock_id、space_id、batch_no、inventory_type、quantity、locked_quantity、available_quantity、production_date、expiry_date、inbound_time、inbound_order_no、supplier_batch_no、created_at、space)。"
],
"type": "updated"
},
{
"version": "2026.04.08-system-13",
"date": "2026-04-08",
"summary": "新增 wms_stock_transaction 表和模型",
"methods": [
"wms_stock_transaction"
],
"notes": [
"新增出入库流水记录表 wms_stock_transaction,含 transaction_type(INBOUND/OUTBOUND)、warehouse_id、store_id、stock_id、storage_id、space_id、quantity、batch_no、inventory_type、order_type、order_no、order_id、receiving_id、entry_order_id、operator_id、operator_name、remark 等字段,关联 StockWarehouse 和 Storage 模型。"
],
"type": "added"
},
{
"version": "2026.04.08-system-14",
"date": "2026-04-08",
"summary": "quickPutaway 和 matchPutaway 入库时自动写入出入库记录",
"methods": [
"storage.inventory.quickPutaway",
"storage.inventory.matchPutaway"
],
"notes": [
"入库操作完成后自动写入 wms_stock_transaction 记录。quickPutaway 写入 order_type='SCRK'(收货入库),matchPutaway 写入 order_type='MATCH'(匹配入库),均 自动填充 warehouse_id、store_id、stock_id、storage_id、space_id、quantity、batch_no、inventory_type 等字段。"
],
"type": "updated"
},
{
"version": "2026.04.08-system-15",
"date": "2026-04-08",
"summary": "新增 storage.inventory.list 出入库记录列表查询接口",
"methods": [
"storage.inventory.list"
],
"notes": [
"出入库记录列表查询,支持 where 条件(transaction_type、stock_id、space_id、store_id、order_type、order_no、inventory_type、operator_name、created_at)、 分页(pagination)、排序(sort)和 group_by_batch 参数。默认合并模式按库位+商品 聚合返回合计数量与记录条数,group_by_batch=true 时返回每条明细含 batch_no、order_no、operator_name 等完整信息。响应均关联 stockItem(item_code、item_name、sku_property、stock_unit)。"
],
"type": "added"
},
{
"version": "2026.04.08-system-16",
"date": "2026-04-08",
"summary": "出入库流水记录查询接口从 storage.inventory.list 改名为 storage.transaction.list",
"methods": [
"storage.transaction.list"
],
"notes": [
"将出入库流水记录查询从 storage.inventory.list 迁移到 storage.transaction.list,避免与库存列表概念混淆。功能和参数不变。isNeedAuth=false, isNeedLogin=true, isNeedRight=false。"
],
"type": "rename",
"module": "storage"
},
{
"version": "2026.04.08-system-17",
"date": "2026-04-08",
"summary": "新增 storage.inventory.list 库存列表查询接口",
"methods": [
"storage.inventory.list"
],
"notes": [
"新增库存列表查询接口,查询 wms_storage 表。支持 where 条件(stock_id/space_id/store_id/inventory_type/batch_no/inbound_order_no/available_quantity/inbound_time/created_at)、分页、排序。支持 group_by_batch 参数:默认 false 按库位+商 品合并(SUM quantity/locked_quantity/available_quantity),true 返回每条明细含 batch_no/production_date/expiry_date 等。关联 stockItem(商品信息)和 space(库位信息)。isNeedAuth=false, isNeedLogin=true, isNeedRight=false。"
],
"type": "add",
"module": "storage"
},
{
"version": "2026.04.08-system-18",
"date": "2026-04-08",
"summary": "移除 storage.entry.create 创建入库单接口",
"methods": [
"storage.entry.create"
],
"notes": [
"不再允许通过 API 创建入库单。入库单仅由快捷入库(quickPutaway)和匹配入库(matchPutaway)等内部流程自动创建。底层 service 实现保留但不再通过 systemMethods 对外暴露。"
],
"type": "remove",
"module": "storage"
},
{
"version": "2026.04.08-system-19",
"date": "2026-04-08",
"summary": "移除 storage.entry.addDetail / deleteDetail / detailChange 对外 接口",
"methods": [
"storage.entry.addDetail",
"storage.entry.deleteDetail",
"storage.entry.detailChange"
],
"notes": [
"入库单明细编辑能力不再通过 systemMethods 对外暴露,入库单模块仅保留 list/get/cancel/completeEntry。"
],
"type": "remove",
"module": "storage"
},
{
"version": "2026.04.08-system-20",
"date": "2026-04-08",
"summary": "新增 storage.stockout 出库单模块(非订单出库单能力)",
"methods": [
"storage.stockout.list",
"storage.stockout.toOrder",
"storage.stockout.listItems"
],
"notes": [
"新增 storage.stockout.list / toOrder / listItems 接口,作为非订单出库单的主出口(对应奇门 stockout.create)。storage.delivery.* 仅作为兼容转发保留;底层 部分能力仍复用 order 模块。"
],
"type": "add",
"module": "storage"
},
{
"version": "2026.04.08-system-21",
"date": "2026-04-08",
"summary": "将 storage.stockout.toOrder 标记为占位接口",
"methods": [
"storage.stockout.toOrder"
],
"notes": [
"storage.stockout.toOrder 当前仅保留方法名用于后续扩展,暂不开放实际逻辑。调用时返回 code=405、message=占位接口,暂未开放。"
],
"type": "change"
},
{
"version": "2026.04.09-system-01",
"date": "2026-04-09",
"summary": "storage.entry.cancel 支持批量作废,新增 ids 入参并兼容单条 id",
"methods": [
"storage.entry.cancel"
],
"notes": [
"新增入参 `ids`(number[])以支持批量作废,兼容旧入参 `id`;当同时传入 `ids` 与 `id` 时以 `ids` 为准。",
"参数校验:`ids` 必须为非空数组;非法 ID 或空数组返回 400。",
"业务约束:已完成/已作废/处于不可作废状态的单据不允许作废;批量场景下任一 单据不存在或状态不允许时整体返回 404/400,未执行部分更新。",
"响应说明:单条作废返回字段 `id`(number);批量作废返回字段 `ids`(number[])。",
"已同步更新 methods/system.json(storage.entry.cancel)为 SSOT。"
]
},
{
"version": "2026.04.09-system-02",
"date": "2026-04-09",
"summary": "新增基础模块车牌识别接口 index.recognizeLicensePlate",
"methods": [
"index.recognizeLicensePlate"
],
"notes": [
"入参:base64(string,必填)或 imageBase64/image_base64(兼容)",
"响应:返回归一化后的识别对象,包含 licensePlate、plateNumber、color、confidence、requestId、imageSize、rawData",
"错误:400(参数或图片格式/尺寸问题),500(第三方 OCR 调用失败或云密钥未 配置)",
"文档中不包含任何敏感配置;实际腾讯云密钥保留在配置文件中,勿在文档中暴露 。"
],
"type": "added"
},
{
"version": "2026.04.09-system-03",
"date": "2026-04-09",
"summary": "收紧基础模块车牌识别接口响应,仅返回 licensePlate 字段",
"methods": [
"index.recognizeLicensePlate"
],
"notes": [
"出参由 {licensePlate, plateNumber, color, confidence, requestId, imageSize, rawData} 调整为 {licensePlate}",
"调用方请仅依赖 licensePlate 字段以适配新版本;历史字段已裁剪且不再保证存 在。",
"文档中未包含任何云密钥或敏感配置信息。"
],
"type": "changed"
},
{
"version": "2026.04.10-system-01",
"date": "2026-04-10",
"summary": "订单审核字段由 audit_status 替换为整数字段 step,并添加数据库迁移",
"methods": [
"order.getreviewOrderlist",
"order.reviewOrder.getreviewOrderlist",
"order.reviewOrder.reviewOrder",
"order.deliveryOrder.getdeliveryOrderlist",
"order.list",
"order.stats"
],
"notes": [
"字段变更:order 相关审核字段从字符串/枚举 audit_status 替换为整数 step。",
"step 映射:0=未审核,1=已审核,2=处理中,3=驳回/异常,4=配送中,5=已完成,9=已关闭。",
"reviewOrder 接口在更新 inspection_status 的同时会写入 step 字段。",
"必须执行迁移脚本:20260410150000-replace-audit-status-with-step-on-order-delivery-tables.js"
],
"type": "changed"
}
]