docs(methods): 同步盘点/回调注册表/手工运单号/收货绑定接口文档(0.3.205)
This commit is contained in:
parent
08f194c7d2
commit
6c8a96de3b
@ -1,4 +1,157 @@
|
||||
[
|
||||
{
|
||||
"version": "2026.09.30-manual-waybill-express-code",
|
||||
"date": "2026-09-30",
|
||||
"type": "updated",
|
||||
"summary": "order.pendingOrder.manualWaybill 新增可选参数 express_code:传入时同步修改订单的快递编码,行为参考 updateOrderExpress",
|
||||
"methods": [
|
||||
"order.pendingOrder.manualWaybill"
|
||||
],
|
||||
"notes": [
|
||||
"代码依据:app/service/systemMethods/order/pendingOrder.js#manualWaybill 新增可选入参 express_code(string,选填,trim 后为空视为未传);传入时参考 updateOrderExpress 的解析口径——从当前仓库快递列表(带缓存 getExpressList)中查找对应项,不存在则抛『快递编码 <express_code> 不存在』;自定义映射(is_system_setting=true)时订单 sys_logistics_code/name 写系统快递编码和名称、logistics_code/name 写自定义编码和名称,系统快递(is_system_setting=false)时四个字段均写系统快递的 code/name;不传时保持原行为(运单记录沿用订单当前 sys_logistics_code/name)。",
|
||||
"写入范围:传入 express_code 时,订单表同步更新 sys_logistics_code/sys_logistics_name/logistics_code/logistics_name 四字段(与 print_status/post_status='fin' 同一次 update),运单记录(wms_order_express)的 logistics_code/logistics_name 写入解析后的新值;不传时运单记录沿用订单原系统快递字段。",
|
||||
"操作日志:extras 新增 expressCode/sysLogisticsCode/sysLogisticsName/logisticsCode/logisticsName 字段,message 在传入 express_code 时补充快递信息。",
|
||||
"响应:传入 express_code 时额外返回 express_code、sys_logistics_code、sys_logistics_name、logistics_code、logistics_name;不传时响应结构与原版本一致(向后兼容)。",
|
||||
"文档变更范围:methods/system.json 的 order.pendingOrder.manualWaybill 更新 description、params 新增 express_code、response 新增 5 个可选字段、errors 新增 404 快递编码不存在;根版本 0.3.204 → 0.3.205、updatedAt 更新为 2026-09-30;methods/changes/system.json 新增本条(插入数组首位);其余 method 未改动。"
|
||||
]
|
||||
},
|
||||
{
|
||||
"version": "2026.09.29-stock-check-no-global-sequence",
|
||||
"date": "2026-09-29",
|
||||
"type": "updated",
|
||||
"summary": "盘点单号改为全局递增:generateCheckNo 移除按仓库隔离(uk_check_no 全局唯一索引下按仓从 1 起会跨仓撞号),create 撞唯一键自动重取重试最多 5 次,口径与收货单 receiving_number 一致",
|
||||
"methods": [
|
||||
"stock.check.create"
|
||||
],
|
||||
"notes": [
|
||||
"代码依据:app/service/systems/stock_check.js#generateCheckNo 移除 warehouse_id 隔离条件,改为查询全局最大 PD+YYYYMMDD 前缀单号取末尾 6 位序号 +1;新增 isCheckNoDuplicateError()(parent.code==='ER_DUP_ENTRY' 且 sqlMessage 命中 uk_check_no/check_no,参照收货单 isReceivingNumberDuplicateError 口径);create() 撞唯一键自动重取单号重试最多 5 次(与收货单 create 重试口径一致),超过重试次数或非单号冲突错误原样抛出。",
|
||||
"原因说明:uk_check_no 为全局唯一索引(不区分仓库),原按仓库隔离序号各自从 1 起会跨仓撞号;改为全局递增后并发创建仍有极小概率撞号,由唯一键重试兜底。",
|
||||
"收货单参照口径:与收货单 receiving_number 一致——按全局最大序号 +1 生成 + 撞唯一键自动重取重试。",
|
||||
"并发重试说明:每次重试都重新调用 generateCheckNo() 取最新全局最大序号;仅 ER_DUP_ENTRY 且命中 uk_check_no 才重试,其它错误直接抛出。",
|
||||
"文档变更范围:methods/system.json 的 module=stock.check 分组更新 stock.check.create 的 description 与 notes;根版本 0.3.203 → 0.3.204、updatedAt 保持 2026-09-29;methods/changes/system.json 新增本条(插入数组首位);其余 method 未改动。",
|
||||
"库表维护源说明:维护源为库表(wms_api_method_doc + wms_method_doc_meta);本次按 docs/api-doc-update-workflow.md 走 npm run doc:api:update 写入 JSON 后,同步回填开发库与生产库(import 当前 system.json → export 回写往返校验),保持库与文件一致。"
|
||||
]
|
||||
},
|
||||
{
|
||||
"version": "2026.09.29-stock-check-detail-delete",
|
||||
"date": "2026-09-29",
|
||||
"type": "added",
|
||||
"summary": "新增 stock.check.detailDelete:删除盘点明细(从任务移除商品),仅 created/rejected 状态允许,删除时防御性清理作业记录并重算 total_items",
|
||||
"methods": [
|
||||
"stock.check.detailDelete"
|
||||
],
|
||||
"notes": [
|
||||
"代码依据:app/service/systemMethods/stock/check.js(ALL_METHOD_NAMES 扩为 14 个含 detailDelete;detailDelete 从登录上下文注入 warehouseId,入参 id + detail_id(兼容 detailId 驼峰,detail_id 优先),走统一 _call 捕获业务错误码;为写操作,不在免日志清单 list/detail/recordList/export/exportTaskProgress 中)、app/service/systems/stock_check.js(detailDelete:id/detail_id 非法抛 400『盘点任务ID不能为空/盘点明细ID不能为空』,任务不存在/明细不存在分别抛 400;仅 ADD_DETAIL_ALLOWED_STATUSES(created/rejected)允许删除,否则 400『当前状态(xxx)不允许删除明细』;删除明细后防御性清理 wms_stock_check_record 并重算主表 total_items;返回 { detail_id, deleted:true, total_items })。",
|
||||
"状态限制口径:仅主表 created/rejected 允许删除明细(与 addDetail 口径一致,共用 ADD_DETAIL_ALLOWED_STATUSES);其它状态返回 400。",
|
||||
"防御清理说明:正常流程 created/rejected 状态不应存在作业记录,但为兜底,删除明细时按 { detail_id, check_id, warehouse_id } 一并删除 wms_stock_check_record 中的关联记录,避免残留孤儿记录;删除后重算主表 total_items。",
|
||||
"权限口径:随 ALL_METHOD_NAMES 免 API 权限(isNeedAuth=false)、免仓库有效期鉴权(免鉴权清单)、必须登录(isNeedLogin=true,免登录清单为空);detailDelete 为写操作,记录操作日志。",
|
||||
"文档变更范围:methods/system.json 的 module=stock.check 分组新增 stock.check.detailDelete(放在 addDetail 之后,与代码 ALL_METHOD_NAMES 顺序一致);根版本 0.3.202 → 0.3.203、updatedAt 保持 2026-09-29;methods/changes/system.json 新增本条(插入数组首位);其余 method 未改动。",
|
||||
"库表维护源说明:维护源为库表(wms_api_method_doc + wms_method_doc_meta);本次先按 docs/api-doc-update-workflow.md 走 npm run doc:api:update 写入 JSON,随后同步回填开发库与生产库(import 当前 system.json → export 回写往返校验),保持库与文件一致。"
|
||||
]
|
||||
},
|
||||
{
|
||||
"version": "2026.09.29-stock-check-record-unique-index",
|
||||
"date": "2026-09-29",
|
||||
"type": "updated",
|
||||
"summary": "盘点作业记录表加固:location_code 空串归一 + 历史重复合并 + 唯一索引 uk_detail_location(detail_id, location_code),从数据库层保证 report 覆盖式上报并发安全;接口返回口径不变(空库位 location_code 仍为 null)",
|
||||
"methods": [
|
||||
"stock.check.report",
|
||||
"stock.check.recordList"
|
||||
],
|
||||
"notes": [
|
||||
"代码依据:app/service/systems/stock_check.js(report 未传库位归一存空串 '';查重条件统一 { detail_id, location_code };依赖数据库层唯一索引 uk_detail_location 保证并发安全;recordList 返回 location_code 空串归一为 null;detail 的 locations/location_codes 输出口径不变,空库位组 location_code=null)、app/model/stock_check_record.js(location_code allowNull=false defaultValue='')。",
|
||||
"迁移:database/migrations/20260929130000-unique-stock-check-record-detail-location.js——location_code 归一 NULL→''、合并历史重复记录(同 detail_id+location_code 保留 id 最大一条)、列改 NOT NULL DEFAULT ''、新增唯一索引 uk_detail_location(detail_id, location_code);本地与生产均已执行。",
|
||||
"口径变化:report 未传库位不再存 NULL 而是存空串 ''(\"无库位\"分组),覆盖式查重条件不变({ detail_id, location_code },含空串分组),并发下由唯一索引兜底不产生重复记录。",
|
||||
"接口兼容性:对外返回口径不变——recordList 将空串归一为 null、detail 的 locations/location_codes 空库位组 location_code 仍为 null,客户端无需调整。",
|
||||
"文档变更范围:methods/system.json 的 module=stock.check 分组更新 stock.check.report 的 description/notes 与 location 入参描述、stock.check.recordList 的 rows response 描述与 notes(空串归一 null 口径);根版本 0.3.201 → 0.3.202、updatedAt 保持 2026-09-29;methods/changes/system.json 新增本条(插入数组首位);其余 method 未改动。",
|
||||
"维护源口径(遗留事项):methods/system.json 的维护源为库表(wms_api_method_doc + wms_method_doc_meta);本次按 docs/api-doc-update-workflow.md 走 npm run doc:api:update 直接写 JSON,未连接数据库、未写库,后续由维护者决定是否同步入库。"
|
||||
]
|
||||
},
|
||||
{
|
||||
"version": "2026.09.29-stock-check-work-adjust",
|
||||
"date": "2026-09-29",
|
||||
"type": "updated",
|
||||
"summary": "盘点作业接口 5 项调整:report 改为覆盖式(同明细+同库位重复上报更新已有记录)、新增 recordDelete(删作业记录重算汇总)与 recordList(分页查作业记录)、detail rows 增加按库位聚合 locations、finish 放宽未盘校验(未盘按实盘 0 计盘亏并返回 unchecked_items)",
|
||||
"methods": [
|
||||
"stock.check.report",
|
||||
"stock.check.detail",
|
||||
"stock.check.finish",
|
||||
"stock.check.recordDelete",
|
||||
"stock.check.recordList"
|
||||
],
|
||||
"notes": [
|
||||
"代码依据:app/service/systemMethods/stock/check.js(ALL_METHOD_NAMES 扩为 13 个含 recordList/recordDelete;免权限/免鉴权清单共用全部方法,免日志清单为 list/detail/recordList/export/exportTaskProgress;recordDelete 入参兼容 record_id/recordId 写法)、app/service/systems/stock_check.js(report 覆盖式上报:同 detail_id + 同 location_code(含同为空库位 location_code 为 NULL)更新已有记录 quantity/checker_id/checker_name/checked_at 并保留/回填 location_id,否则新增,返回 mode=created|updated;recordList 按 id DESC 分页返回记录全字段 + item_code/item_name;recordDelete 仅 approved/checking 状态、删除后重算汇总且主表状态不回退;detail rows 增加 locations 按库位聚合;finish 未盘明细按实盘 0 计盘亏并返回 unchecked_items)。",
|
||||
"行为口径变化明细:①stock.check.report 从每次新增一条记录改为覆盖式——同 detail_id + 同 location_code(含同为空库位)重复上报更新已有记录(quantity/checker/checked_at),首次上报才新增,返回 mode=created|updated;②新增 stock.check.recordDelete:入参 id + record_id(兼容 recordId),仅 approved/checking 状态允许,删除后重算 total_items/checked_items/diff_items/detail_status(明细记录删光后回到未盘),主表状态不回退,返回 { record_id, deleted:true, ...summary };③新增 stock.check.recordList:入参 id(可选)+ detail_id(可选)+ pagination 至少传其一,返回 { rows, total, page, pageSize },rows=记录全字段 + item_code/item_name,按 id DESC;④stock.check.detail rows 每条新增 locations 数组(按库位聚合 [{ location_id, location_code, quantity }],空库位归 location_code=null 组),records 与既有聚合字段不变;⑤stock.check.finish 不再拦截未盘明细,未盘按实盘 0 处理(diff=-账面快照,计盘亏与 diff_items),返回新增 unchecked_items 字段。",
|
||||
"无 schema 变更:本次仅业务行为调整,wms_stock_check / wms_stock_check_detail / wms_stock_check_record 表结构未变,无需数据库迁移。",
|
||||
"权限口径:recordList/recordDelete 与同分组其它方法一致——免 API 权限(isNeedAuth=false)、免仓库有效期鉴权、必须登录(isNeedLogin=true);recordList 为查询类免操作日志,recordDelete 为写操作记录操作日志。",
|
||||
"文档变更范围:methods/system.json 的 module=stock.check 分组新增 stock.check.recordList、stock.check.recordDelete 两条 method,更新 stock.check.report/detail/finish 三条 description 与 response(report 增加 mode 字段、detail rows 增加 locations 聚合、finish 增加 unchecked_items 并移除未盘拦截错误);根版本 0.3.200 → 0.3.201、updatedAt 保持 2026-09-29;methods/changes/system.json 新增本条(插入数组首位);其余 method 未改动。",
|
||||
"维护源口径(遗留事项):methods/system.json 的维护源为库表(wms_api_method_doc + wms_method_doc_meta);本次按 docs/api-doc-update-workflow.md 走 npm run doc:api:update 直接写 JSON,未连接数据库、未写库,后续由维护者决定是否同步入库。"
|
||||
]
|
||||
},
|
||||
{
|
||||
"version": "2026.09.29-storage-entry-bindReceiving-soft-deleted-restore",
|
||||
"date": "2026-09-29",
|
||||
"type": "fixed",
|
||||
"summary": "storage.entry.bindReceiving 修复解绑后重新绑定失败:CREATED 分支改用三态幂等(已存在跳过/软删除恢复/新建),不再因软删除残留行撞唯一索引报 BINDING_WRITE_FAILED(Validation error)",
|
||||
"methods": [
|
||||
"storage.entry.bindReceiving"
|
||||
],
|
||||
"notes": [
|
||||
"根因:findOrCreate 查询默认排除软删除行(paranoid),解绑(unbindReceiving 软删除主表绑定行)后再次绑定同一 (entry_order_id, receiving_id) 时,create 撞唯一索引 uk_entry_order_receiving 抛 SequelizeUniqueConstraintError(message 为 \"Validation error\"),被捕获计入 skipped 并返回 BINDING_WRITE_FAILED。生产现场:绑定行 id=793(入库单 1280 RK202609290005 ↔ 收货单 4686 R20725003)于 2026-09-28 19:02 解绑软删除,2026-09-29 重新绑定即失败。",
|
||||
"修复:app/service/systems/receiving_entry_match.js 的 bindEntryOrderReceiving CREATED 分支改为 paranoid:false 查询三态处理——未删除已存在跳过(created=false)、已软删除则 allocated_quantity 重置为 {} 并 restore(restored=true)、不存在新建(create 唯一索引冲突视为并发已建立,created=false);bound 项统一返回 created/restored 两字段。",
|
||||
"同类加固:_commitBinding(PDA 上架确保主表绑定)的 findOrCreate 同步改为三态;_bindEntryOrderReceiving(自动匹配)与 _bindOneReceivingAndSyncStorage(COMPLETED)恢复软删除行时显式 allocated_quantity={} 兜底、软删除判断兼容 deletedAt/deleted_at 两种属性名。",
|
||||
"文档变更范围:methods/system.json storage.entry.bindReceiving 的 bound.created/restored 描述更新、restored required 改为 true;根版本 0.3.199 → 0.3.200、updatedAt 保持 2026-09-29;methods/changes/system.json 新增本条(插入数组首位);其余 method 未改动。",
|
||||
"维护源口径(遗留事项):methods/system.json 的维护源为库表(wms_api_method_doc + wms_method_doc_meta);本次直接写 JSON,未连接数据库、未写库,后续由维护者决定是否同步入库。"
|
||||
]
|
||||
},
|
||||
{
|
||||
"version": "2026.09.29-stock-check-detail-split",
|
||||
"date": "2026-09-29",
|
||||
"type": "updated",
|
||||
"summary": "盘点明细表拆分:wms_stock_check_detail 仅保留盘点商品(stock_id+快照),库位/数量信息下沉到新建 wms_stock_check_record(盘点作业记录表);report 改为写入记录(同明细可多库位多次上报),已盘口径=存在记录,差异=记录数量合计-账面快照;detail 返回 records 与聚合字段;导出明细行含库位合并/盘点人合并。",
|
||||
"methods": [
|
||||
"stock.check.report",
|
||||
"stock.check.detail",
|
||||
"stock.check.finish",
|
||||
"stock.check.export",
|
||||
"stock.check.exportTaskProgress"
|
||||
],
|
||||
"notes": [
|
||||
"代码依据:app/model/stock_check_detail.js(明细表仅存盘点商品:stock_id+商品快照,移除 location_id/location_code/check_quantity/diff_quantity/is_diff/status/checker_id/checker_name/checked_at)、app/model/stock_check_record.js(新建盘点作业记录表:check_id/warehouse_id/detail_id/stock_id/location_id/location_code/quantity/checker_id/checker_name/checked_at/remark,一个明细可在多库位多次上报)、app/service/systems/stock_check.js(report 写入记录不再更新明细;detail 返回 records 与聚合字段;finish 未盘=无记录明细、差异按记录聚合;export Sheet2 商品级聚合+库位/盘点人合并)、app/service/systemMethods/stock/check.js(report 从登录上下文注入 checkerId/checkerName)。",
|
||||
"迁移:database/migrations/20260929120000-split-stock-check-detail-create-record.js(明细表移除 9 个作业字段 + 新建 wms_stock_check_record 及 4 个索引 idx_check_id/idx_detail_id/idx_stock_id/idx_warehouse_location),本地与生产均已执行。",
|
||||
"口径变化明细:report 每次上报新增一条作业记录(同明细可在多库位多次上报),明细已盘数量=记录 quantity 合计;已盘口径=存在记录(DISTINCT detail_id);差异=记录数量合计-账面快照 system_quantity;detail.rows 返回 checked_quantity/diff_quantity/is_diff/status/location_codes[]/checkers[]/last_checked_at + records[];finish 未盘明细=无记录明细;export Sheet2 明细行(商品级聚合)列为 盘点单号/商品编码/商品名称/规格/账面数量/已盘数量/差异数量/是否有差异/库位编码(顿号合并)/盘点人(合并)/最近盘点时间。",
|
||||
"文档变更范围:methods/system.json 的 module=stock.check 分组更新 stock.check.report/detail/finish/export 共 4 条 method 的 description 与 response;根版本 0.3.198 → 0.3.199、updatedAt 保持 2026-09-29;methods/changes/system.json 新增本条(插入数组首位);其余 method 未改动。",
|
||||
"维护源口径(遗留事项):methods/system.json 的维护源为库表(wms_api_method_doc + wms_method_doc_meta);本次按 docs/api-doc-update-workflow.md 走 npm run doc:api:update 直接写 JSON,未连接数据库、未写库,后续由维护者决定是否同步入库。"
|
||||
]
|
||||
},
|
||||
{
|
||||
"version": "2026.09.29-stock-check-apis",
|
||||
"date": "2026-09-29",
|
||||
"type": "added",
|
||||
"summary": "新增库存盘点模块 11 个 method(创建空任务/列表/添加明细/拉取明细/盘点作业上报/完成盘点/提交审核/取消/审核/导出/导出进度),完整状态机 created→submitted→approved/rejected→checking→completed/cancelled",
|
||||
"methods": [
|
||||
"stock.check.create",
|
||||
"stock.check.list",
|
||||
"stock.check.addDetail",
|
||||
"stock.check.detail",
|
||||
"stock.check.report",
|
||||
"stock.check.finish",
|
||||
"stock.check.submit",
|
||||
"stock.check.cancel",
|
||||
"stock.check.audit",
|
||||
"stock.check.export",
|
||||
"stock.check.exportTaskProgress"
|
||||
],
|
||||
"notes": [
|
||||
"代码依据:app/service/systemMethods/stock/check.js(11 个 method 包装层,统一 _call 包装 400/500)与 app/service/systems/stock_check.js(状态机、单号生成 PD+YYYYMMDD+6位序号、汇总重算、Excel 导出 + COS 上传)。",
|
||||
"表结构:wms_stock_check(盘点主表,仓库隔离 warehouse_id、盘点单号 check_no 唯一、状态 status、明细进度 detail_status、汇总 total_items/checked_items/diff_items)与 wms_stock_check_detail(盘点明细表,商品/库位快照、账面数量 system_quantity、实盘数量 check_quantity、差异数量 diff_quantity=实盘-账面)。",
|
||||
"迁移:database/migrations/20260929100000-create-wms-stock-check.js、20260929101000-create-wms-stock-check-detail.js、20260929110000-align-stock-check-status-machine.js(主表 status 默认值 pending → created、注释对齐新状态机),本地与生产均已执行。",
|
||||
"权限口径:11 个 method 全部免权限/免鉴权(仓库有效期检查)/需登录;list/detail/export/exportTaskProgress 免操作日志;不产生 wms_permission 权限记录,无需执行 permission:sync:system-api。",
|
||||
"导出任务口径:Redis 进度缓存 key stock_check_export_task_{taskId}、TTL 1800 秒;每任务一个 Sheet(Sheet 名=盘点单号 check_no);单次最多 50 个盘点任务。",
|
||||
"文档变更范围:methods/system.json 新增分组 module=stock.check(库存盘点模块)共 11 条 method;根版本 0.3.196 → 0.3.197、updatedAt 2026-09-28 → 2026-09-29;methods/changes/system.json 新增本条(插入数组首位);其余 method 未改动。",
|
||||
"维护源口径(遗留事项):methods/system.json 的维护源为库表(wms_api_method_doc + wms_method_doc_meta);本次按 docs/api-doc-update-workflow.md 走 npm run doc:api:update 直接写 JSON,未连接数据库、未写库,后续由维护者决定是否同步入库。"
|
||||
]
|
||||
},
|
||||
{
|
||||
"version": "2026.09.28-weigh-pack-padding-message",
|
||||
"date": "2026-09-28",
|
||||
|
||||
1345
methods/system.json
1345
methods/system.json
File diff suppressed because it is too large
Load Diff
Loading…
x
Reference in New Issue
Block a user