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

acknowledge

Bash

revenexx orders acknowledge \
    --id sample-id

Flag	Required	Description
`--id <id>`		—
`--external-ref <external-ref>`		The fulfilling system's order reference (e.g. the ERP order number).

cancel

Bash

revenexx orders cancel \
    --id sample-id

Flag	Required	Description
`--id <id>`		—
`--cancelled-by <cancelled-by>`		Acting user/system.
`--reason <reason>`		Why. Mandatory when the tenant sets 'cancel_requires_reason'.

comments-create

Bash

revenexx orders comments-create \
    --id sample-id \
    --body sample body

Flag	Required	Description
`--id <id>`		—
`--body <body>`		—
`--author <author>`		—
`--visibility <visibility>`		Default 'internal'.

comments-list

Bash

revenexx orders comments-list \
    --id sample-id

Flag	Required	Description
`--id <id>`		—
`--visibility <visibility>`		Filter by visibility (exact match).
`--author <author>`		Filter by exact author.
`--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).

complete

Bash

revenexx orders complete \
    --id sample-id

Flag	Required	Description
`--id <id>`		—
`--completed-by <completed-by>`		Who closed the order — carried in the order.completed event.

events-list

Bash

revenexx orders events-list \
    --id sample-id

Flag	Required	Description
`--id <id>`		—
`--name <name>`		Filter by exact event name (e.g. 'order.shipment.created').
`--actor <actor>`		Filter by exact actor.
`--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).

get

Bash

revenexx orders get \
    --id sample-id

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

hold

Bash

revenexx orders hold \
    --id sample-id

Flag	Required	Description
`--id <id>`		—
`--reason <reason>`		Why the order is blocked (shown on the shipping guard).

items-cancel

Bash

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

Flag	Required	Description
`--id <id>`		—
`--positions [positions...]`		—
`--cancelled-by <cancelled-by>`		Acting user/system.
`--reason <reason>`		Why. Mandatory when the tenant sets 'cancel_requires_reason'.

list

Bash

revenexx orders list

