跳到主要内容

GET 到货统计

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

接口编码所需范围后端接口
inventory.report.arrival-statsinventory:readGET /v1/inventory-report/arrival-stats(comap-srm)

请求参数(query)

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

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

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

请求示例

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

响应 data 字段

字段类型必填说明
metrics4ReportMetricVO[]—指标卡片(到货单数、到货金额、准时到货率、待收货数量)
trend3ReportTrendPointVO[]—到货趋势(primary=计划到货数,secondary=实际到货数)
pie3ReportDistributionVO[]—到货状态分布
funnel3ReportFunnelItemVO[]—到货收货流转漏斗
healthScorestring—健康度评分文本
health4ReportHealthItemVO[]—到货履约健康度
ranks3ReportRankItemVO[]—供应商到货金额排行 TOP5
bars3ReportRankItemVO[]—仓库到货承接量 TOP5
sideRanks3ReportRankItemVO[]—供应商准时到货率 TOP5
timeliness3ReportDistributionVO[]—到货时效分布

错误处理​

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

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

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

← 返回库存报表