Package Exports
- @commercelayer/cli-plugin-orders
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@commercelayer/cli-plugin-orders) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
@commercelayer/cli-plugin-orders
Commerce Layer CLI Orders plugin
Usage
$ npm install -g @commercelayer/cli-plugin-orders
$ cl-orders COMMAND
running command...
$ cl-orders (-v|--version|version)
@commercelayer/cli-plugin-orders/2.0.0 darwin-x64 node-v16.13.0
$ cl-orders --help [COMMAND]
USAGE
$ cl-orders COMMAND
...To install as a Commerce Layer CLI plugin run the following command:
$ commercelayer plugins:install ordersCommands
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 ID
cl-orders orders ID
execute 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 organizationSee code: src/commands/orders/index.ts
cl-orders orders:approve ID
Send 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 organizationSee code: src/commands/orders/approve.ts
cl-orders orders:approve_and_capture ID
Send 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 organizationSee code: src/commands/orders/approve_and_capture.ts
cl-orders orders:archive ID
Send 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 organizationSee code: src/commands/orders/archive.ts
cl-orders orders:authorization_amount_cents ID
The 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 organizationSee code: src/commands/orders/authorization_amount_cents.ts
cl-orders orders:authorize ID
Send 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 organizationSee code: src/commands/orders/authorize.ts
cl-orders orders:billing_address_clone_id ID
The 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 valueSee code: src/commands/orders/billing_address_clone_id.ts
cl-orders orders:billing_address_same_as_shipping ID
Send 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 organizationSee code: src/commands/orders/billing_address_same_as_shipping.ts
cl-orders orders:cancel ID
Send 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 organizationSee code: src/commands/orders/cancel.ts
cl-orders orders:capture ID
Send 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 organizationSee code: src/commands/orders/capture.ts
cl-orders orders:customer_payment_source_id ID
The 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 valueSee code: src/commands/orders/customer_payment_source_id.ts
cl-orders orders:place ID
Send 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 organizationSee code: src/commands/orders/place.ts
cl-orders orders:refresh ID
Send 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 organizationSee code: src/commands/orders/refresh.ts
cl-orders orders:refund ID
Send 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 organizationSee code: src/commands/orders/refund.ts
cl-orders orders:save_billing_address_to_customer_address_book ID
Send 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 organizationSee code: src/commands/orders/save_billing_address_to_customer_address_book.ts
cl-orders orders:save_payment_source_to_customer_wallet ID
Send 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 organizationSee code: src/commands/orders/save_payment_source_to_customer_wallet.ts
cl-orders orders:save_shipping_address_to_customer_address_book ID
Send 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 organizationSee code: src/commands/orders/save_shipping_address_to_customer_address_book.ts
cl-orders orders:shipping_address_clone_id ID
The 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 valueSee code: src/commands/orders/shipping_address_clone_id.ts
cl-orders orders:shipping_address_same_as_billing ID
Send 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 organizationSee code: src/commands/orders/shipping_address_same_as_billing.ts
cl-orders orders:unarchive ID
Send 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 organizationSee code: src/commands/orders/unarchive.ts
cl-orders orders:update_taxes ID
Send 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 organizationSee code: src/commands/orders/update_taxes.ts