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
Commands

Usage

$ 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

Commands

cl-orders orders ID
cl-orders orders:approve ID
cl-orders orders:approve-and-capture ID
cl-orders orders:archive ID
cl-orders orders:authorization-amount-cents ID
cl-orders orders:authorize ID
cl-orders orders:billing-address-clone-id ID
cl-orders orders:billing-address-same-as-shipping ID
cl-orders orders:cancel ID
cl-orders orders:capture ID
cl-orders orders:customer-payment-source-id ID
cl-orders orders:place ID
cl-orders orders:refresh ID
cl-orders orders:refund ID
cl-orders orders:save-billing-address-to-customer-address-book ID
cl-orders orders:save-payment-source-to-customer-wallet ID
cl-orders orders:save-shipping-address-to-customer-address-book ID
cl-orders orders:shipping-address-clone-id ID
cl-orders orders:shipping-address-same-as-billing ID
cl-orders orders:unarchive ID
cl-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 organization

See 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 organization

See 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 organization

See 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 organization

See 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 organization

See 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 organization

See 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

See 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 organization

See 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 organization

See 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 organization

See 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

See 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 organization

See 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 organization

See 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 organization

See 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 organization

See 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 organization

See 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 organization

See 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

See 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 organization

See 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 organization

See 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 organization

See code: src/commands/orders/update-taxes.ts