kf inventory
Inspect and adjust inventory.
Read-only inventory levels plus the canonical adjust + transfer create commands.
kf inventory levels
List inventory levels via authenticated GraphQL.
Filters by variant or location. Read-only.
| Flag | Required | Description |
|---|---|---|
--tenant <id> | yes | Target tenant id. |
--environment <id> | no | Target environment id. |
--variant <id> | no | Filter by variant id. |
--location <id> | no | Filter by location id. |
--limit <n> | no | Result cap, default 20. |
Example
kf inventory levels --tenant tnt_demo --location loc_edisonkf inventory contracts
List canonical inventory IO public contracts.
Local read-only manifest view of InventorySource, InventorySignal, InventoryHistory, and InventoryExport contracts with schema refs, MCP discovery tool, and reverse-domain extension namespace rules.
| Flag | Required | Description |
|---|---|---|
| `--contract <InventorySource | InventorySignal | InventoryHistory |
Example
kf inventory contracts --contract InventorySignal --prettykf inventory adjust
Adjust on_hand, reserved, or allocated quantity on an inventory level.
Idempotent via --idempotency-key. Adjusts a single bucket with optimistic concurrency via --expected-version.
| Flag | Required | Description |
|---|---|---|
--tenant <id> | yes | Target tenant id. |
--inventory-level-id <id> | yes | Target inventory level id. |
| `--quantity-type <ON_HAND | RESERVED | ALLOCATED>` |
--delta <n> | yes | Signed delta to apply. |
--expected-version <n> | yes | Optimistic concurrency token. |
--actor-type <type> | yes | Actor type (USER, AGENT, API_KEY, SYSTEM). |
--actor-id <id> | yes | Actor id. |
--reason <code> | no | Domain reason code. |
--idempotency-key <key> | no | Idempotency key for safe retries. |
Example
kf inventory adjust --tenant tnt_demo --inventory-level-id il_01 --quantity-type ON_HAND --delta -1 --expected-version 4 --actor-type USER --actor-id usr_samkf inventory transfer create
Kick off a stock transfer between two locations.
Decreases available at the source by moving quantity into in-transit. Idempotent via --idempotency-key.
| Flag | Required | Description |
|---|---|---|
--tenant <id> | yes | Target tenant id. |
--transfer-ref <ref> | yes | Tenant-supplied transfer reference. |
--variant <id> | yes | Variant id. |
--from-location <id> | yes | Source location id. |
--to-location <id> | yes | Destination location id. |
--owner-id <id> | yes | Inventory owner id. |
--from-level-id <id> | yes | Source inventory level id. |
--to-level-id <id> | yes | Destination inventory level id. |
--quantity <n> | yes | Quantity to move. |
--actor-type <type> | yes | Actor type. |
--actor-id <id> | yes | Actor id. |
--reason <code> | no | Domain reason code. |
--ship-by <iso> | no | Ship-by ISO timestamp. |
--expected-delivery <iso> | no | Expected delivery ISO timestamp. |
--carrier <name> | no | Carrier name. |
--tracking-ref <ref> | no | Carrier tracking reference. |
--idempotency-key <key> | no | Idempotency key for safe retries. |
Example
kf inventory transfer create --tenant tnt_demo --transfer-ref T-1 --variant v_01 --from-location loc_a --to-location loc_b --owner-id own_01 --from-level-id il_a --to-level-id il_b --quantity 5 --actor-type USER --actor-id usr_sam