Orders commands

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

acknowledge

Bash

revenexx orders acknowledge \
    --id ''

Flags: --id <id> --external-id <external-id> --external-ref <external-ref> --external-refs <external-refs> --source-data <source-data> --source-synced-at <source-synced-at>

approve

Bash

revenexx orders approve \
    --id ''

Flags: --id <id>

cancel

Bash

revenexx orders cancel \
    --id ''

Flags: --id <id> --cancelled-by <cancelled-by> --reason <reason>

comments-create

Bash

revenexx orders comments-create \
    --id '' \
    --body Called the customer, delivery agreed for next week.

Flags: --id <id> --body <body> --author <author> --visibility <visibility>

comments-list

Bash

revenexx orders comments-list \
    --id ''

Flags: --id <id> --id-query <id-query> --body <body> --visibility <visibility> --author <author> --created-at <created-at> --limit <limit> --offset <offset> --order <order> --filter <column=value>

complete

Bash

revenexx orders complete \
    --id ''

Flags: --id <id> --completed-by <completed-by>

events-list

Bash

revenexx orders events-list \
    --id ''

Flags: --id <id> --id-query <id-query> --name <name> --actor <actor> --idempotency-key <idempotency-key> --created-at <created-at> --limit <limit> --offset <offset> --order <order> --filter <column=value>

get

Bash

revenexx orders get \
    --id ''

Flags: --id <id>

hold

Bash

revenexx orders hold \
    --id ''

Flags: --id <id> --reason <reason>

items-cancel

Bash

revenexx orders items-cancel \
    --id '' \
    --positions one two three

Flags: --id <id> --positions [positions...] --cancelled-by <cancelled-by> --reason <reason>

list

Bash

revenexx orders list

Flags: --id <id> --number <number> --customer-order-number <customer-order-number> --external-ref <external-ref> --acknowledged-at <acknowledged-at> --cart-id <cart-id> --contact-id <contact-id> --organization-id <organization-id> --channel-id <channel-id> --currency <currency> --status <status> --payment-status <payment-status> --fulfillment-status <fulfillment-status> --on-hold [value] --hold-reason <hold-reason> --item-count <item-count> --subtotal <subtotal> --discount-total <discount-total> --shipping-total <shipping-total> --shipping-tax-rate <shipping-tax-rate> --shipping-tax-amount <shipping-tax-amount> --payment-fee-amount <payment-fee-amount> --payment-fee-tax-rate <payment-fee-tax-rate> --payment-fee-tax-amount <payment-fee-tax-amount> --tax-total <tax-total> --grand-total <grand-total> --placed-at <placed-at> --placed-on <placed-on> --completed-at <completed-at> --cancelled-at <cancelled-at> --cancellation-kind <cancellation-kind> --cancelled-by <cancelled-by> --cancellation-reason <cancellation-reason> --external-id <external-id> --source-synced-at <source-synced-at> --requested-delivery-date <requested-delivery-date> --utm-campaign <utm-campaign> --campaign-ref <campaign-ref> --created-at <created-at> --updated-at <updated-at> --limit <limit> --offset <offset> --order <order> --filter <column=value>

migrations-requested-delivery-date

Bash

revenexx orders migrations-requested-delivery-date

Flags: --cursor <cursor> --limit <limit>

number-ranges-create

Bash

revenexx orders number-ranges-create \
    --code order

Flags: --code <code> --active [value] --channel-id <channel-id> --counter <counter> --labels <labels> --metadata <metadata> --padding <padding> --position-step <position-step> --prefix <prefix> --step <step> --suffix <suffix> --title <title>

number-ranges-defaults

Bash

revenexx orders number-ranges-defaults

number-ranges-delete

Bash

revenexx orders number-ranges-delete \
    --id ''

Flags: --id <id>

number-ranges-get

Bash

revenexx orders number-ranges-get \
    --id ''

Flags: --id <id>

number-ranges-list

Bash

revenexx orders number-ranges-list

Flags: --id <id> --code <code> --prefix <prefix> --suffix <suffix> --padding <padding> --counter <counter> --step <step> --position-step <position-step> --title <title> --active [value] --channel-id <channel-id> --created-at <created-at> --updated-at <updated-at> --limit <limit> --offset <offset> --order <order> --filter <column=value>

number-ranges-update

Bash

revenexx orders number-ranges-update \
    --id ''

Flags: --id <id> --active [value] --channel-id <channel-id> --code <code> --counter <counter> --labels <labels> --metadata <metadata> --padding <padding> --position-step <position-step> --prefix <prefix> --step <step> --suffix <suffix> --title <title>

payment-status-update

