@commercelayer/cli-plugin-orders

Commerce Layer CLI Orders plugin

Usage no npm install needed!

<script type="module">
  import commercelayerCliPluginOrders from 'https://cdn.skypack.dev/@commercelayer/cli-plugin-orders';
</script>

README

@commercelayer/cli-plugin-orders

Commerce Layer CLI Orders plugin

oclif Version Downloads/week License

Usage

To install as a Commerce Layer CLI plugin run the following command:

$ commercelayer plugins:install orders

Commands

commercelayer orders ID

Execute an action on an order.

USAGE
  $ commercelayer orders ID

ARGUMENTS
  ID  the unique id of the order

OPTIONS
  -j, --json                       print result in JSON format
  -o, --organization=organization  (required) the slug of your organization
  -p, --print                      print out the modified order
  -u, --unformatted                print JSON output without indentation

See code: src/commands/orders/index.ts

commercelayer orders:approve ID

Send this attribute if you want to approve a placed order..

USAGE
  $ commercelayer orders:approve ID

ARGUMENTS
  ID  the unique id of the order

OPTIONS
  -j, --json                       print result in JSON format
  -o, --organization=organization  (required) the slug of your organization
  -p, --print                      print out the modified order
  -u, --unformatted                print JSON output without indentation

See code: src/commands/orders/approve.ts

commercelayer orders:approve_and_capture ID

Send this attribute if you want to approve and capture a placed order..

USAGE
  $ commercelayer orders:approve_and_capture ID

ARGUMENTS
  ID  the unique id of the order

OPTIONS
  -j, --json                       print result in JSON format
  -o, --organization=organization  (required) the slug of your organization
  -p, --print                      print out the modified order
  -u, --unformatted                print JSON output without indentation

See code: src/commands/orders/approve_and_capture.ts

commercelayer orders:archive ID

Send this attribute if you want to archive the order..

USAGE
  $ commercelayer orders:archive ID

ARGUMENTS
  ID  the unique id of the order

OPTIONS
  -j, --json                       print result in JSON format
  -o, --organization=organization  (required) the slug of your organization
  -p, --print                      print out the modified order
  -u, --unformatted                print JSON output without indentation

See code: src/commands/orders/archive.ts

commercelayer orders:authorization_amount_cents ID

The authorization amount, in cents..

USAGE
  $ commercelayer orders:authorization_amount_cents ID

ARGUMENTS
  ID  the unique id of the order

OPTIONS
  -j, --json                       print result in JSON format
  -o, --organization=organization  (required) the slug of your organization
  -p, --print                      print out the modified order
  -u, --unformatted                print JSON output without indentation

See code: src/commands/orders/authorization_amount_cents.ts

commercelayer orders:authorize ID

Send this attribute if you want to authorize the order's payment source..

USAGE
  $ commercelayer orders:authorize ID

ARGUMENTS
  ID  the unique id of the order

OPTIONS
  -j, --json                       print result in JSON format
  -o, --organization=organization  (required) the slug of your organization
  -p, --print                      print out the modified order
  -u, --unformatted                print JSON output without indentation

See code: src/commands/orders/authorize.ts

commercelayer orders:billing_address_clone_id ID

The id of the address that you want to clone to create the order's billing address..

USAGE
  $ commercelayer orders:billing_address_clone_id ID

ARGUMENTS
  ID  the unique id of the order

OPTIONS
  -j, --json                       print result in JSON format
  -o, --organization=organization  (required) the slug of your organization
  -p, --print                      print out the modified order
  -u, --unformatted                print JSON output without indentation
  -v, --value=value                (required) the trigger attribute value

See code: src/commands/orders/billing_address_clone_id.ts

commercelayer 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
  $ commercelayer orders:billing_address_same_as_shipping ID

ARGUMENTS
  ID  the unique id of the order

OPTIONS
  -j, --json                       print result in JSON format
  -o, --organization=organization  (required) the slug of your organization
  -p, --print                      print out the modified order
  -u, --unformatted                print JSON output without indentation

See code: src/commands/orders/billing_address_same_as_shipping.ts

commercelayer orders:cancel ID

Send this attribute if you want to cancel a placed order. The order's authorization will be automatically voided..

USAGE
  $ commercelayer orders:cancel ID

ARGUMENTS
  ID  the unique id of the order

OPTIONS
  -j, --json                       print result in JSON format
  -o, --organization=organization  (required) the slug of your organization
  -p, --print                      print out the modified order
  -u, --unformatted                print JSON output without indentation

See code: src/commands/orders/cancel.ts

commercelayer orders:capture ID

Send this attribute if you want to capture an approved order..

USAGE
  $ commercelayer orders:capture ID

ARGUMENTS
  ID  the unique id of the order

OPTIONS
  -j, --json                       print result in JSON format
  -o, --organization=organization  (required) the slug of your organization
  -p, --print                      print out the modified order
  -u, --unformatted                print JSON output without indentation

