Skip to content

API Reference

theGreenGuy edited this page Jun 3, 2026 · 2 revisions

API Reference

Everything is reached through the gateway (port 8080) at /api/<service>/**. Contracts live in contracts/openapi/ and are structurally validated in CI.

Gateway routes

Path prefix Service
/api/master-data/** master-data
/api/inventory/** inventory
/api/orders/** order-management
/api/allocation/** allocation
/api/slotting/** slotting
/api/gtp/** gtp (goods-to-person stations)
/api/flow/** flow-orchestrator
/api/process/** process-engine
/api/txlog/** txlog
/api/iam/** iam
/api/notification/** notification
/api/integration/sap/** integration-sap
/api/integration/manhattan/** integration-manhattan
/api/host/** integration-host (canonical Host API)

OpenAPI specs

Spec Service
master-data.yaml catalog, outbound config, dispatch reference data, label render
inventory.yaml stock, availability, reservations
order-management.yaml orders, lifecycle, line transactions
allocation.yaml allocation, cubing, batches
gtp.yaml goods-to-person stations, work cycles, put-to-light
flow-orchestrator.yaml device tasks
txlog.yaml append + global replay feed
iam.yaml users, roles, permissions
host-api.yaml the canonical Host API
integration-sap.yaml / integration-manhattan.yaml vendor adapters

Browse the specs →

Events

Movement events are appended to txlog and streamed on the Kafka topic txlog.stream: GoodsReceived, PutawayCompleted / StockMoved, Picked, StockAdjusted, StockStatusChanged. Consumers dedupe on eventId. (Avro / Schema Registry: planned.)

Related: Host Integration · Services.

Clone this wiki locally