{ "generatedAt": "2026-06-13 17:11:23", "generatedAtLocal": "2026-06-13 17:11:23", "source": "remote", "filter": { "platform": { "value": "web", "label": "网页端" }, "project": { "value": "all", "label": "全部" } }, "module": { "name": "库存操作模块", "key": "storage.inventory", "folder": "storage.inventory", "interfaceCount": 7 }, "changes": { "fromPreviousSnapshot": { "moduleAdded": false, "moduleRenamed": false, "interfaceChanges": { "addedMethods": [], "deletedMethods": [], "paramsUpdatedMethods": [], "responseUpdatedMethods": [] } } }, "interfaces": [ { "method": "storage.inventory.quickPutaway", "title": "收货单快捷入库上架。从收货单直接生成入库单并写入库存表,要求收货单已完成、已审核、货主已开启快捷入库策略且所有明细已匹配系统商品", "description": "收货单快捷入库上架。从收货单直接生成入库单并写入库存表,要求收货单已完成、已审核、货主已开启快捷入库策略且所有明细已匹配系统商品", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [], "params": [ { "name": "receiving_id", "type": "number", "required": true, "description": "收货单ID,兼容 id" } ], "response": [] }, { "method": "storage.inventory.matchPutaway", "title": "收货单与入库单匹配入库。接收多个收货单和入库单,按商品(stock_warehouse_id)进行数量匹配入库,要求收货单已完成且已审核,完成后根据入库单来源(QM/API)自动触发回传", "description": "收货单与入库单匹配入库。接收多个收货单和入库单,按商品(stock_warehouse_id)进行数量匹配入库,要求收货单已完成且已审核,完成后根据入库单来源(QM/API)自动触发回传", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [], "params": [ { "name": "receiving_ids", "type": "array", "required": true, "description": "收货单ID列表" }, { "name": "entry_order_ids", "type": "array", "required": true, "description": "入库单ID列表" } ], "response": [] }, { "method": "storage.inventory.transferLocation", "title": "单商品单库位移库,将库存从一个库位移动到另一个库位,支持部分数量移库和全量移库", "description": "单商品单库位移库,将库存从一个库位移动到另一个库位,支持部分数量移库和全量移库", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [], "params": [ { "name": "storage_id", "type": "number", "required": true, "description": "库存记录ID" }, { "name": "target_space_id", "type": "number", "required": true, "description": "目标库位ID" }, { "name": "quantity", "type": "number", "required": false, "description": "移库数量,不传则全部移动" } ], "response": [] }, { "method": "storage.inventory.transferByProduct", "title": "按库位+商品维度移库,自动查找原库位下该商品的所有库存记录并合并移动。不适用于开启批次管理的商品", "description": "按库位+商品维度移库,自动查找原库位下该商品的所有库存记录并合并移动。不适用于开启批次管理的商品", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [], "params": [ { "name": "space_id", "type": "number", "required": true, "description": "原库位ID" }, { "name": "stock_id", "type": "number", "required": true, "description": "商品SKU ID(wms_stock_warehouse.id)" }, { "name": "target_space_id", "type": "number", "required": true, "description": "目标库位ID" }, { "name": "quantity", "type": "number", "required": true, "description": "移库数量" } ], "response": [] }, { "method": "storage.inventory.list", "title": "库存列表查询(查 wms_storage),支持 where 条件、分页、排序、批次分组。默认按库位+商品合并数量(合并模式),group_by_batch=true 时返回每条库存明细(明细模式)", "description": "库存列表查询(查 wms_storage),支持 where 条件、分页、排序、批次分组。默认按库位+商品合并数量(合并模式),group_by_batch=true 时返回每条库存明细(明细模式)", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [], "params": [ { "name": "where", "type": "object", "required": false, "description": "统一 where 条件对象,可用字段:stock_id(商品ID)、space_id(库位ID)、store_id(货主ID)、inventory_type(ZP/CC/JS/XS/ZT/DJ/FP)、batch_no(批次号)、inbound_order_no(入库单号)、available_quantity(可用数量,支持 gt/lt)、inbound_time(入库时间,支持 between)、created_at(创建时间,支持 between)" }, { "name": "pagination", "type": "object", "required": false, "description": "分页参数 { page, pageSize },默认 page=1, pageSize=20" }, { "name": "sort", "type": "object", "required": false, "description": "排序参数 { sortField, sortOrder },默认 sortField='created_at', sortOrder='DESC'" }, { "name": "group_by_batch", "type": "boolean", "required": false, "description": "是否按批次查询,默认 false。false=合并模式(按库位+商品聚合quantity/locked_quantity/available_quantity),true=明细模式(逐条返回含 batch_no/production_date/expiry_date 等)" } ], "response": [] }, { "method": "storage.expiry.list", "title": "库存有效期列表查询(效期预警),按 wms_storage 查询并计算剩余天数与过期状态,支持 where 条件与分页。注意:无需传 warehouse_id/store_id,服务端会从当前登录用户取仓库上下文。", "description": "库存有效期列表查询(效期预警),按 wms_storage 查询并计算剩余天数与过期状态,支持 where 条件与分页。注意:无需传 warehouse_id/store_id,服务端会从当前登录用户取仓库上下文。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [], "params": [ { "name": "where", "type": "object", "required": false, "description": "统一 where 条件对象;支持字段:item_code、goods_code、item_name、sku_property、stock_unit、is_shelf_life_mgmt、remaining_threshold_days。示例:where.item_code={operator:like,value:ABC}; where.remaining_threshold_days={operator:lte,value:7}。注意:无需传入 store_id 或 warehouse_id,服务端会从当前登录用户获取仓库上下文。" }, { "name": "pagination", "type": "object", "required": false, "description": "分页参数 { page, pageSize },默认 page=1, pageSize=20" } ], "response": [ { "name": "data.list", "type": "array", "required": true, "description": "匹配到的库存效期项数组" }, { "name": "data.list[]", "type": "object", "required": false, "description": "列表项,包含至少以下字段" }, { "name": "data.pagination", "type": "object", "required": true, "description": "分页信息,含 page、pageSize、total、totalPages" } ] }, { "method": "storage.transaction.list", "title": "出入库记录列表查询,支持 where 条件、分页、排序、批次分组切换。默认按库位合并数量(合并模式),group_by_batch=true 时返回每条明细(明细模式)", "description": "出入库记录列表查询,支持 where 条件、分页、排序、批次分组切换。默认按库位合并数量(合并模式),group_by_batch=true 时返回每条明细(明细模式)", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [], "params": [ { "name": "where", "type": "object", "required": false, "description": "统一 where 条件对象,可用字段:transaction_type(ENUM INBOUND/OUTBOUND)、stock_id、space_id、store_id、order_type(SCRK/MATCH)、order_no、inventory_type(ZP/CC/JS/XS/ZT/DJ/FP)、operator_name、created_at(支持 between)" }, { "name": "pagination", "type": "object", "required": false, "description": "分页参数 { page, pageSize },默认 page=1, pageSize=20" }, { "name": "sort", "type": "object", "required": false, "description": "排序参数 { sortField, sortOrder },默认 sortField='created_at', sortOrder='DESC'" }, { "name": "group_by_batch", "type": "boolean", "required": false, "description": "是否按批次查询明细,默认 false。false=合并模式(按库位+商品聚合),true=明细模式(逐条返回)" } ], "response": [] } ] }