Order lists commands
Reference for the `revenexx orderlists` 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 orderlists 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 orderlists <command> --help for the live options.
create
Bash
revenexx orderlists create \
--name Sample name \
--owner-id 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d \
--owner-name Sample owner name
| Flag | Required | Description |
|---|---|---|
--name <name> | — | |
--owner-id <owner-id> | Owning contact. | |
--owner-name <owner-name> | Owner display name (snapshot). | |
--items [items...] | Optional initial positions. | |
--kind <kind> | List kind — one of the tenant's own kinds (GET /orderlists/kinds); defaults to the flagged one, or the market's 'default_kind' setting. | |
--metadata <metadata> | — | |
--organization-id <organization-id> | Owning organization (scopes sharing). | |
--shared [value] | Shared read-only across the organization (default false). |
defaults
Bash
revenexx orderlists defaults
delete
Bash
revenexx orderlists delete \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — |
get
Bash
revenexx orderlists get \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — |
items-create
Bash
revenexx orderlists items-create \
--list-id sample-id \
--name Sample name
| Flag | Required | Description |
|---|---|---|
--list-id <list-id> | — | |
--name <name> | Display name (snapshot). | |
--category-slug <category-slug> | — | |
--cost-center-id <cost-center-id> | Cost center reference (free-text). | |
--custom-sku <custom-sku> | Customer's own article number. | |
--image <image> | — | |
--metadata <metadata> | — | |
--position <position> | Sort order (assigned automatically when omitted). | |
--position-texts [position-texts...] | Per-position notes. | |
--price <price> | Unit price snapshot. | |
--product-id <product-id> | Catalog product (alternative to sku). | |
--quantity <quantity> | Default 1. | |
--sku <sku> | Article SKU (alternative to product_id). | |
--subcategory-slug <subcategory-slug> | — | |
--tax-rate <tax-rate> | — | |
--unit <unit> | — |
items-delete
Bash
revenexx orderlists items-delete \
--list-id sample-id \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--list-id <list-id> | — | |
--id <id> | — |
items-get
Bash
revenexx orderlists items-get \
--list-id sample-id \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--list-id <list-id> | — | |
--id <id> | — |
items-list
Bash
revenexx orderlists items-list \
--list-id sample-id
| Flag | Required | Description |
|---|---|---|
--list-id <list-id> | — | |
--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). |
items-replace
Bash
revenexx orderlists items-replace \
--list-id sample-id \
--items one two three
| Flag | Required | Description |
|---|---|---|
--list-id <list-id> | — | |
--items [items...] | The new full set of positions. |
items-update
Bash
revenexx orderlists items-update \
--list-id sample-id \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--list-id <list-id> | — | |
--id <id> | — | |
--category-slug <category-slug> | — | |
--cost-center-id <cost-center-id> | Cost center reference (free-text). | |
--custom-sku <custom-sku> | Customer's own article number. | |
--image <image> | — | |
--metadata <metadata> | — | |
--name <name> | Display name (snapshot). | |
--position <position> | Sort order (assigned automatically when omitted). | |
--position-texts [position-texts...] | Per-position notes. | |
--price <price> | Unit price snapshot. | |
--product-id <product-id> | Catalog product (alternative to sku). | |
--quantity <quantity> | Default 1. | |
--sku <sku> | Article SKU (alternative to product_id). | |
--subcategory-slug <subcategory-slug> | — | |
--tax-rate <tax-rate> | — | |
--unit <unit> | — |
kinds-create
Bash
revenexx orderlists kinds-create \
--code '' \
--title Sample title
| Flag | Required | Description |
|---|---|---|
--code <code> | — | |
--title <title> | — | |
--description <description> | — | |
--descriptions <descriptions> | — | |
--is-default [value] | Promote this kind; the previous default is demoted. | |
--labels <labels> | — | |
--position <position> | — | |
--tone <tone> | — |
kinds-delete
Bash
revenexx orderlists kinds-delete \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — |
kinds-get
Bash
revenexx orderlists kinds-get \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — |
kinds-list
Bash
revenexx orderlists kinds-list
| Flag | Required | Description |
|---|---|---|
--filter <column=value> | Filter rows by column equality (repeatable). |
kinds-update
Bash
revenexx orderlists kinds-update \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — | |
--description <description> | — | |
--labels <labels> | — | |
--position <position> | — | |
--title <title> | — | |
--tone <tone> | — |
list
Bash
revenexx orderlists list
| Flag | Required | Description |
|---|---|---|
--owner-id <owner-id> | Filter to one owning contact. | |
--organization-id <organization-id> | Filter to one organization. | |
--kind <kind> | Filter by list kind (shopping | label). | |
--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). |
to-cart
Bash
revenexx orderlists to-cart \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — | |
--cart-id <cart-id> | Add to this existing cart. Omit to create one for the list owner and make it their current cart. | |
--currency <currency> | ISO 4217 code for the cart and its lines. Omit to let the carts app decide. | |
--mode <mode> | 'append' adds the positions (the carts app merges a line by product and price, so quantities accumulate); 'replace' makes the list the cart's entire contents. Defaults to the tenant's 'cart_merge_mode' setting. |
to-order
Bash
revenexx orderlists to-order \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — | |
--currency <currency> | ISO 4217 code. Omit to let the orders app apply the market default. | |
--customer-order-number <customer-order-number> | The buyer's own order/PO number. |
update
Bash
revenexx orderlists update \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — | |
--kind <kind> | List kind — one of the tenant's own kinds (GET /orderlists/kinds); defaults to the flagged one, or the market's 'default_kind' setting. | |
--metadata <metadata> | — | |
--name <name> | — | |
--shared [value] | — |
vocabularies-get
Bash
revenexx orderlists vocabularies-get \
--name kinds
| Flag | Required | Description |
|---|---|---|
--name <name> | The vocabulary name — the part after the dot in the qualified id. |
vocabularies-list
Bash
revenexx orderlists vocabularies-list
| Flag | Required | Description |
|---|---|---|
--filter <column=value> | Filter rows by column equality (repeatable). |