@commercelayer/cli-plugin-orders
Advanced tools
Commerce Layer CLI Resources 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 resources
cl-orders orders:actionscl-orders orders:approve IDcl-orders orders:approve-and-capture IDcl-orders orders:archive IDcl-orders orders:authorize IDcl-orders orders:billing-address-same-as-shipping IDcl-orders orders:cancel IDcl-orders orders:capture 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-same-as-billing IDcl-orders orders:unarchive IDcl-orders orders:update-taxes IDcl-orders orders:actionsShow a list of all actions that can be executed on an order.
USAGE
$ cl-orders orders:actions
See code: src/commands/orders/actions.ts
cl-orders orders:approve IDApprove 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 IDApprove 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 IDArchive 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:authorize IDAuthorize 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-same-as-shipping IDThe 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 IDCancel 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 IDCapture 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:place IDPlace 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 IDRefresh an 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 IDRefund 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 IDThe 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 IDThe 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 IDThe 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-same-as-billing IDThe 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 IDUnarchive 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 IDForce 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.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
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.