See code: src/commands/orders/capture.ts

commercelayer 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
  $ commercelayer orders:customer_payment_source_id ID

ARGUMENTS
  ID  the unique id of the order

OPTIONS
  -j, --json                       print result in JSON format
  -o, --organization=organization  (required) the slug of your organization
  -p, --print                      print out the modified order
  -u, --unformatted                print JSON output without indentation
  -v, --value=value                (required) the trigger attribute value

See code: src/commands/orders/customer_payment_source_id.ts

commercelayer orders:place ID

Send this attribute if you want to place the order..

USAGE
  $ commercelayer orders:place ID

ARGUMENTS
  ID  the unique id of the order

OPTIONS
  -j, --json                       print result in JSON format
  -o, --organization=organization  (required) the slug of your organization
  -p, --print                      print out the modified order
  -u, --unformatted                print JSON output without indentation

See code: src/commands/orders/place.ts

commercelayer orders:refresh ID

Send this attribute if you want to manually refresh the order..

USAGE
  $ commercelayer orders:refresh ID

ARGUMENTS
  ID  the unique id of the order

OPTIONS
  -j, --json                       print result in JSON format
  -o, --organization=organization  (required) the slug of your organization
  -p, --print                      print out the modified order
  -u, --unformatted                print JSON output without indentation

See code: src/commands/orders/refresh.ts

commercelayer orders:refund ID

Send this attribute if you want to refund a captured order..

USAGE
  $ commercelayer orders:refund ID

ARGUMENTS
  ID  the unique id of the order

OPTIONS
  -j, --json                       print result in JSON format
  -o, --organization=organization  (required) the slug of your organization
  -p, --print                      print out the modified order
  -u, --unformatted                print JSON output without indentation

See code: src/commands/orders/refund.ts

commercelayer 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
  $ commercelayer orders:save_billing_address_to_customer_address_book ID

ARGUMENTS
  ID  the unique id of the order

OPTIONS
  -j, --json                       print result in JSON format
  -o, --organization=organization  (required) the slug of your organization
  -p, --print                      print out the modified order
  -u, --unformatted                print JSON output without indentation

See code: src/commands/orders/save_billing_address_to_customer_address_book.ts

commercelayer 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
  $ commercelayer orders:save_payment_source_to_customer_wallet ID

ARGUMENTS
  ID  the unique id of the order

OPTIONS
  -j, --json                       print result in JSON format
  -o, --organization=organization  (required) the slug of your organization
  -p, --print                      print out the modified order
  -u, --unformatted                print JSON output without indentation

See code: src/commands/orders/save_payment_source_to_customer_wallet.ts

commercelayer 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
  $ commercelayer orders:save_shipping_address_to_customer_address_book ID

ARGUMENTS
  ID  the unique id of the order

OPTIONS
  -j, --json                       print result in JSON format
  -o, --organization=organization  (required) the slug of your organization
  -p, --print                      print out the modified order
  -u, --unformatted                print JSON output without indentation

See code: src/commands/orders/save_shipping_address_to_customer_address_book.ts

commercelayer orders:shipping_address_clone_id ID

The id of the address that you want to clone to create the order's shipping address..

USAGE
  $ commercelayer orders:shipping_address_clone_id ID

ARGUMENTS
  ID  the unique id of the order

OPTIONS
  -j, --json                       print result in JSON format
  -o, --organization=organization  (required) the slug of your organization
  -p, --print                      print out the modified order
  -u, --unformatted                print JSON output without indentation
  -v, --value=value                (required) the trigger attribute value

See code: src/commands/orders/shipping_address_clone_id.ts

commercelayer 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
  $ commercelayer orders:shipping_address_same_as_billing ID

ARGUMENTS
  ID  the unique id of the order

OPTIONS
  -j, --json                       print result in JSON format
  -o, --organization=organization  (required) the slug of your organization
  -p, --print                      print out the modified order
  -u, --unformatted                print JSON output without indentation

See code: src/commands/orders/shipping_address_same_as_billing.ts

commercelayer orders:unarchive ID

Send this attribute if you want to unarchive the order..

USAGE
  $ commercelayer orders:unarchive ID

ARGUMENTS
  ID  the unique id of the order

OPTIONS
  -j, --json                       print result in JSON format
  -o, --organization=organization  (required) the slug of your organization
  -p, --print                      print out the modified order
  -u, --unformatted                print JSON output without indentation

See code: src/commands/orders/unarchive.ts

commercelayer 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
  $ commercelayer orders:update_taxes ID

ARGUMENTS
  ID  the unique id of the order

OPTIONS
  -j, --json                       print result in JSON format
  -o, --organization=organization  (required) the slug of your organization
  -p, --print                      print out the modified order
  -u, --unformatted                print JSON output without indentation

See code: src/commands/orders/update_taxes.ts