Run Warehouse locally
Start Postgres, open the synthetic workspace, and inspect your first facility.
REST and MCP
Authenticate, read stock and work, and preserve original command requests.
Warehouse work
Quantities remain whole each units. Case, inner-pack, and pallet inputs retain their
reviewed conversion and original definition. Fractional measured units are not implemented.
Receiving stock becomes allocatable after it reaches storage; expired or quarantined stock
retains physical custody while being held from new fulfillment.
Interfaces and access
The Rust API uses PostgreSQL and serves the React dashboard. Development uses dashboard port3012 and API port 8088; a built dashboard can be served by the API itself.
The repository also includes a terminal application and a native HTTP MCP endpoint at /mcp.
API keys map to a server-owned tenant, actor, and role. Optional WorkOS AuthKit sign-in maps
verified memberships to explicit WMS tenants and roles. Viewers inspect work, operators
execute warehouse tasks, administrators also manage facilities/catalog/counts, and the
oms role has restricted source-linked order permissions.
Every physical command records its original request and result. Preserve the original actor,
facility, body, request ID, and reviewed versions across uncertain responses. Read the
command and recovery contract
before building a client.
Connect the operation
Warehouse can import canonical Sync orders and create a source-verified planned load in Freight through explicitly configured native adapters. Conditional OMS fulfillment requires the separately deployed companion receiver and an explicit opt-in. Generic WMS events need compatible consumers; they are not interchangeable with another service’s event API. Follow the OMS → WMS → TMS integration guide.Deployment scope
The source describes local software qualification, restore exercises, and synthetic workload checks. Real inventory, scanners, facility acceptance, deployed identity providers, cross-service mappings, and production capacity need separate qualification. Carrier purchasing and refunds are outside the WMS. Inter-facility transfers do not automatically create Freight loads or commercial fulfillments. This guide was checked againststateset-warehouse on October 20, 2026, including its
README.md, docs/api.md, docs/mcp.md, and docs/native-integrations.md. Repository
access is required for the source build; the reviewed release notes do not claim published
packages or images.