Skip to content

CLI commands

Exit codes are part of the versioning contract: scripts can rely on them.

Reports source items whose quantity no longer matches their adjustment history.

Option Default
--limit 1000 Maximum number of source items to report.

Exits 0 when nothing drifts and 1 when any item does. At the limit, it says it is showing the first items and that there may be more.

Writes an opening history row for every source item with stock and no history. See Opening balance.

Option Default
--batch-size 1000 Number of source items locked and written per transaction.

Prints the number of rows written and the request_id they share. Exits 2 when --batch-size is not a whole number of at least 1.

Reports writes made against the frozen cataloginventory_* tables. See Legacy write detection.

Option
--clear Forget every recorded write.
--enable Install the detection triggers.
--disable Drop the detection triggers.

Without options it prints the report and exits 1 while any write is on record. --enable and --disable together exit 1.

Reconciles terminal orders whose reservations were never released, and placements that reserved stock and never saved their order. See Reconciliation and Abandoned placements.

Option Default
--dry-run Report the residues without writing any compensation or moving the mark.
--limit 500 Maximum number of orders, and of abandoned placements, to process.

Exits 0. It reports the orders and the abandoned placements it reconciled, and how many abandoned placements are too recent to repair yet. When a limit is reached it says so; run it again for the rest.

Reports source stock positions that are below their committed reservations. See Oversell detection.

Option Default
--source Filter by source code.
--sku Filter by SKU.
--limit 1000 Maximum number of oversold positions to scan.

Exits 0 when nothing is oversold and 1 when any position is.