{ "generatedAt": "2026-05-16 17:38:39", "generatedAtLocal": "2026-05-16 17:38:39", "source": "remote", "filter": { "platform": { "value": "web", "label": "网页端" }, "project": { "value": "all", "label": "全部" } }, "module": { "name": "库存报表模块", "key": "storage.report", "folder": "storage.report", "interfaceCount": 3 }, "changes": { "fromPreviousSnapshot": { "moduleAdded": false, "moduleRenamed": false, "interfaceChanges": { "addedMethods": [], "deletedMethods": [], "paramsUpdatedMethods": [], "responseUpdatedMethods": [] } } }, "interfaces": [ { "method": "storage.report.search", "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": "where", "type": "object", "required": false, "description": "查询条件对象。支持字段:start_time(闭区间下限)、end_time(闭区间上限)、by_space(是否按库位返回,默认 false)、store_ids(货主ID数组)。仅返回在时间区间内存在流水的数据(无流水键不返回)。" }, { "name": "where.start_time", "type": "string", "required": false, "description": "开始时间,支持字符串/Date;用于闭区间过滤:created_at >= start_time" }, { "name": "where.end_time", "type": "string", "required": false, "description": "结束时间,支持字符串/Date;用于闭区间过滤:created_at <= end_time" }, { "name": "where.by_space", "type": "boolean", "required": false, "description": "是否按库位返回,默认 false。false=按商品+货主聚合(多库位汇总),true=按商品+库位+货主返回;当 where.by_space=true 时,额外返回 space_id、space_name(custom_name 优先,否则使用 space_code)。" }, { "name": "where.store_ids", "type": "array", "required": false, "description": "货主ID数组,用于过滤特定货主(空或未传表示不过滤)" }, { "name": "sort", "type": "object", "required": false, "description": "排序参数对象(请求体 data.sort)。支持 data.sort.sortField / data.sort.sort_field 与 data.sort.sortOrder / data.sort.sort_order;sortField 白名单:begin_total、inbound_total、outbound_total、end_total;sortOrder 支持 ASC / DESC(大小写不敏感);非法字段或顺序将回退默认排序。" }, { "name": "sort.sortField", "type": "string", "required": false, "description": "排序字段(兼容 data.sort.sortField)。白名单:begin_total、inbound_total、outbound_total、end_total;非法值回退默认排序。" }, { "name": "sort.sort_field", "type": "string", "required": false, "description": "排序字段下划线别名(兼容 data.sort.sort_field),规则同 sort.sortField。" }, { "name": "sort.sortOrder", "type": "string", "required": false, "description": "排序方向(兼容 data.sort.sortOrder),支持 ASC / DESC(大小写不敏感);非法值回退默认排序。" }, { "name": "sort.sort_order", "type": "string", "required": false, "description": "排序方向下划线别名(兼容 data.sort.sort_order),规则同 sort.sortOrder。" } ], "response": [ { "name": "data.list", "type": "array", "required": true, "description": "匹配到的报表行列表 已按 sort 规则排序返回。" }, { "name": "data.list[]", "type": "object", "required": true, "description": "单条报表记录字段" } ] }, { "method": "storage.report.export", "title": "提交库存报表导出异步任务(与 storage.report.search 使用相同查询条件),立即返回任务受理信息,不直接返回文件。", "description": "提交库存报表导出异步任务(与 storage.report.search 使用相同查询条件),立即返回任务受理信息,不直接返回文件。", "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": "查询条件对象。支持字段:start_time(闭区间下限)、end_time(闭区间上限)、by_space(是否按库位返回,默认 false)、store_ids(货主ID数组)。仅返回在时间区间内存在流水的数据(无流水键不返回)。" }, { "name": "where.start_time", "type": "string", "required": false, "description": "开始时间,支持字符串/Date;用于闭区间过滤:created_at >= start_time" }, { "name": "where.end_time", "type": "string", "required": false, "description": "结束时间,支持字符串/Date;用于闭区间过滤:created_at <= end_time" }, { "name": "where.by_space", "type": "boolean", "required": false, "description": "是否按库位返回,默认 false。false=按商品+货主聚合(多库位汇总),true=按商品+库位+货主返回;当 where.by_space=true 时,导出汇总 sheet 会额外包含 space_id、space_name。" }, { "name": "where.store_ids", "type": "array", "required": false, "description": "货主ID数组,用于过滤特定货主(空或未传表示不过滤)" }, { "name": "sort", "type": "object", "required": false, "description": "排序参数对象(请求体 data.sort)。支持 data.sort.sortField / data.sort.sort_field 与 data.sort.sortOrder / data.sort.sort_order;sortField 白名单:begin_total、inbound_total、outbound_total、end_total;sortOrder 支持 ASC / DESC(大小写不敏感);非法字段或顺序将回退默认排序。" }, { "name": "sort.sortField", "type": "string", "required": false, "description": "排序字段(兼容 data.sort.sortField)。白名单:begin_total、inbound_total、outbound_total、end_total;非法值回退默认排序。" }, { "name": "sort.sort_field", "type": "string", "required": false, "description": "排序字段下划线别名(兼容 data.sort.sort_field),规则同 sort.sortField。" }, { "name": "sort.sortOrder", "type": "string", "required": false, "description": "排序方向(兼容 data.sort.sortOrder),支持 ASC / DESC(大小写不敏感);非法值回退默认排序。" }, { "name": "sort.sort_order", "type": "string", "required": false, "description": "排序方向下划线别名(兼容 data.sort.sort_order),规则同 sort.sortOrder。" } ], "response": [ { "name": "task_id", "type": "string", "required": true, "description": "导出任务ID,用于后续查询进度。" }, { "name": "status", "type": "string", "required": true, "description": "任务状态,提交受理后初始为 submitted。" }, { "name": "progress", "type": "number", "required": true, "description": "任务进度百分比(0-100)。" }, { "name": "message", "type": "string", "required": true, "description": "任务受理提示信息。" }, { "name": "error", "type": "string", "required": true, "description": "错误信息;受理成功时通常为空字符串。" }, { "name": "result", "type": "object|null", "required": true, "description": "任务结果对象;受理阶段为 null。" }, { "name": "update_time", "type": "number", "required": true, "description": "任务状态更新时间(时间戳)。" } ] }, { "method": "storage.report.exportTaskProgress", "title": "根据 task_id 查询库存报表导出任务进度与结果;status 可能值:submitted/running/success/failed/not_found。", "description": "根据 task_id 查询库存报表导出任务进度与结果;status 可能值:submitted/running/success/failed/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", "type": "string", "required": false, "description": "导出任务ID(下划线写法)。" }, { "name": "taskId", "type": "string", "required": false, "description": "导出任务ID(驼峰写法,兼容别名)。" } ], "response": [ { "name": "task_id", "type": "string", "required": true, "description": "导出任务ID。" }, { "name": "status", "type": "string", "required": true, "description": "任务状态:submitted/running/success/failed/not_found。" }, { "name": "progress", "type": "number", "required": true, "description": "任务进度百分比(0-100)。" }, { "name": "message", "type": "string", "required": true, "description": "任务状态说明。" }, { "name": "error", "type": "string", "required": true, "description": "失败时的错误信息;成功时通常为空字符串。" }, { "name": "download_url", "type": "string", "required": true, "description": "任务成功后返回的下载链接;未完成或失败时为空字符串。" }, { "name": "update_time", "type": "number", "required": true, "description": "任务状态更新时间(时间戳)。" }, { "name": "result", "type": "object|null", "required": true, "description": "任务结果对象(包含导出文件信息);未完成或失败时可能为 null。" } ] } ] }