{ "generatedAt": "2026-06-17 10:25:45", "generatedAtLocal": "2026-06-17 10:25:45", "source": "remote", "filter": { "platform": { "value": "web", "label": "网页端" }, "project": { "value": "all", "label": "全部" } }, "module": { "name": "收货单模块", "key": "storage_receiving", "folder": "storage_receiving", "interfaceCount": 17 }, "changes": { "fromPreviousSnapshot": { "moduleAdded": false, "moduleRenamed": false, "interfaceChanges": { "addedMethods": [], "deletedMethods": [], "paramsUpdatedMethods": [], "responseUpdatedMethods": [] } } }, "interfaces": [ { "method": "storage.receiving.getReceivingList", "title": "storage.receiving.getReceivingList 接口", "description": "storage.receiving.getReceivingList 接口", "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、status、store_id、日期区间等字段。示例:where.status={operator:eq,value:finished}; where.store_id={operator:eq,value:1001}; where.create_time_start={value:2026-03-01}。" } ], "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_quantity、total_locked、total_available、total_items)" } ] }, { "method": "storage.receiving.getReceivingDetail", "title": "storage.receiving.getReceivingDetail 接口", "description": "storage.receiving.getReceivingDetail 接口", "endpoint": "/system", "authRequired": true, "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" }, { "name": "pagination", "type": "object", "required": true, "description": "明细分页参数,支持 page/pageSize" } ], "response": [ { "name": "receiving", "type": "object", "required": true, "description": "收货单详情(含 details、images、pagination)" }, { "name": "receiving.details", "type": "array", "required": false, "description": "收货单明细列表,单条记录包含明细字段(见下文)" }, { "name": "receiving.details.*.space_id", "type": "string", "required": false, "description": "库位展示名称(string|null)。优先取 custom_space_name,其次取 space_name。兼容说明:该字段历史上为数值库位ID,现已调整为展示名称;原始ID请使用 receiving.details.*.space_id_raw。" }, { "name": "receiving.details.*.space_id_raw", "type": "number", "required": false, "description": "原始库位ID(number|null),用于兼容依赖旧语义(space_id=数字ID)的调用方。" }, { "name": "receiving.details.*.space_name", "type": "string", "required": false, "description": "库位名称/编码(string|null),作为展示名称的回退来源。" }, { "name": "receiving.details.*.custom_space_name", "type": "string", "required": false, "description": "库位自定义名称(string|null,可空)。" }, { "name": "receiving.details.*.box_remainder", "type": "number", "required": false, "description": "箱内剩余数量/零散数量(不满箱时的件数)" }, { "name": "receiving.details.*.box_weight", "type": "number", "required": false, "description": "实测箱重(单位与系统重量一致,如 kg)" } ] }, { "method": "storage.receiving.batchCancelReceiving", "title": "storage.receiving.batchCancelReceiving 接口", "description": "storage.receiving.batchCancelReceiving 接口", "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数组" } ], "response": [ { "name": "message", "type": "string", "required": true, "description": "批量作废处理结果" } ] }, { "method": "storage.receiving.rejectReceiving", "title": "驳回收货单:将已完成(completed)的收货单批量恢复为收货中(receiving),记录驳回人信息和驳回理由。若任意一张收货单状态非 completed,则整批拒绝操作。驳回人信息(reviewer_name、reviewer_employee_id)自动取当前登录用户上下文,无需传入.", "description": "驳回收货单:将已完成(completed)的收货单批量恢复为收货中(receiving),记录驳回人信息和驳回理由。若任意一张收货单状态非 completed,则整批拒绝操作。驳回人信息(reviewer_name、reviewer_employee_id)自动取当前登录用户上下文,无需传入.", "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数组,所有收货单必须属于当前仓库且状态为 completed,否则整批拒绝" }, { "name": "remark", "type": "string", "required": false, "description": "驳回理由,覆盖收货单原备注字段;不传则保留原备注" } ], "response": [ { "name": "count", "type": "number", "required": false, "description": "成功驳回的收货单数量" } ] }, { "method": "storage.receiving.reviewReceiving", "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数组,所有单据必须满足:status=completed、detail_status=all_matched、storage_status=none、store_id 已绑定、is_review=0,否则整批拒绝" } ], "response": [ { "name": "count", "type": "number", "required": false, "description": "成功审核的收货单数量" } ] }, { "method": "storage.receiving.create", "title": "storage.receiving.create 接口", "description": "storage.receiving.create 接口", "endpoint": "/system", "authRequired": true, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "delivery_method", "type": "string", "required": true, "description": "到货方式:truck/express/air_freight/sea_freight/other" }, { "name": "loading_method", "type": "string", "required": true, "description": "装卸方式:with_pallet/without_pallet" }, { "name": "license_plate", "type": "string", "required": false, "description": "车牌号(delivery_method=truck 时建议传)" }, { "name": "tracking_number", "type": "string", "required": false, "description": "物流单号(非 truck/other 场景建议传)" }, { "name": "store_id", "type": "number", "required": false, "description": "货主ID" }, { "name": "total_boxes", "type": "number", "required": false, "description": "总箱数" }, { "name": "total_pallets", "type": "number", "required": false, "description": "总托盘数" }, { "name": "remark", "type": "string", "required": false, "description": "备注" } ], "response": [ { "name": "id", "type": "number", "required": true, "description": "新建收货单ID" }, { "name": "receiving_number", "type": "string", "required": true, "description": "收货单号" } ] }, { "method": "storage.receiving.bindStore", "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": true, "description": "收货单ID" }, { "name": "store_id", "type": "number", "required": true, "description": "货主ID(必须与当前仓库存在有效签约关系)" } ], "response": [ { "name": "data.id", "type": "number", "required": true, "description": "收货单ID" }, { "name": "data.store_id", "type": "number", "required": true, "description": "已绑定的货主ID" }, { "name": "data.store_name", "type": "string", "required": false, "description": "货主名称/签约备注名" }, { "name": "data.status", "type": "string", "required": true, "description": "当前收货单状态" } ] }, { "method": "storage.receiving.bindDetailProduct", "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": "detail_id", "type": "number", "required": true, "description": "收货单明细ID(兼容字段 `id`)" }, { "name": "system_product_id", "type": "number", "required": true, "description": "系统商品ID(`StockWarehouse.id`,且必须属于当前仓库)" } ], "response": [ { "name": "data.detail_id", "type": "number", "required": true, "description": "收货单明细ID" }, { "name": "data.receiving_id", "type": "number", "required": true, "description": "收货单ID" }, { "name": "data.system_product_id", "type": "number", "required": true, "description": "已绑定的系统商品ID" }, { "name": "data.product_name", "type": "string", "required": true, "description": "自动回填的商品名称" } ] }, { "method": "storage.receiving.queryReceivingLogs", "title": "按收货单ID查询操作日志列表(分页),仅返回当前仓库上下文数据", "description": "按收货单ID查询操作日志列表(分页),仅返回当前仓库上下文数据", "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|string", "required": false, "description": "收货单ID(与 receiving_id 二选一)" }, { "name": "receiving_id", "type": "number|string", "required": false, "description": "收货单ID(兼容字段,与 id 二选一)" }, { "name": "page", "type": "number", "required": false, "description": "页码(兼容顶层分页入参)" }, { "name": "pageSize", "type": "number", "required": false, "description": "每页数量(兼容顶层分页入参)" }, { "name": "pagination", "type": "object", "required": false, "description": "分页参数,支持 page / pageSize" } ], "response": [ { "name": "list", "type": "array", "required": true, "description": "日志列表" }, { "name": "pagination", "type": "object", "required": true, "description": "分页信息,包含 page、pageSize、total、totalPages" } ] }, { "method": "storage.receiving.removeItem", "title": "storage.receiving.removeItem 接口", "description": "storage.receiving.removeItem 接口", "endpoint": "/system", "authRequired": true, "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 参数" }, { "name": "item_id", "type": "number", "required": false, "description": "item_id 参数" } ], "response": [] }, { "method": "storage.receiving.save", "title": "修改收货单基础信息。按收货单ID更新当前仓库下收货单的基础字段。", "description": "修改收货单基础信息。按收货单ID更新当前仓库下收货单的基础字段。", "endpoint": "/system", "authRequired": true, "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,按该ID修改当前仓库下的收货单" }, { "name": "delivery_method", "type": "string", "required": false, "description": "到货方式:truck/express/air_freight/sea_freight/other;不传则保持原值" }, { "name": "loading_method", "type": "string", "required": false, "description": "装卸方式:with_pallet/without_pallet;不传则保持原值" }, { "name": "license_plate", "type": "string", "required": false, "description": "车牌号;当 delivery_method=truck 时可更新,其他到货方式会被清空或忽略" }, { "name": "tracking_number", "type": "string", "required": false, "description": "物流单号;当 delivery_method 为 express/air_freight/sea_freight 时可更新,truck/other 场景会被清空或忽略" }, { "name": "store_id", "type": "number", "required": false, "description": "货主ID;若传入,会校验当前仓库下签约关系并同步更新货主名称;传 0/null 可清空货主" }, { "name": "total_boxes", "type": "number", "required": false, "description": "总箱数,默认 0" }, { "name": "total_pallets", "type": "number", "required": false, "description": "总托盘数,默认 0" }, { "name": "remark", "type": "string", "required": false, "description": "备注信息" }, { "name": "status", "type": "string", "required": false, "description": "收货单状态;不传则保持原值" }, { "name": "video_device_id", "type": "string", "required": false, "description": "录像设备ID" } ], "response": [ { "name": "code", "type": "number", "required": true, "description": "业务状态码;200 表示修改成功" }, { "name": "id", "type": "number", "required": true, "description": "修改的收货单ID" }, { "name": "receiving_number", "type": "string", "required": true, "description": "收货单号" }, { "name": "message", "type": "string", "required": true, "description": "结果描述;成功时通常为收货单修改成功" } ] }, { "method": "storage.receiving.get", "title": "storage.receiving.get 接口", "description": "storage.receiving.get 接口", "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": "code", "type": "number", "required": false, "description": "业务状态码,200 表示成功" }, { "name": "message", "type": "string", "required": false, "description": "返回信息" }, { "name": "data", "type": "object", "required": false, "description": "收货单详情对象,包含 details(明细数组)、images 及主表字段" }, { "name": "data.details", "type": "array", "required": false, "description": "收货单明细数组(每项为明细对象)" }, { "name": "data.details.*.box_remainder", "type": "number", "required": false, "description": "箱内剩余数量/零散数量(不满箱时的件数),默认 0" }, { "name": "data.details.*.box_weight", "type": "number", "required": false, "description": "实测箱重(单位与系统重量一致,如 kg),默认 0" } ] }, { "method": "storage.receiving.addDetail", "title": "支持新增可选入参 item;item 有值时按传入字段创建明细(服务端会覆盖 receiving_id 与 creator_id);item 无值时沿原链路创建空白明细。返回的 selectId 与 data.details 语义不变(仍返回新创建明细的 selectId 与更新后的明细列表)。", "description": "支持新增可选入参 item;item 有值时按传入字段创建明细(服务端会覆盖 receiving_id 与 creator_id);item 无值时沿原链路创建空白明细。返回的 selectId 与 data.details 语义不变(仍返回新创建明细的 selectId 与更新后的明细列表)。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "receiving_id", "type": "number", "required": true, "description": "收货单ID" }, { "name": "item", "type": "object", "required": false, "description": "可选:按传入字段创建明细;不传则创建空白明细。item.children 需覆盖以下字段(有则写、无则补齐):actual_quantity, box_quantity, boxes_per_pallet, space_id, system_product_id, box_width, box_height, box_length, box_remainder, box_weight, weight, barcode, product_name, pallet_quantity, receiving_time, production_date, expiry_date, remark, batch_number, product_snapshot。若传入 item,服务端仍会覆盖 receiving_id 与 creator_id。" } ], "response": [ { "name": "code", "type": "number", "required": true, "description": "业务状态码,200 表示添加成功" }, { "name": "message", "type": "string", "required": true, "description": "结果描述,成功时为 '添加成功'" }, { "name": "data.details", "type": "array", "required": true, "description": "收货单明细数组(每项为明细对象)" }, { "name": "data.selectId", "type": "number", "required": true, "description": "新创建的明细ID,用于前端选中" } ] }, { "method": "storage.receiving.deleteDetail", "title": "删除收货单明细并回算统计。仅允许明细创建者在收货中状态删除未入库的明细;服务端从登录用户上下文获取 creator_id(ctx.user.employees_id)与 warehouse_id(ctx.user.store_id)。若关联收货单状态为 completed(已完成)或 cancelled(已取消),接口会返回删除失败(400),不允许删除明细。", "description": "删除收货单明细并回算统计。仅允许明细创建者在收货中状态删除未入库的明细;服务端从登录用户上下文获取 creator_id(ctx.user.employees_id)与 warehouse_id(ctx.user.store_id)。若关联收货单状态为 completed(已完成)或 cancelled(已取消),接口会返回删除失败(400),不允许删除明细。", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [ { "name": "detail_id", "type": "number", "required": true, "description": "收货单明细 ID(必填)" } ], "response": [ { "name": "code", "type": "number", "required": false, "description": "业务状态码,200 表示成功,400/404/500 表示失败" }, { "name": "message", "type": "string", "required": false, "description": "简短的错误或成功信息" }, { "name": "data", "type": "object", "required": false, "description": "成功时返回的结果对象" }, { "name": "data.details", "type": "array", "required": false, "description": "删除后收货单剩余的明细数组。每项字段与 storage.receiving.getReceivingDetail 返回的明细项一致;product_snapshot 为解析后的对象或 null" }, { "name": "data.selectId", "type": "number|null", "required": false, "description": "删除后建议前端选中的明细 ID;无剩余明细时为 null" } ] }, { "method": "storage.receiving.detailChange", "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": true, "description": "收货明细ID" }, { "name": "receiving_id", "type": "number", "required": true, "description": "收货单ID" }, { "name": "actual_quantity", "type": "number", "required": false, "description": "实际收货数量" }, { "name": "batch_number", "type": "string", "required": false, "description": "批次号" }, { "name": "production_date", "type": "string", "required": false, "description": "生产日期(可解析的日期字符串)" }, { "name": "expiry_date", "type": "string", "required": false, "description": "到期日期(可解析的日期字符串)。若早于当前日期,接口会返回 400 并拒绝录入。" }, { "name": "box_quantity", "type": "number", "required": false, "description": "箱数" }, { "name": "boxes_per_pallet", "type": "number", "required": false, "description": "每托盘箱数" }, { "name": "pallet_quantity", "type": "number", "required": false, "description": "托盘数" }, { "name": "space_id", "type": "number", "required": false, "description": "库位 ID(可回写)" }, { "name": "remark", "type": "string", "required": false, "description": "备注" }, { "name": "system_product_id", "type": "number", "required": false, "description": "系统商品 ID(StockWarehouse.id)。若提供,服务端会尝试回填 barcode/weight/箱规/product_name/product_snapshot 等。" }, { "name": "barcode", "type": "string", "required": false, "description": "条码(未传 system_product_id 时可单独更新)" }, { "name": "product_name", "type": "string", "required": false, "description": "商品名称(未传 system_product_id 时可单独更新)" }, { "name": "box_width", "type": "number", "required": false, "description": "箱宽" }, { "name": "box_height", "type": "number", "required": false, "description": "箱高" }, { "name": "box_length", "type": "number", "required": false, "description": "箱长" }, { "name": "box_remainder", "type": "number", "required": false, "description": "箱内剩余数量/零散数量(不满箱时的件数)" }, { "name": "box_weight", "type": "number", "required": false, "description": "实测箱重(单位与系统重量一致,如 kg)" }, { "name": "weight", "type": "number", "required": false, "description": "毛重/重量" } ], "response": [ { "name": "data.id", "type": "number", "required": true, "description": "收货明细 ID" }, { "name": "data.receiving_id", "type": "number", "required": true, "description": "收货单 ID" }, { "name": "data.actual_quantity", "type": "number", "required": false, "description": "实际收货数量" }, { "name": "data.product_name", "type": "string", "required": false, "description": "商品名称" }, { "name": "data.barcode", "type": "string", "required": false, "description": "条码" }, { "name": "data.system_product_id", "type": "number", "required": false, "description": "系统商品 ID" }, { "name": "data.box_remainder", "type": "number", "required": false, "description": "箱内剩余数量/零散数量(不满箱时的件数)" }, { "name": "data.box_weight", "type": "number", "required": false, "description": "实测箱重(单位与系统重量一致,如 kg)" }, { "name": "data.updated_at", "type": "string", "required": false, "description": "记录更新时间(ISO)" } ] }, { "method": "storage.receiving.cancel", "title": "storage.receiving.cancel 接口", "description": "storage.receiving.cancel 接口", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] }, { "method": "storage.receiving.completeReceiving", "title": "storage.receiving.completeReceiving 接口", "description": "storage.receiving.completeReceiving 接口", "endpoint": "/system", "authRequired": false, "loginRequired": true, "status": { "isUsed": false, "isPlaceholder": false }, "headers": [ { "name": "Authorization", "type": "string", "required": true, "description": "Bearer token" } ], "params": [], "response": [] } ] }