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, with a runnable example and the flags it accepts. Each flag is an API field: its type, allowed values and meaning are in the API reference. 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.

Its subgroups have pages of their own:

abandon

Bash
revenexx carts abandon \
    --id ''

Flags: --id <id> --session-key <session-key>

activate

Bash
revenexx carts activate \
    --id ''

Flags: --id <id> --session-key <session-key>

claim

Bash
revenexx carts claim \
    --contact-id '' \
    --session-key a1b2c3d4e5f6

Flags: --contact-id <contact-id> --session-key <session-key> --organization-id <organization-id> --strategy <strategy> --target-cart-id <target-cart-id>

create

Bash
revenexx carts create

Flags: --attribution <attribution> --channel-id <channel-id> --contact-id <contact-id> --currency <currency> --is-current [value] --metadata <metadata> --name <name> --organization-id <organization-id> --session-key <session-key>

delete

Bash
revenexx carts delete \
    --id ''

Flags: --id <id> --session-key <session-key>

get

Bash
revenexx carts get \
    --id ''

Flags: --id <id> --session-key <session-key>

held-codes

Bash
revenexx carts held-codes

Flags: --code <code> --status <status> --limit <limit> --offset <offset>

list

Bash
revenexx carts list

Flags: --id <id> --name <name> --status <status> --contact-id <contact-id> --organization-id <organization-id> --session-key <session-key> --is-guest [value] --channel-id <channel-id> --currency <currency> --is-current [value] --item-count <item-count> --subtotal <subtotal> --discount-total <discount-total> --shipping-total <shipping-total> --tax-total <tax-total> --grand-total <grand-total> --shipping-method <shipping-method> --totals-computed-at <totals-computed-at> --abandoned-at <abandoned-at> --ordered-at <ordered-at> --order-ref <order-ref> --merged-into-cart-id <merged-into-cart-id> --created-at <created-at> --updated-at <updated-at> --limit <limit> --offset <offset> --order <order> --filter <column=value>

maintenance-run

Bash
revenexx carts maintenance-run

Flags: --dry-run [value]

merge

Bash
revenexx carts merge \
    --source-cart-id '' \
    --target-cart-id ''

Flags: --source-cart-id <source-cart-id> --target-cart-id <target-cart-id> --session-key <session-key>

merge-into

Bash
revenexx carts merge-into \
    --id '' \
    --target-cart-id ''

Flags: --id <id> --target-cart-id <target-cart-id> --session-key <session-key>

on-behalf

Bash
revenexx carts on-behalf \
    --contact-id ''

Flags: --contact-id <contact-id> --channel <channel> --channel-id <channel-id> --currency <currency> --name <name> --note <note> --organization-id <organization-id>

order

Bash
revenexx carts order \
    --id ''

Flags: --id <id> --session-key <session-key> --order-ref <order-ref>

reopen

Bash
revenexx carts reopen \
    --id ''

Flags: --id <id> --session-key <session-key>

update

Bash
revenexx carts update \
    --id ''

Flags: --id <id> --session-key <session-key> --attribution <attribution> --channel-id <channel-id> --currency <currency> --discount-lines [discount-lines...] --metadata <metadata> --name <name> --organization-id <organization-id> --shipping-method <shipping-method> --shipping-total <shipping-total> --voucher-codes [voucher-codes...]

vocabularies-get

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

Flags: --name <name>

vocabularies-list

Bash
revenexx carts vocabularies-list

Flags: --filter <column=value>

Was this page helpful?