{ "generatedAt": "2026-05-26 09:05:07", "generatedAtLocal": "2026-05-26 09:05:07", "source": "remote", "filter": { "platform": { "value": "web", "label": "网页端" }, "project": { "value": "all", "label": "全部" } }, "module": { "name": "商品模块", "key": "stock", "folder": "stock", "interfaceCount": 25 }, "changes": { "fromPreviousSnapshot": { "moduleAdded": false, "moduleRenamed": false, "interfaceChanges": { "addedMethods": [], "deletedMethods": [], "paramsUpdatedMethods": [], "responseUpdatedMethods": [] } } }, "interfaces": [ { "method": "stock.warehouse.list", "title": "仓库商品列表查询(支持 where 条件与分页)", "description": "仓库商品列表查询(支持 where 条件与分页)", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "pagination", "type": "object", "required": false, "description": "pagination 参数" }, { "name": "where", "type": "object", "required": false, "description": "统一 where 条件对象;推荐使用 { operator, value, type } 标准结构,历史简写会在 main 中自动标准化;支持 quickWhere、barcode、prohibited_type 等商品筛选字段。示例:where.barcode={operator:like,value:69}; where.prohibited_type={operator:eq,value:liquid}。" } ], "response": [] }, { "method": "stock.warehouse.export", "title": "提交导出任务,返回 task_id/status/progress/message/result/error/update_time", "description": "提交导出任务,返回 task_id/status/progress/message/result/error/update_time", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "where", "type": "object", "required": false, "description": "查询条件对象,与 stock.warehouse.list 的 where 语义一致;推荐使用 { operator, value, type } 标准结构,历史简写会在 main 中自动标准化。" }, { "name": "sort", "type": "object", "required": false, "description": "排序参数对象,支持 sortField/sortOrder 与 sort_field/sort_order 下划线别名兼容。" }, { "name": "sort.sortField", "type": "string", "required": false, "description": "排序字段(兼容 sort.sortField)。" }, { "name": "sort.sort_field", "type": "string", "required": false, "description": "排序字段下划线别名(兼容 sort.sort_field)。" }, { "name": "sort.sortOrder", "type": "string", "required": false, "description": "排序方向(ASC/DESC,大小写不敏感)。" }, { "name": "sort.sort_order", "type": "string", "required": false, "description": "排序方向下划线别名(兼容 sort.sort_order)。" } ], "response": [ { "name": "task_id", "type": "string", "required": false, "description": "任务 ID(后端生成的唯一标识)" }, { "name": "status", "type": "string", "required": false, "description": "任务状态,枚举:submitted/running/success/failed/not_found" }, { "name": "progress", "type": "number", "required": false, "description": "进度百分比(0-100)" }, { "name": "message", "type": "string", "required": false, "description": "额外提示信息或受理消息" }, { "name": "result", "type": "object", "required": false, "description": "任务成功时返回的结果对象(可选)" }, { "name": "error", "type": "string", "required": false, "description": "失败时的错误信息(可选)" }, { "name": "update_time", "type": "string", "required": false, "description": "最近一次状态更新时间,ISO8601 字符串(可选)" } ] }, { "method": "stock.warehouse.exportTaskProgress", "title": "按 task_id 查询导出任务进度,未找到时 status=not_found", "description": "按 task_id 查询导出任务进度,未找到时 status=not_found", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "task_id / taskId", "type": "string", "required": true, "description": "任务 ID,兼容 taskId" } ], "response": [ { "name": "task_id", "type": "string", "required": false, "description": "任务 ID" }, { "name": "status", "type": "string", "required": false, "description": "任务状态:submitted/running/success/failed/not_found" }, { "name": "progress", "type": "number", "required": false, "description": "进度百分比(0-100)" }, { "name": "message", "type": "string", "required": false, "description": "额外提示信息" }, { "name": "result", "type": "object", "required": false, "description": "任务成功时返回的结果对象(可选)" }, { "name": "error", "type": "string", "required": false, "description": "失败时的错误信息(可选)" }, { "name": "download_url", "type": "string", "required": false, "description": "任务完成后可直接下载的文件地址(若有)" }, { "name": "update_time", "type": "string", "required": false, "description": "最近一次状态更新时间,ISO8601 字符串(可选)" } ] }, { "method": "stock.warehouse.getProhibitedType", "title": "查询违禁品类型列表(系统预设+仓库自定义)", "description": "查询违禁品类型列表(系统预设+仓库自定义)", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "method": "stock.warehouse.getInfo", "title": "查询仓库商品详情", "description": "查询仓库商品详情", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "method": "stock.warehouse.getStockDetail", "title": "按库位/批次维度查询商品库存分布", "description": "按库位/批次维度查询商品库存分布", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "stock_id", "type": "number", "required": true, "description": "商品库存ID(stock_warehouse.id)" }, { "name": "pagination", "type": "object", "required": false, "description": "分页参数,包含 page/pageSize" }, { "name": "group_by_batch", "type": "boolean", "required": false, "description": "是否按批次返回明细;true 返回每条明细,false 按库位合并" } ], "response": [ { "name": "stockItem", "type": "object", "required": false, "description": "商品概要,包含 id、item_code、item_name、sku_property、stock_unit、quantity、locked_quantity 等" }, { "name": "storageList", "type": "array", "required": false, "description": "库存明细数组;group_by_batch=true 返回 wms_storage 明细(含 batch_no、production_date、expiry_date、inbound_time、inbound_order_no、supplier_batch_no 等),group_by_batch=false 时按库位合并,批次相关字段为 null" }, { "name": "pagination", "type": "object", "required": false, "description": "分页信息,包含 page、pageSize、total" } ] }, { "method": "stock.warehouse.saveWarehouseStock", "title": "更新仓库商品资料", "description": "更新仓库商品资料", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "method": "stock.warehouse.createWarehouseStock", "title": "新建仓库商品资料", "description": "新建仓库商品资料", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "method": "stock.warehouse.import", "title": "批量导入或更新仓库商品。请求体优先直接传入商品数据数组 JSON(主方式为数组);也兼容以 rows/items/list/data 包装。每项仅需包含商品相关字段;当 SKU 为空时创建新商品,SKU 非空时为更新操作;更新会写操作日志以便审计。未传 store_id 时默认使用当前上下文仓库/主体(ctx.user.store_id)。", "description": "批量导入或更新仓库商品。请求体优先直接传入商品数据数组 JSON(主方式为数组);也兼容以 rows/items/list/data 包装。每项仅需包含商品相关字段;当 SKU 为空时创建新商品,SKU 非空时为更新操作;更新会写操作日志以便审计。未传 store_id 时默认使用当前上下文仓库/主体(ctx.user.store_id)。", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "items / rows / list / data", "type": "array", "required": true, "description": "商品数组(主方式为直接传数组 []),也兼容对象包装:{ rows: [...] } / { items: [...] } / { list: [...] } / { data: [...] }。每项可使用下列字段别名:" } ], "response": [ { "name": "total_count", "type": "number", "required": false, "description": "解析到的总条目数" }, { "name": "created_count", "type": "number", "required": false, "description": "成功创建的新商品数" }, { "name": "updated_count", "type": "number", "required": false, "description": "成功更新的商品数" }, { "name": "fail_count", "type": "number", "required": false, "description": "导入失败数" }, { "name": "created_ids", "type": "array", "required": false, "description": "创建成功的商品 ID 列表" }, { "name": "updated_ids", "type": "array", "required": false, "description": "更新成功的商品 ID 列表" }, { "name": "fail_items", "type": "array", "required": false, "description": "失败项明细数组,每项包含原始输入与错误信息" } ] }, { "method": "stock.warehouse.getBarcodes", "title": "查询商品条码列表", "description": "查询商品条码列表", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "method": "stock.warehouse.saveWarehouseStockBarcode", "title": "保存商品条码信息", "description": "保存商品条码信息", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "method": "stock.warehouse.getStoreStocks", "title": "查询仓库商品与货主关联列表", "description": "查询仓库商品与货主关联列表", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "method": "stock.warehouse.bindItem", "title": "绑定货主商品关系", "description": "绑定货主商品关系", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "method": "stock.warehouse.unbindItem", "title": "解绑货主商品关系", "description": "解绑货主商品关系", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "method": "stock.warehouse.checkItemCodeUnique", "title": "检测商品编码唯一性。在同一仓库和货主下,排除商品自身后,判断商品编码是否已存在于未删除商品中。", "description": "检测商品编码唯一性。在同一仓库和货主下,排除商品自身后,判断商品编码是否已存在于未删除商品中。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "warehouse_id", "type": "number", "required": true, "description": "仓库ID;默认使用当前登录主体/仓库上下文(ctx.user.store_id)" }, { "name": "item_code", "type": "string", "required": true, "description": "要检测的商品编码" }, { "name": "item_id", "type": "number", "required": false, "description": "当前商品ID(编辑场景用,排除自身);兼容字段名 id" }, { "name": "id", "type": "number", "required": false, "description": "兼容字段 id" }, { "name": "owner_id", "type": "number", "required": true, "description": "货主ID(对应表字段 store_id);兼容字段名 store_id" }, { "name": "store_id", "type": "number", "required": true, "description": "兼容字段 store_id" } ], "response": [ { "name": "unique", "type": "boolean", "required": false, "description": "true 表示编码唯一,false 表示已存在重复" }, { "name": "isUnique", "type": "boolean", "required": false, "description": "同 unique(兼容旧字段名)" }, { "name": "message", "type": "string", "required": false, "description": "重复时返回 '商品编码已存在',唯一时不返回该字段" } ] }, { "method": "stock.warehouse.queryStockLogs", "title": "查询库存操作日志", "description": "查询库存操作日志", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "warehouseId", "type": "string", "required": false, "description": "warehouseId 参数" } ], "response": [] }, { "method": "stock.warehouse.handleBatchDelete", "title": "批量删除仓库商品资料", "description": "批量删除仓库商品资料", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "method": "stock.warehouse.deleteUnit", "title": "删除库存单位", "description": "删除库存单位", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "method": "stock.warehouse.deleteProhibited", "title": "删除违禁品类型", "description": "删除违禁品类型", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "method": "stock.warehouse.handleBatchChange", "title": "批量修改仓库商品字段", "description": "批量修改仓库商品字段", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "ids", "type": "array", "required": true, "description": "要批量修改的仓库商品记录 ID 数组(stock_warehouse.id)" }, { "name": "method", "type": "string", "required": true, "description": "要修改的字段名,可选值:brand_name、prohibited_id、gross_weight、packing_requirements、managementFlags、stock_unit" }, { "name": "value", "type": "string|number|object", "required": true, "description": "修改值,类型依 method 而定:brand_name/packing_requirements/stock_unit 为 string(<=255 字符);prohibited_id 为 number(整数);gross_weight 为 number(正数,可含小数);managementFlags 为 object,必须包含 is_sn_mgmt/is_shelf_life_mgmt/is_batch_mgmt,值为 'Y' 或 'N'" }, { "name": "values", "type": "any", "required": false, "description": "兼容字段:当前实现以 `value` 为准,不使用 `values`。若客户端历史使用 `values`,请切换为 `value`。" } ], "response": [ { "name": "code", "type": "number", "required": false, "description": "业务状态码,200 表示成功;405 表示参数/权限校验不通过;500 表示服务器错误" }, { "name": "message", "type": "string", "required": false, "description": "业务提示信息" }, { "name": "data", "type": "object", "required": false, "description": "成功时返回的结果对象" } ] }, { "method": "stock.warehouse.getStockUnits", "title": "查询可用库存单位(系统+仓库)", "description": "查询可用库存单位(系统+仓库)", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "method": "stock.warehouse.getUnitList", "title": "查询当前仓库自定义单位列表", "description": "查询当前仓库自定义单位列表", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "method": "stock.warehouse.createProhibited", "title": "新增违禁品类型", "description": "新增违禁品类型", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "name", "type": "string", "required": true, "description": "name 参数" } ], "response": [] }, { "method": "stock.warehouse.createUnit", "title": "新增库存单位", "description": "新增库存单位", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "name", "type": "string", "required": true, "description": "name 参数" } ], "response": [] }, { "method": "stock.warehouse.search", "title": "仓库商品关键字搜索,按 item_code / item_name / goods_code / 条形码模糊匹配,最多返回 50 条", "description": "仓库商品关键字搜索,按 item_code / item_name / goods_code / 条形码模糊匹配,最多返回 50 条", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "keyword", "type": "string", "required": false, "description": "搜索关键字,模糊匹配 item_code、item_name、goods_code 以及关联的 barcode;为空时返回全部(仍受 limit 50 限制)" }, { "name": "store_id", "type": "number", "required": false, "description": "货主ID,传入时仅返回指定货主的商品" }, { "name": "with_stock", "type": "boolean", "required": false, "description": "是否返回关联库存数据(wms_storage),为 true 时每条商品新增 storage[] 字段" }, { "name": "is_batch", "type": "boolean", "required": false, "description": "是否按批次明细返回库存,仅 with_stock=true 时生效。false(默认)按库位分组汇总;true 逐条返回批次明细" } ], "response": [ { "name": "code", "type": "number", "required": false, "description": "业务状态码,200 表示成功" }, { "name": "data", "type": "array", "required": false, "description": "商品列表,每项包含以下字段" }, { "name": "total", "type": "number", "required": false, "description": "本次返回的记录条数(≤50)" } ] } ] }