Promotions: redemptions commands

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

commit

Bash

revenexx promotions-redemptions commit \
    --order-id ''

Flags: --order-id <order-id> --cart-id <cart-id> --contact-id <contact-id> --currency <currency> --market <market> --order-number <order-number> --organization-id <organization-id> --promotions [promotions...] --redeemed-by <redeemed-by> --terms <terms>

get

Bash

revenexx promotions-redemptions get \
    --id ''

Flags: --id <id>

list

Bash

revenexx promotions-redemptions list

Flags: --limit <limit> --offset <offset> --order <order> --id <id> --promotion-id <promotion-id> --voucher-id <voucher-id> --voucher-code <voucher-code> --batch-id <batch-id> --cart-id <cart-id> --order-id <order-id> --order-number <order-number> --contact-id <contact-id> --organization-id <organization-id> --redeemed-by <redeemed-by> --state <state> --filter <column=value>

release

Bash

revenexx promotions-redemptions release

Flags: --cart-id <cart-id> --order-id <order-id> --reason <reason>

reserve

Bash

revenexx promotions-redemptions reserve \
    --cart-id ''

Flags: --cart-id <cart-id> --contact-id <contact-id> --currency <currency> --from-cart-id <from-cart-id> --organization-id <organization-id> --promotions [promotions...] --redeemed-by <redeemed-by>

returns

Bash

revenexx promotions-redemptions returns \
    --order-id ''

Flags: --order-id <order-id> --all [value] --lines [lines...] --remaining-amounts <remaining-amounts> --remaining-lines [remaining-lines...] --return-ref <return-ref>

sweep

Bash

revenexx promotions-redemptions sweep

Was this page helpful?