{ "generatedAt": "2026-06-18 17:45:21", "generatedAtLocal": "2026-06-18 17:45:21", "source": "remote", "filter": { "platform": { "value": "web", "label": "网页端" }, "project": { "value": "all", "label": "全部" } }, "module": { "name": "入库单模块", "key": "storage.entry", "folder": "storage.entry", "interfaceCount": 6 }, "changes": { "fromPreviousSnapshot": { "moduleAdded": false, "moduleRenamed": false, "interfaceChanges": { "addedMethods": [ "storage.entry.unbindReceivingDetails" ], "deletedMethods": [], "paramsUpdatedMethods": [], "responseUpdatedMethods": [ "storage.entry.get" ] } } }, "interfaces": [ { "method": "storage.entry.list", "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": "pagination", "type": "object", "required": false, "description": "分页参数,支持 page/pageSize" }, { "name": "where", "type": "object", "required": false, "description": "统一 where 条件对象;推荐使用 { operator, value, type } 标准结构,历史简写会在 main 中自动标准化;支持 quickWhere、order_status、store_id、order_type、日期区间等字段。新增 expense_record(费用是否记录)筛选,支持 eq/in;值会归一化为 0/1,兼容 true/false、1/0、y/n、yes/no(大小写不敏感,含布尔/字符串/数字写法)。示例:where.expense_record={operator:eq,value:true} 等价 where.expense_record={operator:eq,value:1};where.expense_record={operator:in,value:[true,\"0\",\"yes\",\"n\"]} 会归一化为 [1,0]。若部署环境尚未完成 expense_record 字段迁移,传入该筛选可能返回 400,错误提示为“当前环境未提供 expense_record 字段,暂不支持该筛选条件,请先完成表结构升级”。" }, { "name": "sort", "type": "object", "required": false, "description": "排序参数,支持 sortField/sortOrder" } ], "response": [ { "name": "list", "type": "array", "required": true, "description": "入库单列表" }, { "name": "pagination", "type": "object", "required": true, "description": "分页信息(page、pageSize、total、totalPages、hasPrevious、hasNext)" }, { "name": "summary", "type": "object", "required": true, "description": "状态汇总(total、pending、creating、created、completed、cancelled)" } ] }, { "method": "storage.entry.get", "title": "查询入库单详情。返回的 entryOrder.items 每项包含 pending_total(当前 pending 绑定的总预分配数量)、total_planned(计划入库数量=count)、bindings(pending 绑定列表,每项含 id/entry_item_id/receiving_detail_id/allocated_quantity/status/receivingDetail)", "description": "查询入库单详情。返回的 entryOrder.items 每项包含 pending_total(当前 pending 绑定的总预分配数量)、total_planned(计划入库数量=count)、bindings(pending 绑定列表,每项含 id/entry_item_id/receiving_detail_id/allocated_quantity/status/receivingDetail)", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "id", "type": "number", "required": false, "description": "入库单ID,与 entry_order_code 二选一" }, { "name": "entry_order_code", "type": "string", "required": false, "description": "入库单号,与 id 二选一" } ], "response": [ { "name": "entryOrder", "type": "object", "required": true, "description": "入库单详情,含 items 明细数组" } ] }, { "method": "storage.entry.cancel", "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": "id", "type": "number", "required": false, "description": "入库单ID,兼容旧调用;与 `ids` 二选一。若同时传入 `ids`,以 `ids` 为准。" }, { "name": "ids", "type": "array", "required": false, "description": "入库单ID数组(number[]),用于批量作废;必须为非空数组,建议批量操作使用 `ids`,优先于 `id`。" } ], "response": [ { "name": "id", "type": "number", "required": false, "description": "单条作废时返回的入库单ID" }, { "name": "ids", "type": "array", "required": false, "description": "批量作废时返回的已成功作废入库单ID数组(number[])" } ] }, { "method": "storage.entry.completeEntry", "title": "完成入库单。入库单状态变更为 COMPLETED 后,异步触发收货单匹配与回传:系统会从入库单 remark 中匹配近 3 天收货单号,明细一致则按来源回传(奇门→奇门确认接口,API→OpenAPI 回调);若收货单覆盖入库单,还会标记收货单为部分入库。异步匹配失败不阻塞主流程,仅记录日志。", "description": "完成入库单。入库单状态变更为 COMPLETED 后,异步触发收货单匹配与回传:系统会从入库单 remark 中匹配近 3 天收货单号,明细一致则按来源回传(奇门→奇门确认接口,API→OpenAPI 回调);若收货单覆盖入库单,还会标记收货单为部分入库。异步匹配失败不阻塞主流程,仅记录日志。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "id", "type": "number", "required": true, "description": "入库单ID" } ], "response": [ { "name": "id", "type": "number", "required": true, "description": "完成成功的入库单ID" } ] }, { "method": "storage.entry.bindReceivingDetails", "title": "入库单明细绑定收货明细。将指定的收货单明细与入库单明细建立绑定关系,并立即更新入库明细的 received_quantity(绑定即实收)。重复调用会先回退旧绑定量再创建新绑定。提交入库时完成收货单侧的入库数量扣减和库存上架。", "description": "入库单明细绑定收货明细。将指定的收货单明细与入库单明细建立绑定关系,并立即更新入库明细的 received_quantity(绑定即实收)。重复调用会先回退旧绑定量再创建新绑定。提交入库时完成收货单侧的入库数量扣减和库存上架。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "entry_item_id", "type": "number", "required": true, "description": "入库单明细ID(wms_entry_items.id)" }, { "name": "bindings", "type": "array", "required": true, "description": "收货明细绑定数组,每项包含 receiving_detail_id(收货明细ID, number, 必填)和 allocated_quantity(分配数量, number, 必填, 正整数)" } ], "response": [ { "name": "entry_item_id", "type": "number", "required": true, "description": "入库明细ID" }, { "name": "binding_count", "type": "number", "required": true, "description": "创建的绑定数量" } ] }, { "method": "storage.entry.unbindReceivingDetails", "title": "解绑入库明细的收货明细绑定。删除指定入库明细的所有 pending 绑定,并回退 received_quantity(恢复到绑定前的值),收货单明细的可用数量自动恢复(因为绑定记录被删除)。", "description": "解绑入库明细的收货明细绑定。删除指定入库明细的所有 pending 绑定,并回退 received_quantity(恢复到绑定前的值),收货单明细的可用数量自动恢复(因为绑定记录被删除)。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "entry_item_id", "type": "number", "required": true, "description": "入库单明细ID" } ], "response": [ { "name": "entry_item_id", "type": "number", "required": true, "description": "入库明细ID" }, { "name": "released_quantity", "type": "number", "required": true, "description": "释放的绑定总量" } ] } ] }