Carts commands

Reference for the `revenexx carts` 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 carts 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 carts <command> --help for the live options.

abandon

Bash

revenexx carts abandon \
    --id sample-id

Flag	Required	Description
`--id <id>`		—

activate

Bash

revenexx carts activate \
    --id sample-id

Flag	Required	Description
`--id <id>`		—

claim

Bash

revenexx carts claim \
    --contact-id 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d \
    --session-key sample session key

Flag	Required	Description
`--contact-id <contact-id>`		Contact taking ownership.
`--session-key <session-key>`		Guest session whose active carts are handed over.
`--strategy <strategy>`		Override the tenant's cart_merge_strategy for this call: 'merge' keeps the target cart's own lines, 'replace' clears them first. Omit to use the setting.
`--target-cart-id <target-cart-id>`		Merge the session carts into this cart instead of adopting them.

create

Bash

revenexx carts create

Flag	Required	Description
`--channel-id <channel-id>`		—
`--contact-id <contact-id>`		Owning customer contact.
`--currency <currency>`		ISO 4217 code (default EUR).
`--is-current [value]`		Make this THE current cart of its owner.
`--metadata <metadata>`		Free-form metadata.
`--name <name>`		Display name (default 'Cart').
`--session-key <session-key>`		Owning guest session.

delete

Bash

revenexx carts delete \
    --id sample-id

Flag	Required	Description
`--id <id>`		—

export

Bash

revenexx carts export \
    --id sample-id

Flag	Required	Description
`--id <id>`		—
`--format <format>`		Ad-hoc export format (only without profile_id).
`--profile-id <profile-id>`		Export profile to run; ad-hoc JSON/CSV export when omitted.

get

Bash

revenexx carts get \
    --id sample-id

Flag	Required	Description
`--id <id>`		—

import

Bash

revenexx carts import

Flag	Required	Description
`--contact-id <contact-id>`		Owner of a newly created cart.
`--csv <csv>`		Raw CSV content (alternative to payload for csv profiles).
`--name <name>`		Name for a newly created cart.
`--payload <payload>`		The import payload: '{cart, items}' object, or a raw JSON/CSV string in the profile's format.
`--profile-id <profile-id>`		Import profile to run; ad-hoc import when omitted.
`--session-key <session-key>`		Guest owner of a newly created cart.
`--target-cart-id <target-cart-id>`		Existing active cart to import into.

io-profiles-create

Bash

revenexx carts io-profiles-create \
    --direction import \
    --name Sample name

Flag	Required	Description
`--direction <direction>`		—
`--name <name>`		—
`--apply-mode <apply-mode>`		Default 'insert'.
`--entity <entity>`		Default 'carts'.
`--format <format>`		Default 'json'.
`--is-template [value]`		—
`--mapping <mapping>`		Column mapping (Baseline-IO-compatible).
`--options <options>`		—

io-profiles-defaults

Bash

revenexx carts io-profiles-defaults

io-profiles-delete

Bash

revenexx carts io-profiles-delete \
    --id sample-id

Flag	Required	Description
`--id <id>`		—

io-profiles-get

Bash

revenexx carts io-profiles-get \
    --id sample-id

Flag	Required	Description
`--id <id>`		—

io-profiles-list

Bash

revenexx carts io-profiles-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).

io-profiles-update

Bash

revenexx carts io-profiles-update \
    --id sample-id

Flag	Required	Description
`--id <id>`		—
`--apply-mode <apply-mode>`		Default 'insert'.
`--direction <direction>`		—
`--entity <entity>`		Default 'carts'.
`--format <format>`		Default 'json'.
`--is-template [value]`		—
`--mapping <mapping>`		Column mapping (Baseline-IO-compatible).
`--name <name>`		—
`--options <options>`		—

items-create

Bash

revenexx carts items-create \
    --cart-id sample-id

