@commercelayer/cli-plugin-orders
Advanced tools
Commerce Layer CLI Orders plugin
$ cl-orders COMMAND
$ cl-orders (-v | version | --version) to check the version of the CLI you have installed.
$ cl-orders [COMMAND] (--help | -h) for detailed information about CLI commands.
To install as a Commerce Layer CLI plugin run the following command:
$ commercelayer plugins:install orders
cl-orders orders IDcl-orders orders:approve IDcl-orders orders:approve_and_capture IDcl-orders orders:archive IDcl-orders orders:authorization_amount_cents IDcl-orders orders:authorize IDcl-orders orders:billing_address_clone_id IDcl-orders orders:billing_address_same_as_shipping IDcl-orders orders:cancel IDcl-orders orders:capture IDcl-orders orders:customer_payment_source_id IDcl-orders orders:place IDcl-orders orders:refresh IDcl-orders orders:refund IDcl-orders orders:save_billing_address_to_customer_address_book IDcl-orders orders:save_payment_source_to_customer_wallet IDcl-orders orders:save_shipping_address_to_customer_address_book IDcl-orders orders:shipping_address_clone_id IDcl-orders orders:shipping_address_same_as_billing IDcl-orders orders:unarchive IDcl-orders orders:update_taxes IDcl-orders orders IDExecute an action on an order.
USAGE
$ cl-orders orders ID
ARGUMENTS
ID the unique id of the order
OPTIONS
-o, --organization=organization (required) the slug of your organization
See code: src/commands/orders/index.ts
cl-orders orders:approve IDSend this attribute if you want to approve a placed order..
USAGE
$ cl-orders orders:approve ID
ARGUMENTS
ID the unique id of the order
OPTIONS
-o, --organization=organization (required) the slug of your organization
See code: src/commands/orders/approve.ts
cl-orders orders:approve_and_capture IDSend this attribute if you want to approve and capture a placed order..
USAGE
$ cl-orders orders:approve_and_capture ID
ARGUMENTS
ID the unique id of the order
OPTIONS
-o, --organization=organization (required) the slug of your organization
See code: src/commands/orders/approve_and_capture.ts
cl-orders orders:archive IDSend this attribute if you want to archive the order..
USAGE
$ cl-orders orders:archive ID
ARGUMENTS
ID the unique id of the order
OPTIONS
-o, --organization=organization (required) the slug of your organization
See code: src/commands/orders/archive.ts
cl-orders orders:authorization_amount_cents IDThe authorization amount, in cents..
USAGE
$ cl-orders orders:authorization_amount_cents ID
ARGUMENTS
ID the unique id of the order
OPTIONS
-o, --organization=organization (required) the slug of your organization
See code: src/commands/orders/authorization_amount_cents.ts
cl-orders orders:authorize IDSend this attribute if you want to authorize the order's payment source..
USAGE
$ cl-orders orders:authorize ID
ARGUMENTS
ID the unique id of the order
OPTIONS
-o, --organization=organization (required) the slug of your organization
See code: src/commands/orders/authorize.ts
cl-orders orders:billing_address_clone_id IDThe id of the address that you want to clone to create the order's billing address..
USAGE
$ cl-orders orders:billing_address_clone_id ID
ARGUMENTS
ID the unique id of the order
OPTIONS
-o, --organization=organization (required) the slug of your organization
-v, --value=value (required) the trigger attribute value
See code: src/commands/orders/billing_address_clone_id.ts
cl-orders orders:billing_address_same_as_shipping IDSend this attribute if you want the billing address to be cloned from the order's shipping address..
USAGE
$ cl-orders orders:billing_address_same_as_shipping ID
ARGUMENTS
ID the unique id of the order
OPTIONS
-o, --organization=organization (required) the slug of your organization
See code: src/commands/orders/billing_address_same_as_shipping.ts
cl-orders orders:cancel IDSend this attribute if you want to cancel a placed order. The order's authorization will be automatically voided..
USAGE
$ cl-orders orders:cancel ID
ARGUMENTS
ID the unique id of the order
OPTIONS
-o, --organization=organization (required) the slug of your organization
See code: src/commands/orders/cancel.ts
cl-orders orders:capture IDSend this attribute if you want to capture an approved order..
USAGE
$ cl-orders orders:capture ID
ARGUMENTS
ID the unique id of the order
OPTIONS
-o, --organization=organization (required) the slug of your organization
See code: src/commands/orders/capture.ts
cl-orders orders:customer_payment_source_id IDThe id of the customer payment source (i.e. credit card) that you want to use as the order's payment source..
USAGE
$ cl-orders orders:customer_payment_source_id ID
ARGUMENTS
ID the unique id of the order
OPTIONS
-o, --organization=organization (required) the slug of your organization
-v, --value=value (required) the trigger attribute value
See code: src/commands/orders/customer_payment_source_id.ts
cl-orders orders:place IDSend this attribute if you want to place the order..
USAGE
$ cl-orders orders:place ID
ARGUMENTS
ID the unique id of the order
OPTIONS
-o, --organization=organization (required) the slug of your organization
See code: src/commands/orders/place.ts
cl-orders orders:refresh IDSend this attribute if you want to manually refresh the order..
USAGE
$ cl-orders orders:refresh ID
ARGUMENTS
ID the unique id of the order
OPTIONS
-o, --organization=organization (required) the slug of your organization
See code: src/commands/orders/refresh.ts
cl-orders orders:refund IDSend this attribute if you want to refund a captured order..
USAGE
$ cl-orders orders:refund ID
ARGUMENTS
ID the unique id of the order
OPTIONS
-o, --organization=organization (required) the slug of your organization
See code: src/commands/orders/refund.ts
cl-orders orders:save_billing_address_to_customer_address_book IDSend this attribute if you want the order's billing address to be saved in the customer's address book as a customer address..
USAGE
$ cl-orders orders:save_billing_address_to_customer_address_book ID
ARGUMENTS
ID the unique id of the order
OPTIONS
-o, --organization=organization (required) the slug of your organization
See code: src/commands/orders/save_billing_address_to_customer_address_book.ts
cl-orders orders:save_payment_source_to_customer_wallet IDSend this attribute if you want the order's payment source to be saved in the customer's wallet as a customer payment source..
USAGE
$ cl-orders orders:save_payment_source_to_customer_wallet ID
ARGUMENTS
ID the unique id of the order
OPTIONS
-o, --organization=organization (required) the slug of your organization
See code: src/commands/orders/save_payment_source_to_customer_wallet.ts
cl-orders orders:save_shipping_address_to_customer_address_book IDSend this attribute if you want the order's shipping address to be saved in the customer's address book as a customer address..
USAGE
$ cl-orders orders:save_shipping_address_to_customer_address_book ID
ARGUMENTS
ID the unique id of the order
OPTIONS
-o, --organization=organization (required) the slug of your organization
See code: src/commands/orders/save_shipping_address_to_customer_address_book.ts
cl-orders orders:shipping_address_clone_id IDThe id of the address that you want to clone to create the order's shipping address..
USAGE
$ cl-orders orders:shipping_address_clone_id ID
ARGUMENTS
ID the unique id of the order
OPTIONS
-o, --organization=organization (required) the slug of your organization
-v, --value=value (required) the trigger attribute value
See code: src/commands/orders/shipping_address_clone_id.ts
cl-orders orders:shipping_address_same_as_billing IDSend this attribute if you want the shipping address to be cloned from the order's billing address..
USAGE
$ cl-orders orders:shipping_address_same_as_billing ID
ARGUMENTS
ID the unique id of the order
OPTIONS
-o, --organization=organization (required) the slug of your organization
See code: src/commands/orders/shipping_address_same_as_billing.ts
cl-orders orders:unarchive IDSend this attribute if you want to unarchive the order..
USAGE
$ cl-orders orders:unarchive ID
ARGUMENTS
ID the unique id of the order
OPTIONS
-o, --organization=organization (required) the slug of your organization
See code: src/commands/orders/unarchive.ts
cl-orders orders:update_taxes IDSend this attribute if you want to force tax calculation for this order (a tax calculator must be associated to the order's market)..
USAGE
$ cl-orders orders:update_taxes ID
ARGUMENTS
ID the unique id of the order
OPTIONS
-o, --organization=organization (required) the slug of your organization
See code: src/commands/orders/update_taxes.ts
FAQs
Commerce Layer CLI Orders plugin
The npm package @commercelayer/cli-plugin-orders receives a total of 11 weekly downloads. As such, @commercelayer/cli-plugin-orders popularity was classified as not popular.
We found that @commercelayer/cli-plugin-orders demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.
Security News
Sonar’s acquisition of Tidelift highlights a growing industry shift toward sustainable open source funding, addressing maintainer burnout and critical software dependencies.