Inventories commands
Reference for the `revenexx inventories` commands — every subcommand with a runnable example.
Auto-generated. This page is generated from the revenexx CLI by
tools/sync-cli-reference.mjs. Don't edit it by hand — your changes will be overwritten.
Every revenexx inventories subcommand. The example shows the required arguments; the options table lists every flag the command accepts, with a ✓ marking required flags. Some flag names carry a -_ (e.g. --attribute-_values) — that is the exact token the CLI accepts, so copy them verbatim. Run revenexx inventories <command> --help for the live options.
adjust
Bash
revenexx inventories adjust
| Flag | Required | Description |
|---|---|---|
--items [items...] | The corrections — quantities are SIGNED deltas (at most 200). | |
--location-code <location-code> | Adjusted location (default: the default_location_code setting). | |
--product-id <product-id> | Inline single-item form: the product to move. | |
--quantity <quantity> | Inline single-item form: the SIGNED correction (negative removes stock). | |
--reason <reason> | Audit reason for the correction. Mandatory unless movement_reason_required is 'none'. | |
--sku <sku> | Inline single-item form: the SKU to move (alternative to product_id). |
availability
Bash
revenexx inventories availability
| Flag | Required | Description |
|---|---|---|
--items [items...] | The items to check (batch, at most 200). | |
--location-code <location-code> | Restrict the check to one location (default: all enabled locations). | |
--product-id <product-id> | Inline single-item form: the product to move. | |
--quantity <quantity> | Requested quantity for the orderable check (default 1). | |
--sku <sku> | Inline single-item form: the SKU to move (alternative to product_id). |
commit
Bash
revenexx inventories commit \
--order-ref sample order ref
| Flag | Required | Description |
|---|---|---|
--order-ref <order-ref> | The order whose active reservations are committed (shipment). |
locations-create
Bash
revenexx inventories locations-create \
--code sample code \
--name Sample name
| Flag | Required | Description |
|---|---|---|
--code <code> | Unique location code (per tenant). | |
--name <name> | — | |
--address <address> | — | |
--enabled [value] | Disabled locations are skipped by availability and reserve (default true). | |
--labels <labels> | Localised display names ({de, en, …}). | |
--metadata <metadata> | Free-form metadata. | |
--priority <priority> | Sourcing order — lower wins (default 0). | |
--type <type> | Default 'warehouse'. |
locations-defaults
Bash
revenexx inventories locations-defaults
locations-delete
Bash
revenexx inventories locations-delete \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — |
locations-get
Bash
revenexx inventories locations-get \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — |
locations-list
Bash
revenexx inventories locations-list
| Flag | Required | Description |
|---|---|---|
--limit <limit> | Page size (default 50, max 200). | |
--offset <offset> | Row offset for pagination (default 0). | |
--order <order> | Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'. | |
--filter <column=value> | Filter rows by column equality (repeatable). |
locations-update
Bash
revenexx inventories locations-update \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — | |
--address <address> | — | |
--code <code> | Unique location code (per tenant). | |
--enabled [value] | Disabled locations are skipped by availability and reserve (default true). | |
--labels <labels> | Localised display names ({de, en, …}). | |
--metadata <metadata> | Free-form metadata. | |
--name <name> | — | |
--priority <priority> | Sourcing order — lower wins (default 0). | |
--type <type> | Default 'warehouse'. |
movements-get
Bash
revenexx inventories movements-get \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — |
movements-list
Bash
revenexx inventories movements-list
| Flag | Required | Description |
|---|---|---|
--limit <limit> | Page size (default 50, max 200). | |
--offset <offset> | Row offset for pagination (default 0). | |
--order <order> | Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'. | |
--filter <column=value> | Filter rows by column equality (repeatable). |
receive
Bash
revenexx inventories receive
| Flag | Required | Description |
|---|---|---|
--items [items...] | The inbound items (at most 200). | |
--location-code <location-code> | Receiving location (default: the default_location_code setting). | |
--product-id <product-id> | Inline single-item form: the product to move. | |
--quantity <quantity> | Inline single-item form: the quantity received. | |
--reason <reason> | Ledger note (e.g. delivery note number). Mandatory when movement_reason_required is 'all'. | |
--sku <sku> | Inline single-item form: the SKU to move (alternative to product_id). |
release
Bash
revenexx inventories release \
--order-ref sample order ref
| Flag | Required | Description |
|---|---|---|
--order-ref <order-ref> | The order whose active reservations are released. |
reorder-alerts
Bash
revenexx inventories reorder-alerts
reservations-get
Bash
revenexx inventories reservations-get \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — |
reservations-list
Bash
revenexx inventories reservations-list
| Flag | Required | Description |
|---|---|---|
--limit <limit> | Page size (default 50, max 200). | |
--offset <offset> | Row offset for pagination (default 0). | |
--order <order> | Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'. | |
--filter <column=value> | Filter rows by column equality (repeatable). |
reservations-sweep
Bash
revenexx inventories reservations-sweep \
--data '{ "key": "value" }'
| Flag | Required | Description |
|---|---|---|
--data <data> | Request body |
reserve
Bash
revenexx inventories reserve \
--order-ref sample order ref
| Flag | Required | Description |
|---|---|---|
--order-ref <order-ref> | The order this reservation belongs to. | |
--expires-at <expires-at> | Reservation expiry. Omit to let reservation_ttl_minutes stamp one; the sweeper releases whatever is past its deadline. | |
--items [items...] | The items to reserve (at most 200). | |
--location-code <location-code> | Fallback location for a backordered item that has no stock row anywhere (default: the default_location_code setting). | |
--product-id <product-id> | Inline single-item form: the product to move. | |
--quantity <quantity> | Inline single-item form: the quantity to reserve. | |
--ship-to <ship-to> | — | |
--sku <sku> | Inline single-item form: the SKU to move (alternative to product_id). |
restock
Bash
revenexx inventories restock
| Flag | Required | Description |
|---|---|---|
--items [items...] | The returned items (at most 200). | |
--location-code <location-code> | Restocking location (default: the default_location_code setting). | |
--order-ref <order-ref> | Originating order (ledger reference). | |
--product-id <product-id> | Inline single-item form: the product to move. | |
--quantity <quantity> | Inline single-item form: the quantity returned. | |
--reason <reason> | Ledger note (e.g. return reason). Mandatory when movement_reason_required is 'all'. | |
--restock [value] | Do the goods rejoin sellable stock? Omit to follow the restock_on_return_default setting. false records the decision and moves nothing. | |
--sku <sku> | Inline single-item form: the SKU to move (alternative to product_id). |
stock-adjust
Bash
revenexx inventories stock-adjust \
--id sample-id \
--quantity 9.99
| Flag | Required | Description |
|---|---|---|
--id <id> | — | |
--quantity <quantity> | Signed correction (negative removes stock). Must be non-zero. | |
--reason <reason> | Audit reason. Mandatory unless movement_reason_required is 'none'. |
stock-create
Bash
revenexx inventories stock-create \
--location-id 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d
| Flag | Required | Description |
|---|---|---|
--location-id <location-id> | Owning location. | |
--metadata <metadata> | Free-form metadata. 'backorder: true' opts this item into backorders when backorder_policy is 'allow_per_sku'. | |
--product-id <product-id> | Tracked product. | |
--reorder-point <reorder-point> | Low-stock threshold — see GET /inventories/reorder-alerts. | |
--sku <sku> | Tracked SKU (alternative to product_id). |
stock-delete
Bash
revenexx inventories stock-delete \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — |
stock-get
Bash
revenexx inventories stock-get \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — |
stock-list
Bash
revenexx inventories stock-list
| Flag | Required | Description |
|---|---|---|
--limit <limit> | Page size (default 50, max 200). | |
--offset <offset> | Row offset for pagination (default 0). | |
--order <order> | Sort as 'column.asc' | 'column.desc', e.g. 'created_at.desc'. | |
--filter <column=value> | Filter rows by column equality (repeatable). |
stock-update
Bash
revenexx inventories stock-update \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — | |
--location-id <location-id> | Owning location. | |
--metadata <metadata> | Free-form metadata. 'backorder: true' opts this item into backorders when backorder_policy is 'allow_per_sku'. | |
--product-id <product-id> | Tracked product. | |
--reorder-point <reorder-point> | Low-stock threshold — see GET /inventories/reorder-alerts. | |
--sku <sku> | Tracked SKU (alternative to product_id). |
vocabularies-get
Bash
revenexx inventories vocabularies-get \
--name location-types
| Flag | Required | Description |
|---|---|---|
--name <name> | The vocabulary name — the part after the dot in the qualified id. |
vocabularies-list
Bash
revenexx inventories vocabularies-list
| Flag | Required | Description |
|---|---|---|
--filter <column=value> | Filter rows by column equality (repeatable). |