Skip to main content
Manufacturing API (Roadmap)roadmap

Roadmap: Manufacturing Reports

Planned: read-only reports (job costing, by-products, production cost analysis, efficiency) with 5-minute server-side cache.

Status

Public API: not yet exposed. Internal HTTP surface: live at /manufacturing-reports/*. gRPC layer: manufacturingReports.grpc.controller.js.

These are aggregation endpoints — the internal surface caches results for 5 minutes (per org+entity) and busts the cache on Work Order writes. The public API will keep the same caching semantics.

Planned endpoints

MethodPlanned pathActionPlanned scope
GET/orgs/:o/entities/:e/manufacturing-reports/job-costingJob costing summary across recent Work OrdersmanufacturingReport:read
GET/orgs/:o/entities/:e/manufacturing-reports/by-productsBy-products produced from completed runsmanufacturingReport:read
GET/orgs/:o/entities/:e/manufacturing-reports/cost-analysisProduction cost analysismanufacturingReport:read
GET/orgs/:o/entities/:e/manufacturing-reports/efficiencyProduction efficiency metricsmanufacturingReport:read

Caching behavior

Each report endpoint sits behind a Redis cache keyed manufacturingReport:<orgId>:<entityId>:<reportName> with a 5-minute TTL. Work Order writes (release/complete/cancel) invalidate the entire manufacturingReport:<orgId>:<entityId>: prefix.

Practical implication for clients: don't poll these endpoints at sub-minute intervals — you'll get the same cached payload back. Subscribe to work_order.completed (when manufacturing webhooks ship) and re-fetch on event.

    Roadmap: HelloBooks Manufacturing Reports API