Flag	Required	Description
`--cart-id <cart-id>`		—
`--configuration <configuration>`		Free-form configuration — configured lines never merge.
`--currency <currency>`		Defaults to the cart's currency.
`--metadata <metadata>`		Free-form metadata.
`--name <name>`		Falls back to 'sku' when omitted.
`--position <position>`		—
`--product-id <product-id>`		—
`--quantity <quantity>`		Default 1.
`--sku <sku>`		—
`--snapshot <snapshot>`		Loose product snapshot at add-time (price, name, image, …).
`--tax-rate <tax-rate>`		—
`--type <type>`		Line type (default 'product'). Plain product lines merge by product+price; configurations always stand alone.
`--unit <unit>`		—
`--unit-price <unit-price>`		Per-unit net price — line_total is always derived.

items-delete

Bash

revenexx carts items-delete \
    --cart-id sample-id \
    --id sample-id

Flag	Required	Description
`--cart-id <cart-id>`		—
`--id <id>`		—

items-get

Bash

revenexx carts items-get \
    --cart-id sample-id \
    --id sample-id

Flag	Required	Description
`--cart-id <cart-id>`		—
`--id <id>`		—

items-list

Bash

revenexx carts items-list \
    --cart-id sample-id

Flag	Required	Description
`--cart-id <cart-id>`		—
`--sku <sku>`		Filter by exact SKU.
`--product-id <product-id>`		Filter to one product.
`--type <type>`		Filter by line type (exact match).
`--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).

items-replace

Bash

revenexx carts items-replace \
    --cart-id sample-id \
    --items one two three

Flag	Required	Description
`--cart-id <cart-id>`		—
`--items [items...]`		The complete new item set (set semantics).

items-update

Bash

revenexx carts items-update \
    --cart-id sample-id \
    --id sample-id

Flag	Required	Description
`--cart-id <cart-id>`		—
`--id <id>`		—
`--configuration <configuration>`		Free-form configuration — configured lines never merge.
`--currency <currency>`		Defaults to the cart's currency.
`--metadata <metadata>`		Free-form metadata.
`--name <name>`		Falls back to 'sku' when omitted.
`--position <position>`		—
`--product-id <product-id>`		—
`--quantity <quantity>`		Default 1.
`--sku <sku>`		—
`--snapshot <snapshot>`		Loose product snapshot at add-time (price, name, image, …).
`--tax-rate <tax-rate>`		—
`--type <type>`		Line type (default 'product'). Plain product lines merge by product+price; configurations always stand alone.
`--unit <unit>`		—
`--unit-price <unit-price>`		Per-unit net price — line_total is always derived.

list

Bash

revenexx carts list

Flag	Required	Description
`--contact-id <contact-id>`		Filter to one owning contact.
`--session-key <session-key>`		Filter to one guest session.
`--status <status>`		Filter by cart status (e.g. active).
`--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).

maintenance-run

Bash

revenexx carts maintenance-run

Flag	Required	Description
`--dry-run [value]`		Report what the sweep WOULD do and write nothing. Worth doing before a first retention run: cart_ttl_days deletes carts and their lines.

merge

Bash

revenexx carts merge \
    --source-cart-id 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d \
    --target-cart-id 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d

Flag	Required	Description
`--source-cart-id <source-cart-id>`		Cart whose lines move into the target (becomes status merged).
`--target-cart-id <target-cart-id>`		Receiving cart (must be active).

merge-into

Bash

revenexx carts merge-into \
    --id sample-id \
    --target-cart-id 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d

Flag	Required	Description
`--id <id>`		—
`--target-cart-id <target-cart-id>`		Receiving cart (must be active). The cart in the path is the source and becomes status merged.

order

Bash

revenexx carts order \
    --id sample-id

Flag	Required	Description
`--id <id>`		—
`--order-ref <order-ref>`		External order reference from order management.

reopen

Bash

revenexx carts reopen \
    --id sample-id

Flag	Required	Description
`--id <id>`		—

update

Bash

revenexx carts update \
    --id sample-id

Flag	Required	Description
`--id <id>`		—
`--channel-id <channel-id>`		—
`--currency <currency>`		ISO 4217 code.
`--metadata <metadata>`		Free-form metadata.
`--name <name>`		—

vocabularies-get

Bash

revenexx carts vocabularies-get \
    --name io-apply-modes

Flag	Required	Description
`--name <name>`		The vocabulary name — the part after the dot in the qualified id.

vocabularies-list

Bash

revenexx carts vocabularies-list

Flag	Required	Description
`--filter <column=value>`		Filter rows by column equality (repeatable).

Was this page helpful?