104 lines
3.2 KiB
JSON
104 lines
3.2 KiB
JSON
{
|
||
"generatedAt": "2026-05-15 17:32:36",
|
||
"generatedAtLocal": "2026-05-15 17:32:36",
|
||
"source": "remote",
|
||
"filter": {
|
||
"platform": {
|
||
"value": "web",
|
||
"label": "网页端"
|
||
},
|
||
"project": {
|
||
"value": "all",
|
||
"label": "全部"
|
||
}
|
||
},
|
||
"module": {
|
||
"name": "库存报表模块",
|
||
"key": "storage.report",
|
||
"folder": "storage.report",
|
||
"interfaceCount": 1
|
||
},
|
||
"changes": {
|
||
"fromPreviousSnapshot": {
|
||
"moduleAdded": true,
|
||
"moduleRenamed": false,
|
||
"interfaceChanges": {
|
||
"addedMethods": [
|
||
"storage.report.search"
|
||
],
|
||
"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数组,用于过滤特定货主(空或未传表示不过滤)"
|
||
}
|
||
],
|
||
"response": [
|
||
{
|
||
"name": "data.list",
|
||
"type": "array",
|
||
"required": true,
|
||
"description": "匹配到的报表行列表"
|
||
},
|
||
{
|
||
"name": "data.list[]",
|
||
"type": "object",
|
||
"required": true,
|
||
"description": "单条报表记录字段"
|
||
}
|
||
]
|
||
}
|
||
]
|
||
}
|