Shipping commands
Reference for the `revenexx shipping` 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 shipping 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 shipping <command> --help for the live options.
carriers-catalog
Bash
revenexx shipping carriers-catalog
carriers-create
Bash
revenexx shipping carriers-create \
--code sample code \
--name Sample name
| Flag | Required | Description |
|---|---|---|
--code <code> | Stable carrier code, unique per tenant (e.g. dhl, dpd, gls). A method whose \ | |
--name <name> | Display name. | |
--countries [countries...] | ISO 3166-1 alpha-2 codes this carrier serves; null or empty = everywhere. ANDed with the method's own restriction. | |
--cutoff-time <cutoff-time> | This carrier's own daily pickup cut-off (HH:MM, UTC). Overrides the tenant's cutoff_time for methods on this carrier — one shop-wide time cannot be both DHL's 16:00 and a forwarder's 12:00. | |
--eta-days-max <eta-days-max> | Transit time upper bound. | |
--eta-days-min <eta-days-min> | Transit time lower bound — used by any method on this carrier that states no ETA of its own. | |
--handling-days <handling-days> | Days needed to make a consignment ready for THIS carrier. Overrides the tenant's handling_days. | |
--labels <labels> | Localized display names keyed by locale (e.g. {de, en}). | |
--metadata <metadata> | Free-form metadata (customer numbers, contract references). | |
--position <position> | Sort order (default 0). | |
--service-level <service-level> | The class of service this row represents (default 'standard'), as a CODE into the tenant's own service levels (GET /shipping/service-levels). One row is one class: a carrier selling both a parcel and an express product is two rows. Deliberately not an enum here — the set is the merchant's, so a fixed list in this contract would make the gateway reject a level they created. | |
--status <status> | Whether this carrier may be quoted (default 'active'). Anything else excludes every method that ships with it from POST /shipping/rates, with a reason. Tracking links are NOT gated on it — a retired carrier's old shipments stay resolvable. | |
--tracking-url-template <tracking-url-template> | Tracking page URL with {tracking_code} where the number goes; {postal_code} and {country} are also substituted, URL-encoded. Null for a carrier with no public tracking page. |
carriers-defaults
Bash
revenexx shipping carriers-defaults
carriers-delete
Bash
revenexx shipping carriers-delete \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — |
carriers-get
Bash
revenexx shipping carriers-get \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — |
carriers-list
Bash
revenexx shipping carriers-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). |
carriers-update
Bash
revenexx shipping carriers-update \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — | |
--code <code> | Stable carrier code, unique per tenant (e.g. dhl, dpd, gls). A method whose \ | |
--countries [countries...] | ISO 3166-1 alpha-2 codes this carrier serves; null or empty = everywhere. ANDed with the method's own restriction. | |
--cutoff-time <cutoff-time> | This carrier's own daily pickup cut-off (HH:MM, UTC). Overrides the tenant's cutoff_time for methods on this carrier — one shop-wide time cannot be both DHL's 16:00 and a forwarder's 12:00. | |
--eta-days-max <eta-days-max> | Transit time upper bound. | |
--eta-days-min <eta-days-min> | Transit time lower bound — used by any method on this carrier that states no ETA of its own. | |
--handling-days <handling-days> | Days needed to make a consignment ready for THIS carrier. Overrides the tenant's handling_days. | |
--labels <labels> | Localized display names keyed by locale (e.g. {de, en}). | |
--metadata <metadata> | Free-form metadata (customer numbers, contract references). | |
--name <name> | Display name. | |
--position <position> | Sort order (default 0). | |
--service-level <service-level> | The class of service this row represents (default 'standard'), as a CODE into the tenant's own service levels (GET /shipping/service-levels). One row is one class: a carrier selling both a parcel and an express product is two rows. Deliberately not an enum here — the set is the merchant's, so a fixed list in this contract would make the gateway reject a level they created. | |
--status <status> | Whether this carrier may be quoted (default 'active'). Anything else excludes every method that ships with it from POST /shipping/rates, with a reason. Tracking links are NOT gated on it — a retired carrier's old shipments stay resolvable. | |
--tracking-url-template <tracking-url-template> | Tracking page URL with {tracking_code} where the number goes; {postal_code} and {country} are also substituted, URL-encoded. Null for a carrier with no public tracking page. |
methods-create
Bash
revenexx shipping methods-create \
--code sample code \
--name Sample name
| Flag | Required | Description |
|---|---|---|
--code <code> | Stable method code, unique per tenant (e.g. standard, express). | |
--name <name> | Display name. | |
--carrier <carrier> | Carrier CODE, kept from before shipping_carriers existed. Looked up in the carrier table when carrier_id is not set, so an existing value keeps working and gains a tracking template; a code nobody maintains is still reported as a plain name. | |
--carrier-id <carrier-id> | The carrier this method ships with. Wins over \ | |
--countries [countries...] | Allowed ISO 3166-1 alpha-2 codes; null or empty = worldwide. | |
--currency <currency> | ISO 4217 code (default EUR). | |
--description <description> | — | |
--enabled [value] | Only enabled methods appear in rate responses (default false). | |
--eta-days-max <eta-days-max> | Delivery-time estimate for the checkout (days, upper bound). | |
--eta-days-min <eta-days-min> | Delivery-time estimate for the checkout (days, lower bound). | |
--free-above <free-above> | Free shipping at or above this order value — wins over every pricing model. | |
--labels <labels> | Localized display names keyed by locale (e.g. {de, en}). | |
--matrix-attribute <matrix-attribute> | Attribute name for matrix_basis 'attribute'. | |
--matrix-basis <matrix-basis> | The measure a matrix method prices over; 'attribute' reads matrix_attribute from the rate request. | |
--metadata <metadata> | Free-form metadata. | |
--position <position> | Sort order in the checkout (default 0). | |
--price <price> | The fixed price (default 0) — ignored for 'free' and 'matrix'. | |
--pricing-type <pricing-type> | Pricing model (default 'fixed'): one price, no price, or tiered over a measure. |
methods-defaults
Bash
revenexx shipping methods-defaults
methods-delete
Bash
revenexx shipping methods-delete \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — |
methods-get
Bash
revenexx shipping methods-get \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — |
methods-list
Bash
revenexx shipping methods-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). |
methods-update
Bash
revenexx shipping methods-update \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — | |
--carrier <carrier> | Carrier CODE, kept from before shipping_carriers existed. Looked up in the carrier table when carrier_id is not set, so an existing value keeps working and gains a tracking template; a code nobody maintains is still reported as a plain name. | |
--carrier-id <carrier-id> | The carrier this method ships with. Wins over \ | |
--code <code> | Stable method code, unique per tenant (e.g. standard, express). | |
--countries [countries...] | Allowed ISO 3166-1 alpha-2 codes; null or empty = worldwide. | |
--currency <currency> | ISO 4217 code (default EUR). | |
--description <description> | — | |
--enabled [value] | Only enabled methods appear in rate responses (default false). | |
--eta-days-max <eta-days-max> | Delivery-time estimate for the checkout (days, upper bound). | |
--eta-days-min <eta-days-min> | Delivery-time estimate for the checkout (days, lower bound). | |
--free-above <free-above> | Free shipping at or above this order value — wins over every pricing model. | |
--labels <labels> | Localized display names keyed by locale (e.g. {de, en}). | |
--matrix-attribute <matrix-attribute> | Attribute name for matrix_basis 'attribute'. | |
--matrix-basis <matrix-basis> | The measure a matrix method prices over; 'attribute' reads matrix_attribute from the rate request. | |
--metadata <metadata> | Free-form metadata. | |
--name <name> | Display name. | |
--position <position> | Sort order in the checkout (default 0). | |
--price <price> | The fixed price (default 0) — ignored for 'free' and 'matrix'. | |
--pricing-type <pricing-type> | Pricing model (default 'fixed'): one price, no price, or tiered over a measure. |
rates
Bash
revenexx shipping rates
| Flag | Required | Description |
|---|---|---|
--at <at> | The instant to evaluate the delivery estimate at (ISO 8601). Omitted: now. Lets a storefront compute the cut-off in its own timezone. | |
--attributes <attributes> | Measure values for attribute matrices, keyed by attribute name. | |
--country <country> | Destination ISO 3166-1 alpha-2 code — checked against method country restrictions. | |
--currency <currency> | Echoed into the rates (default 'EUR'). | |
--market-id <market-id> | Buyer market for tax resolution. Omitted: the market matching \ | |
--order-value <order-value> | Order value (default 0) — drives order_value matrices, and free-above thresholds when no sided value is sent. Read on the basis the tenant's free_above_compares setting declares. | |
--order-value-gross <order-value-gross> | Order value including tax. Compared against free-above thresholds when free_above_compares is 'gross'. | |
--order-value-net <order-value-net> | Order value excluding tax. Compared against free-above thresholds when free_above_compares is 'net'. | |
--quantity <quantity> | Total quantity — measure for quantity matrices. | |
--weight <weight> | Total weight — measure for weight matrices. Read in weight_unit and converted to the unit the tiers are keyed in. | |
--weight-unit <weight-unit> | The unit \ |
service-levels-create
Bash
revenexx shipping service-levels-create \
--code '' \
--title Sample title
| Flag | Required | Description |
|---|---|---|
--code <code> | — | |
--title <title> | — | |
--description <description> | — | |
--descriptions <descriptions> | — | |
--is-default [value] | Promote this value; the previous default is demoted. | |
--labels <labels> | — | |
--position <position> | — | |
--tone <tone> | — |
service-levels-delete
Bash
revenexx shipping service-levels-delete \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — |
service-levels-get
Bash
revenexx shipping service-levels-get \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — |
service-levels-list
Bash
revenexx shipping service-levels-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). |
service-levels-update
Bash
revenexx shipping service-levels-update \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — | |
--description <description> | — | |
--descriptions <descriptions> | — | |
--is-default [value] | — | |
--labels <labels> | — | |
--position <position> | — | |
--title <title> | — | |
--tone <tone> | — |
tiers-create
Bash
revenexx shipping tiers-create \
--method-id sample-id
| Flag | Required | Description |
|---|---|---|
--method-id <method-id> | — | |
--from-value <from-value> | Tier threshold (default 0) — the tier with the highest from_value at or below the measured value wins. | |
--position <position> | Sort order (default 0; bulk replace derives it from the array index). | |
--price <price> | Price of this tier (default 0). |
tiers-delete
Bash
revenexx shipping tiers-delete \
--method-id sample-id \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--method-id <method-id> | — | |
--id <id> | — |
tiers-get
Bash
revenexx shipping tiers-get \
--method-id sample-id \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--method-id <method-id> | — | |
--id <id> | — |
tiers-ladder
Bash
revenexx shipping tiers-ladder \
--method-id sample-id \
--base-price 9.99 \
--step 9.99 \
--to-value 9.99
| Flag | Required | Description |
|---|---|---|
--method-id <method-id> | — | |
--base-price <base-price> | Price of the first tier. | |
--step <step> | Distance between two tiers. Must be > 0. | |
--to-value <to-value> | Last tier threshold. The final tier keeps applying above it — a matrix has no upper bound. | |
--from-value <from-value> | First tier threshold (default 0), in the method's matrix measure. | |
--replace [value] | Replace the whole table (default true) or append to it. | |
--step-price <step-price> | Added to each subsequent tier (default 0). A negative value is allowed as long as no tier ends up below 0. |
tiers-list
Bash
revenexx shipping tiers-list \
--method-id sample-id
| Flag | Required | Description |
|---|---|---|
--method-id <method-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). |
tiers-replace
Bash
revenexx shipping tiers-replace \
--method-id sample-id \
--tiers one two three
| Flag | Required | Description |
|---|---|---|
--method-id <method-id> | — | |
--tiers [tiers...] | The complete new tier set (set semantics) — positions are derived from the array order. |
tiers-update
Bash
revenexx shipping tiers-update \
--method-id sample-id \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--method-id <method-id> | — | |
--id <id> | — | |
--from-value <from-value> | Tier threshold (default 0) — the tier with the highest from_value at or below the measured value wins. | |
--position <position> | Sort order (default 0; bulk replace derives it from the array index). | |
--price <price> | Price of this tier (default 0). |
tracking
Bash
revenexx shipping tracking \
--carrier sample carrier
| Flag | Required | Description |
|---|---|---|
--carrier <carrier> | Carrier code (what an order shipment already stores) or the carrier row id. | |
--country <country> | Destination ISO 3166-1 alpha-2 code — only needed by a template that names {country}. Upper-cased before substitution. | |
--postal-code <postal-code> | Destination postcode — only needed by a template that names {postal_code}. | |
--tracking-code <tracking-code> | The carrier's tracking number. Required by every template that names {tracking_code}, which is all of them in the shipped catalog. |
vocabularies-get
Bash
revenexx shipping vocabularies-get \
--name carrier-statuses
| Flag | Required | Description |
|---|---|---|
--name <name> | The vocabulary name — the part after the dot in the qualified id. |
vocabularies-list
Bash
revenexx shipping vocabularies-list
| Flag | Required | Description |
|---|---|---|
--filter <column=value> | Filter rows by column equality (repeatable). |
weight-units-create
Bash
revenexx shipping weight-units-create \
--code '' \
--factor 9.99 \
--title Sample title
| Flag | Required | Description |
|---|---|---|
--code <code> | — | |
--factor <factor> | How many BASE units (kilograms) one of this unit weighs — a tonne is 1000, a gram 0.001, a pound 0.45359237. This number prices parcels: every weight matrix converts a request through it. Must be > 0; the base unit is fixed at 1 and rejects a change. | |
--title <title> | — | |
--description <description> | — | |
--descriptions <descriptions> | — | |
--is-default [value] | Promote this value; the previous default is demoted. | |
--labels <labels> | — | |
--position <position> | — | |
--tone <tone> | — |
weight-units-delete
Bash
revenexx shipping weight-units-delete \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — |
weight-units-get
Bash
revenexx shipping weight-units-get \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — |
weight-units-list
Bash
revenexx shipping weight-units-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). |
weight-units-update
Bash
revenexx shipping weight-units-update \
--id sample-id
| Flag | Required | Description |
|---|---|---|
--id <id> | — | |
--description <description> | — | |
--descriptions <descriptions> | — | |
--factor <factor> | How many BASE units (kilograms) one of this unit weighs — a tonne is 1000, a gram 0.001, a pound 0.45359237. This number prices parcels: every weight matrix converts a request through it. Must be > 0; the base unit is fixed at 1 and rejects a change. | |
--is-default [value] | — | |
--labels <labels> | — | |
--position <position> | — | |
--title <title> | — | |
--tone <tone> | — |