> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stateset.com/llms.txt
> Use this file to discover all available pages before exploring further.

# StateSet Warehouse (WMS)

> Physical inventory and warehouse execution: receiving, putaway, allocation, picking, packing, transfers, returns, and carrier handoff.

StateSet Warehouse is the warehouse management system for physical inventory and execution.
It tracks which facility, bin, SKU, lot, and order owns stock as goods move through receiving,
storage, picking, packing, carrier handoff, and returns.

**Sync is the OMS; Warehouse is the WMS; Freight is the TMS.** Sync supplies commercial
orders, Warehouse records physical work, and Freight plans and executes transportation.
The embedded iCommerce warehouse APIs are a separate surface; see the
[embedded receiving example](/guides/warehouse-quickstart) for that contract.

> **[Run Warehouse locally](/stateset-warehouse/quickstart)**
>
> Start Postgres, open the synthetic workspace, and inspect your first facility.

> **[REST and MCP](/stateset-warehouse/api-and-mcp)**
>
> Authenticate, read stock and work, and preserve original command requests.

## Warehouse work

| Workflow | Supported behavior |
| - | - |
| Facilities and catalog | Multiple facilities, products, receiving/storage/staging locations, and facility timezones |
| Receiving and putaway | Expected receipts, partial receiving, over-receipt protection, bin moves, and scanner validation |
| Inventory controls | Physical/reserved/usable balances, lot expiry, independent quarantine holds, serial custody, and reviewed pack conversions |
| Fulfillment | Source-linked or manual orders, line-owned reservations, available-stock allocation, backorders, partial picks, packages, and physical handoffs |
| Recovery | Unpick and reallocation, blocking exceptions, reasoned counts, and closure of an unshipped remainder after physical recovery |
| Transfers | Source dispatch, goods in transit, partial destination arrivals, confirmed loss, and capped loss reversal |
| Customer returns | Exact original shipment-line/lot allowances; received returns enter receiving before reviewed putaway |
| Operations | Movement ledger, reconciliation, paginated history, CSV exports, delivery queues, and administrator metrics |
| iCommerce interoperability | Typed move/product previews and inventory projections using pinned engine types; canonical WMS commands remain the sole stock writer |

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 port
`3012` 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](/stateset-warehouse/api-and-mcp#commands-and-recovery)
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](/guides/oms-wms-tms).

## 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 against `stateset-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.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.