Bash

revenexx orders payment-status-update \
    --id '' \
    --status open

Flags: --id <id> --status <status> --payment-id <payment-id> --transaction-reference <transaction-reference>

place

Bash

revenexx orders place \
    --items one two three

Flags: --items [items...] --attribution <attribution> --billing-address <billing-address> --buyer <buyer> --cart-id <cart-id> --channel-id <channel-id> --contact-id <contact-id> --currency <currency> --customer-order-number <customer-order-number> --external-id <external-id> --external-refs <external-refs> --grand-total <grand-total> --metadata <metadata> --organization-id <organization-id> --payment <payment> --requested-delivery-date <requested-delivery-date> --sender-country <sender-country> --shipping <shipping> --shipping-address <shipping-address> --shipping-total <shipping-total> --source-data <source-data> --source-synced-at <source-synced-at> --user-data <user-data>

reject

Bash

revenexx orders reject \
    --id '' \
    --reason Over the quarterly budget for this cost centre

Flags: --id <id> --reason <reason>

reports-customer-rollup

Bash

revenexx orders reports-customer-rollup

Flags: --as-of <as-of> --cursor <cursor> --organization-ids [organization-ids...] --statuses [statuses...]

return

Bash

revenexx orders return \
    --id ''

Flags: --id <id> --external-id <external-id> --external-refs <external-refs> --metadata <metadata> --positions [positions...] --reason <reason> --reason-code <reason-code> --restock [value] --source-data <source-data> --source-synced-at <source-synced-at>

return-reasons-get

Bash

revenexx orders return-reasons-get \
    --id ''

Flags: --id <id>

return-reasons-list

Bash

revenexx orders return-reasons-list

Flags: --id <id> --code <code> --title <title> --description <description> --is-default [value] --tone <tone> --position <position> --is-system [value] --active [value] --created-at <created-at> --updated-at <updated-at> --limit <limit> --offset <offset> --order <order> --filter <column=value>

returnable

Bash

revenexx orders returnable \
    --id ''

Flags: --id <id>

returns-complete

Bash

revenexx orders returns-complete \
    --id '' \
    --rid ''

Flags: --id <id> --rid <rid> --resolution <resolution>

returns-list

Bash

revenexx orders returns-list

Flags: --id <id> --order-id <order-id> --number <number> --status <status> --reason-code <reason-code> --reason <reason> --registered-at <registered-at> --received-at <received-at> --completed-at <completed-at> --rejected-at <rejected-at> --resolution <resolution> --refund-mode <refund-mode> --refund-total <refund-total> --discount-returned <discount-returned> --external-id <external-id> --source-synced-at <source-synced-at> --created-at <created-at> --updated-at <updated-at> --organization-id <organization-id> --limit <limit> --offset <offset> --order <order> --filter <column=value>

returns-receive

Bash

revenexx orders returns-receive \
    --id '' \
    --rid '' \
    --data '{ "key": "value" }'

Flags: --id <id> --rid <rid> --body <body>

returns-reject

Bash

revenexx orders returns-reject \
    --id '' \
    --rid ''

Flags: --id <id> --rid <rid> --reason <reason> --resolution <resolution>

ship

Bash

revenexx orders ship \
    --id ''

Flags: --id <id> --carrier <carrier> --carrier-code <carrier-code> --external-id <external-id> --external-refs <external-refs> --metadata <metadata> --number <number> --positions [positions...] --shipped-at <shipped-at> --source-data <source-data> --source-synced-at <source-synced-at> --tracking-code <tracking-code> --tracking-url <tracking-url>

shipments-mark-delivered

Bash

revenexx orders shipments-mark-delivered \
    --id ''

Flags: --id <id> --delivered-at <delivered-at> --note <note>

shippable

Bash

revenexx orders shippable \
    --id ''

Flags: --id <id>

unhold

Bash

revenexx orders unhold \
    --id '' \
    --data '{ "key": "value" }'

Flags: --id <id> --body <body>

update

Bash

revenexx orders update \
    --id ''

Flags: --id <id> --billing-address <billing-address> --buyer <buyer> --customer-order-number <customer-order-number> --external-id <external-id> --external-refs <external-refs> --metadata <metadata> --requested-delivery-date <requested-delivery-date> --sender-country <sender-country> --shipping-address <shipping-address> --source-data <source-data> --source-synced-at <source-synced-at> --user-data <user-data>

vocabularies-get

Bash

revenexx orders vocabularies-get \
    --name cancellation-kinds

Flags: --name <name>

vocabularies-list

Bash

revenexx orders vocabularies-list

Flags: --filter <column=value>

Was this page helpful?