Flag	Required	Description
`--status <status>`		Filter by order status (exact match).
`--payment-status <payment-status>`		Filter by payment status (exact match).
`--fulfillment-status <fulfillment-status>`		Filter by fulfillment status (exact match).
`--contact-id <contact-id>`		Filter to one ordering contact.
`--organization-id <organization-id>`		Filter to one B2B organization.
`--channel-id <channel-id>`		Filter to one sales channel.
`--number <number>`		Filter by exact order number.
`--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).

number-ranges-create

Bash

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

Flag	Required	Description
`--code <code>`		Range key drawn by the app ('order', 'delivery', 'return') — unique per tenant.
`--channel-id <channel-id>`		—
`--counter <counter>`		Current counter value (default 0) — the next number draws counter+step.
`--metadata <metadata>`		Free-form metadata.
`--padding <padding>`		Zero-padding width of the counter (default 6).
`--position-step <position-step>`		Position numbering increment for order items (default 10).
`--prefix <prefix>`		Default ''.
`--step <step>`		Counter increment per drawn number (default 1).
`--suffix <suffix>`		Default ''.

number-ranges-defaults

Bash

revenexx orders number-ranges-defaults

number-ranges-delete

Bash

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

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

number-ranges-get

Bash

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

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

number-ranges-list

Bash

revenexx orders number-ranges-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).

number-ranges-update

Bash

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

Flag	Required	Description
`--id <id>`		—
`--channel-id <channel-id>`		—
`--code <code>`		Range key drawn by the app ('order', 'delivery', 'return') — unique per tenant.
`--counter <counter>`		Current counter value (default 0) — the next number draws counter+step.
`--metadata <metadata>`		Free-form metadata.
`--padding <padding>`		Zero-padding width of the counter (default 6).
`--position-step <position-step>`		Position numbering increment for order items (default 10).
`--prefix <prefix>`		Default ''.
`--step <step>`		Counter increment per drawn number (default 1).
`--suffix <suffix>`		Default ''.

payment-status-update

Bash

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

Flag	Required	Description
`--id <id>`		—
`--status <status>`		The new payment dimension value.
`--payment-id <payment-id>`		Reference into the payment system — merged into the order's payment snapshot.

place

Bash

revenexx orders place \
    --items one two three

Flag	Required	Description
`--items [items...]`		The order positions (at most 500).
`--billing-address <billing-address>`		Frozen billing address.
`--buyer <buyer>`		Frozen buyer snapshot (name, email, …).
`--cart-id <cart-id>`		Source cart (the carts.order hand-over).
`--channel-id <channel-id>`		—
`--contact-id <contact-id>`		Ordering customer contact.
`--currency <currency>`		ISO 4217 code (default EUR).
`--customer-order-number <customer-order-number>`		The buyer's own order/PO number.
`--grand-total <grand-total>`		Override — computed as subtotal + shipping + tax when omitted.
`--metadata <metadata>`		Free-form metadata.
`--organization-id <organization-id>`		B2B organization.
`--payment <payment>`		Frozen payment snapshot — a known 'payment.status' seeds payment_status (otherwise 'open').
`--shipping <shipping>`		Frozen shipping snapshot — 'shipping.price' seeds shipping_total.
`--shipping-address <shipping-address>`		Frozen shipping address.
`--shipping-total <shipping-total>`		Shipping total (fallback when 'shipping.price' is absent).
`--user-data <user-data>`		Free-form user data.

reports-customer-rollup

Bash

revenexx orders reports-customer-rollup

Flag	Required	Description
`--as-of <as-of>`		Anchor for the rolling windows (default now). Pin it and send it back on every call of a loop, otherwise the windows drift by the duration of the loop.
`--cursor <cursor>`		Continue an unfinished scan: the value a previous call returned. Ignored shape-wise when organization_ids is given, which always answers completely.
`--organization-ids [organization-ids...]`		Roll up exactly these organizations (at most 200 — the ids travel as an in.() filter). Omitted = every organization that appears on an order.
`--statuses [statuses...]`		Order statuses that count as revenue (default placed, in_fulfillment, completed — a pending order was never placed, a cancelled one is not revenue).

return

Bash

revenexx orders return \
    --id sample-id

Flag	Required	Description
`--id <id>`		—
`--metadata <metadata>`		Free-form metadata.
`--positions [positions...]`		Omitted = every position with a returnable quantity, in full.
`--reason <reason>`		—
`--restock [value]`		Default restock flag for positions that carry none — the only way to say "put it all back into stock" when the positions are defaulted.

returns-complete

Bash

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

Flag	Required	Description
`--id <id>`		—
`--rid <rid>`		—
`--resolution <resolution>`		How the return was settled (refund, replacement, …).

returns-receive

Bash

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

Flag	Required	Description
`--id <id>`		—
`--rid <rid>`		—
`--data <data>`		Request body

returns-reject

Bash

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

Flag	Required	Description
`--id <id>`		—
`--rid <rid>`		—
`--reason <reason>`		Fallback for 'resolution'.
`--resolution <resolution>`		Why the return was rejected.

ship

Bash

revenexx orders ship \
    --id sample-id

Flag	Required	Description
`--id <id>`		—
`--carrier <carrier>`		—
`--metadata <metadata>`		Free-form metadata.
`--number <number>`		Delivery note number — drawn from the 'delivery' range when omitted.
`--positions [positions...]`		Omitted = every position with open quantity, in full.
`--shipped-at <shipped-at>`		Defaults to now.
`--tracking-code <tracking-code>`		—
`--tracking-url <tracking-url>`		—

unhold

Bash

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

Flag	Required	Description
`--id <id>`		—
`--data <data>`		Request body

update

Bash

revenexx orders update \
    --id sample-id

Flag	Required	Description
`--id <id>`		—
`--billing-address <billing-address>`		—
`--buyer <buyer>`		—
`--customer-order-number <customer-order-number>`		—
`--metadata <metadata>`		Free-form metadata.
`--shipping-address <shipping-address>`		—
`--user-data <user-data>`		Free-form user data.

vocabularies-get

Bash

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

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

vocabularies-list

Bash

revenexx orders vocabularies-list

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

Was this page helpful?