GET 仓库统计

GET 查询。query 参数见接口参考。

接口编码	所需范围	后端接口
`inventory.report.warehouse-stats`	`inventory:read`	`GET /v1/inventory-report/warehouse-stats`（comap-srm）

请求参数（query）

本接口的 query 参数由后端查询对象整体展开，接口规格未保留各字段的原始类型，故类型列统一显示为 string。实际取值语义见「说明」列，按自然类型传即可（如 "pageNum": 1），服务端会完成转换。

字段	类型	必填	说明
`period`	string	—	统计周期：month、quarter、year
`startDate`	string	—	自定义开始日期，格式 yyyy-MM-dd，与 endDate 配对使用，优先级高于 period
`endDate`	string	—	自定义结束日期，格式 yyyy-MM-dd，与 startDate 配对使用，优先级高于 period
`scope`	string	—	统计范围：all、mine
`keyword`	string	—	物料编码、物料名称、仓库或单号关键字

「必填」仅反映接口规格声明的部分。服务内还有未体现在规格里的校验，标「—」不等于可以不传；租户在主站配置的字段必填不约束本接口。详见必填字段的判定与字段清单与自定义字段。

请求示例

curl -X POST https://open.risemap.cn/v1/api/invoke \
  -H "Authorization: Bearer <访问令牌>" \
  -H "Content-Type: application/json" \
  -d '{
    "apiCode": "inventory.report.warehouse-stats",
    "query": {}
  }'

响应 data 字段

字段	类型	必填	说明
`metrics`4	ReportMetricVO[]	—	指标卡片（启用仓库、库存总金额、本月出入库、平均库容利用率）
`trend`3	ReportTrendPointVO[]	—	出入库金额趋势（primary=入库金额，secondary=出库金额）
`pie`3	ReportDistributionVO[]	—	仓库库容状态分布
`health`4	ReportHealthItemVO[]	—	仓库作业效率数据
`sideRanks`3	ReportRankItemVO[]	—	仓库作业单量排行 TOP5
`ranks`3	ReportRankItemVO[]	—	仓库库存金额排行 TOP5
`bars`3	ReportRankItemVO[]	—	仓库库容利用率排行 TOP5
`comparisons`4	ComparisonItemVO[]	—	仓库周转效率比对
`stocktakeRanks`3	ReportRankItemVO[]	—	仓库盘点准确率排行 TOP5
`durationTrend`4	WarehouseDurationPointVO[]	—	仓库作业耗时趋势（近6个月，入库/出库/盘点平均耗时，单位分钟）
`inboundAvgMinutes`	number	—	入库平均耗时（分钟，趋势窗口内整体平均）
`outboundAvgMinutes`	number	—	出库平均耗时（分钟）
`stocktakeAvgMinutes`	number	—	盘点平均耗时（分钟）
`durationNote`	string	—	平均耗时环比说明，如"平均耗时较上月 -8.6%"，无基数时为"--"

错误处理

响应统一信封 { code, message, data }，code == 200 为成功。以下是本接口可能返回的开放平台层错误：

错误码	说明	可重试
92101	访问凭证无效	否
92201	接口未登记或已停用	否
92202	超出凭证授权范围——本接口需 `inventory:read`	否
92204	绑定员工无此接口的功能权限	否
92203	上游服务调用失败	是
92301	请求过于频繁	是

除此之外，comap-srm 自身的业务校验失败会原样透传其业务码与提示（如字段校验、状态不允许、数据不存在），这类码不在开放平台的号段内，以响应里的 message 为准。完整的平台层错误码见错误码说明。

← 返回库存报表

错误处理​

错误处理