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 ''
| Flag | Required | Description |
|---|---|---|
--id <id> | The cart, by its id — the \ |
activate
Bash
revenexx carts activate \
--id ''
| Flag | Required | Description |
|---|---|---|
--id <id> | The cart, by its id — the \ |
claim
Bash
revenexx carts claim \
--contact-id '' \
--session-key a1b2c3d4e5f6
| Flag | Required | Description |
|---|---|---|
--contact-id <contact-id> | The contact taking ownership. Every active cart of that session ends up with this contact — adopted as it stands, or folded into \ | |
--session-key <session-key> | The guest session whose active carts are handed over — the key the storefront keeps in its own session or cookie and has been sending on every anonymous call. This app neither issues nor parses it, so the example shows the shape of an opaque token and not a format anything enforces. | |
--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> | The sales channel this cart is being opened in, as a channel of the channels app. Stored for attribution; nothing in this app reads it. | |
--contact-id <contact-id> | The customer who owns this cart, as a contact of the customers app. Send this OR session_key — a cart with neither owner is refused. | |
--currency <currency> | ISO 4217 code the cart is priced in (default EUR). Lines added without a currency inherit it. | |
--is-current [value] | Make this THE current cart of its owner as it is created — the same thing carts.activate does later, and it clears the flag on every sibling cart of the same owner. | |
--metadata <metadata> | Free-form data the storefront hangs on the cart. Stored and returned verbatim; no key in here is read by this app, and none is indexed. | |
--name <name> | What the buyer calls this cart (default 'Cart'). An empty string is legal and lands on the default. | |
--session-key <session-key> | The guest session that owns this cart — the key the storefront already keeps in its own session or cookie. Any non-empty string is accepted; this app issues none and parses none, so the example shows a shape and not a format. Send this OR contact_id. |
delete
Bash
revenexx carts delete \
--id ''
| Flag | Required | Description |
|---|---|---|
--id <id> | The cart, by its id — the \ |
get
Bash
revenexx carts get \
--id ''
| Flag | Required | Description |
|---|---|---|
--id <id> | The cart, by its id — the \ |
list
Bash
revenexx carts list
| Flag | Required | Description |
|---|---|---|
--id <id> | One cart, in list form — the same row carts.get answers, but inside the page envelope. | |
--name <name> | Exact name, not a search: 'Weekly' does not find 'Weekly order'. Useful with contact_id, to resume a named cart a buyer keeps. | |
--status <status> | By lifecycle status — the abandoned queue, the ordered ones, the merged trail. | |
--contact-id <contact-id> | Every cart of one customer. With multi_cart_enabled this is a list, not a row. | |
--session-key <session-key> | Every cart of one guest session — what a storefront asks for before anybody logs in, and what carts.claim then hands over. | |
--channel-id <channel-id> | Carts opened in one sales channel. | |
--currency <currency> | Carts priced in one currency. | |
--is-current [value] | The owner's current cart — the flag carts.activate sets, and the only way to read what it wrote. Pair it with contact_id or session_key; on its own it selects every current cart in the tenant. | |
--item-count <item-count> | Exact total quantity. \ | |
--subtotal <subtotal> | Exact subtotal. Equality only — there is no range form on this route, so this finds \ | |
--abandoned-at <abandoned-at> | Exact instant, not a range. Of little use on its own; \ | |
--ordered-at <ordered-at> | Exact instant, not a range. \ | |
--order-ref <order-ref> | The cart behind an order number — the join order management and support both need. | |
--merged-into-cart-id <merged-into-cart-id> | Every cart that was merged INTO this one: the other half of the trail, and the answer to "what did this cart absorb". | |
--created-at <created-at> | Exact instant, not a range: this matches a timestamp to the microsecond, so it is for reproducing a row, not for reporting on a day. | |
--updated-at <updated-at> | Exact instant, not a range. Idleness is the sweep's business, not a filter's. | |
--limit <limit> | Page size (default 50, max 200). | |
--offset <offset> | Row offset for pagination (default 0). | |
--order <order> | Sort by one column: 'column' | 'column.asc' | 'column.desc'. A bare column sorts ascending. Anything else is refused with 400. | |
--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 '' \
--target-cart-id ''
| Flag | Required | Description |
|---|---|---|
--source-cart-id <source-cart-id> | The cart being folded in. It must be active, and it does NOT survive as a workspace: its lines are copied into the target, it becomes status merged, and merged_into_cart_id points at the target. Its own lines stay on it as the record of what was moved. | |
--target-cart-id <target-cart-id> | The cart that SURVIVES. Must be active; it gains the source's lines (identical product lines at the same price adding up) and its totals are recomputed. |
merge-into
Bash
revenexx carts merge-into \
--id '' \
--target-cart-id ''
| Flag | Required | Description |
|---|---|---|
--id <id> | The SOURCE cart — the one whose lines move and which becomes status merged. | |
--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 ''
| Flag | Required | Description |
|---|---|---|
--id <id> | The cart, by its id — the \ | |
--order-ref <order-ref> | The order number this cart becomes, in order management's own numbering. Stored on the cart — filtering on it is how anyone gets from an order back to the cart behind it — and it is also the reference the stock reservation is booked under. Omit it and the cart id is used for the reservation instead. |
reopen
Bash
revenexx carts reopen \
--id ''
| Flag | Required | Description |
|---|---|---|
--id <id> | The cart, by its id — the \ |
update
Bash
revenexx carts update \
--id ''
| Flag | Required | Description |
|---|---|---|
--id <id> | The cart, by its id — the \ | |
--channel-id <channel-id> | Move the cart to another sales channel. | |
--currency <currency> | ISO 4217 code. Changes what NEW lines inherit; lines already in the cart keep the currency they were added with. | |
--metadata <metadata> | Free-form data the storefront hangs on the cart. Stored and returned verbatim; no key in here is read by this app, and none is indexed. | |
--name <name> | Rename the cart. Unlike on create, this is written verbatim — \ |
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). |