@commercelayer/cli-plugin-orders
Advanced tools
Commerce Layer CLI Orders plugin
commercelayer COMMAND
commercelayer [COMMAND] (--help | -h) for detailed information about plugin commands.
To install as a Commerce Layer CLI plugin run the following command:
$ commercelayer plugins:install orders
commercelayer orders IDcommercelayer orders:approve IDcommercelayer orders:approve_and_capture IDcommercelayer orders:archive IDcommercelayer orders:authorization_amount_cents IDcommercelayer orders:authorize IDcommercelayer orders:billing_address_clone_id IDcommercelayer orders:billing_address_same_as_shipping IDcommercelayer orders:cancel IDcommercelayer orders:capture IDcommercelayer orders:commit_invoice IDcommercelayer orders:create_subscriptions IDcommercelayer orders:customer_payment_source_id IDcommercelayer orders:nullify_payment_source IDcommercelayer orders:place IDcommercelayer orders:refresh IDcommercelayer orders:refund IDcommercelayer orders:refund_invoice IDcommercelayer orders:save_billing_address_to_customer_address_book IDcommercelayer orders:save_payment_source_to_customer_wallet IDcommercelayer orders:save_shipping_address_to_customer_address_book IDcommercelayer orders:shipping_address_clone_id IDcommercelayer orders:shipping_address_same_as_billing IDcommercelayer orders:start_editing IDcommercelayer orders:stop_editing IDcommercelayer orders:unarchive IDcommercelayer orders:update_taxes IDcommercelayer orders:validate IDcommercelayer orders IDExecute an action on an order.
USAGE
$ commercelayer orders ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the order
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified order
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on an order
See code: src/commands/orders/index.ts
commercelayer orders:approve IDSend this attribute if you want to approve a placed order.
USAGE
$ commercelayer orders:approve ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the order
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified order
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to approve a placed order.
See code: src/commands/orders/approve.ts
commercelayer orders:approve_and_capture IDSend this attribute if you want to approve and capture a placed order.
USAGE
$ commercelayer orders:approve_and_capture ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the order
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified order
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to approve and capture a placed order.
See code: src/commands/orders/approve_and_capture.ts
commercelayer orders:archive IDSend this attribute if you want to archive the order.
USAGE
$ commercelayer orders:archive ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the order
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified order
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to archive the order.
See code: src/commands/orders/archive.ts
commercelayer orders:authorization_amount_cents IDThe authorization amount, in cents.
USAGE
$ commercelayer orders:authorization_amount_cents ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the order
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified order
-u, --unformatted print JSON output without indentation
DESCRIPTION
The authorization amount, in cents.
See code: src/commands/orders/authorization_amount_cents.ts
commercelayer orders:authorize IDSend this attribute if you want to authorize the order's payment source.
USAGE
$ commercelayer orders:authorize ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the order
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified order
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to authorize the order's payment source.
See code: src/commands/orders/authorize.ts
commercelayer orders:billing_address_clone_id IDThe id of the address that you want to clone to create the order's billing address.
USAGE
$ commercelayer orders:billing_address_clone_id ID -v <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the order
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified order
-u, --unformatted print JSON output without indentation
-v, --value=<value> (required) the trigger attribute value
DESCRIPTION
The id of the address that you want to clone to create the order's billing address.
See code: src/commands/orders/billing_address_clone_id.ts
commercelayer 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
$ commercelayer orders:billing_address_same_as_shipping ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the order
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified order
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want the billing address to be cloned from the order's shipping address.
See code: src/commands/orders/billing_address_same_as_shipping.ts
commercelayer orders:cancel IDSend this attribute if you want to cancel a placed order. The order's authorization will be automatically voided.
USAGE
$ commercelayer orders:cancel ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the order
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified order
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to cancel a placed order. The order's authorization will be automatically voided.
See code: src/commands/orders/cancel.ts
commercelayer orders:capture IDSend this attribute if you want to capture an authorized order.
USAGE
$ commercelayer orders:capture ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the order
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified order
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to capture an authorized order.
See code: src/commands/orders/capture.ts
commercelayer orders:commit_invoice IDSend this attribute if you want commit the sales tax invoice to the associated tax calculator (currently supported by Avalara).
USAGE
$ commercelayer orders:commit_invoice ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the order
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified order
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want commit the sales tax invoice to the associated tax calculator (currently supported by
Avalara).
See code: src/commands/orders/commit_invoice.ts
commercelayer orders:create_subscriptions IDSend this attribute upon/after placing the order if you want to create order subscriptions from the line items that have a frequency.
USAGE
$ commercelayer orders:create_subscriptions ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the order
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified order
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute upon/after placing the order if you want to create order subscriptions from the line items that
have a frequency.
See code: src/commands/orders/create_subscriptions.ts
commercelayer 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
$ commercelayer orders:customer_payment_source_id ID -v <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the order
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified order
-u, --unformatted print JSON output without indentation
-v, --value=<value> (required) the trigger attribute value
DESCRIPTION
The id of the customer payment source (i.e. credit card) that you want to use as the order's payment source.
See code: src/commands/orders/customer_payment_source_id.ts
commercelayer orders:nullify_payment_source IDSend this attribute if you want to nullify the payment source for this order.
USAGE
$ commercelayer orders:nullify_payment_source ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the order
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified order
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to nullify the payment source for this order.
See code: src/commands/orders/nullify_payment_source.ts
commercelayer orders:place IDSend this attribute if you want to place the order.
USAGE
$ commercelayer orders:place ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the order
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified order
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to place the order.
See code: src/commands/orders/place.ts
commercelayer orders:refresh IDSend this attribute if you want to manually refresh the order.
USAGE
$ commercelayer orders:refresh ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the order
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified order
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to manually refresh the order.
See code: src/commands/orders/refresh.ts
commercelayer orders:refund IDSend this attribute if you want to refund a captured order.
USAGE
$ commercelayer orders:refund ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the order
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified order
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to refund a captured order.
See code: src/commands/orders/refund.ts
commercelayer orders:refund_invoice IDSend this attribute if you want refund the sales tax invoice to the associated tax calculator (currently supported by Avalara).
USAGE
$ commercelayer orders:refund_invoice ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the order
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified order
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want refund the sales tax invoice to the associated tax calculator (currently supported by
Avalara).
See code: src/commands/orders/refund_invoice.ts
commercelayer 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
$ commercelayer orders:save_billing_address_to_customer_address_book ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the order
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified order
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want the order's billing address to be saved in the customer's address book as a customer
address.
See code: src/commands/orders/save_billing_address_to_customer_address_book.ts
commercelayer 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
$ commercelayer orders:save_payment_source_to_customer_wallet ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the order
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified order
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want the order's payment source to be saved in the customer's wallet as a customer payment
source.
See code: src/commands/orders/save_payment_source_to_customer_wallet.ts
commercelayer 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
$ commercelayer orders:save_shipping_address_to_customer_address_book ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the order
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified order
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want the order's shipping address to be saved in the customer's address book as a customer
address.
See code: src/commands/orders/save_shipping_address_to_customer_address_book.ts
commercelayer orders:shipping_address_clone_id IDThe id of the address that you want to clone to create the order's shipping address.
USAGE
$ commercelayer orders:shipping_address_clone_id ID -v <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the order
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified order
-u, --unformatted print JSON output without indentation
-v, --value=<value> (required) the trigger attribute value
DESCRIPTION
The id of the address that you want to clone to create the order's shipping address.
See code: src/commands/orders/shipping_address_clone_id.ts
commercelayer 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
$ commercelayer orders:shipping_address_same_as_billing ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the order
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified order
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want the shipping address to be cloned from the order's billing address.
See code: src/commands/orders/shipping_address_same_as_billing.ts
commercelayer orders:start_editing IDSend this attribute if you want to edit the order after it is placed. Remember you cannot exceed the original total amount.
USAGE
$ commercelayer orders:start_editing ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the order
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified order
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to edit the order after it is placed. Remember you cannot exceed the original total
amount.
See code: src/commands/orders/start_editing.ts
commercelayer orders:stop_editing IDSend this attribute to stop the editing for the order and return back to placed status.
USAGE
$ commercelayer orders:stop_editing ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the order
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified order
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute to stop the editing for the order and return back to placed status.
See code: src/commands/orders/stop_editing.ts
commercelayer orders:unarchive IDSend this attribute if you want to unarchive the order.
USAGE
$ commercelayer orders:unarchive ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the order
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified order
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to unarchive the order.
See code: src/commands/orders/unarchive.ts
commercelayer 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
$ commercelayer orders:update_taxes ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the order
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified order
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to force tax calculation for this order (a tax calculator must be associated to the
order's market).
See code: src/commands/orders/update_taxes.ts
commercelayer orders:validate IDSend this attribute if you want to trigger the external validation for the order.
USAGE
$ commercelayer orders:validate ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the order
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified order
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to trigger the external validation for the order.
See code: src/commands/orders/validate.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.