@commercelayer/cli-plugin-orders

@commercelayer/cli-plugin-orders

Commerce Layer CLI Orders plugin

• Usage
• Commands

Usage

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

Commands

• commercelayer orders ID
• commercelayer orders:approve ID
• commercelayer orders:approve_and_capture ID
• commercelayer orders:archive ID
• commercelayer orders:authorization_amount_cents ID
• commercelayer orders:authorize ID
• commercelayer orders:billing_address_clone_id ID
• commercelayer orders:billing_address_same_as_shipping ID
• commercelayer orders:cancel ID
• commercelayer orders:capture ID
• commercelayer orders:commit_invoice ID
• commercelayer orders:create_subscriptions ID
• commercelayer orders:customer_payment_source_id ID
• commercelayer orders:fulfill ID
• commercelayer orders:nullify_payment_source ID
• commercelayer orders:pending ID
• commercelayer orders:place ID
• commercelayer orders:refresh ID
• commercelayer orders:refund ID
• commercelayer orders:refund_invoice ID
• commercelayer orders:reset_circuit ID
• commercelayer orders:save_billing_address_to_customer_address_book ID
• commercelayer orders:save_payment_source_to_customer_wallet ID
• commercelayer orders:save_shipping_address_to_customer_address_book ID
• commercelayer orders:shipping_address_clone_id ID
• commercelayer orders:shipping_address_same_as_billing ID
• commercelayer orders:start_editing ID
• commercelayer orders:stop_editing ID
• commercelayer orders:unarchive ID
• commercelayer orders:update_taxes ID
• commercelayer orders:validate ID

commercelayer orders ID

Execute 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 ID

Send this attribute if you want to approve a placed order. Cannot be passed by sales channels.

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. Cannot be passed by sales channels.

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. Cannot be passed by sales channels.

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. Cannot be passed by sales channels.

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 [-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 ID

Send this attribute as a value in cents if you want to overwrite the amount to be authorized.

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
  Send this attribute as a value in cents if you want to overwrite the amount to be authorized.

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 [-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 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 -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 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 [-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 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 [-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 ID

Send this attribute if you want to capture an authorized order. Cannot be passed by sales channels.

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. Cannot be passed by sales channels.

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

commercelayer orders:commit_invoice ID

Send 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 ID

Send 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 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 -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:fulfill ID

Send this attribute if you want to mark as fulfilled the order (shipments must be cancelled, shipped or delivered). Cannot be passed by sales channels.

USAGE
  $ commercelayer orders:fulfill 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 mark as fulfilled the order (shipments must be cancelled, shipped or delivered).
  Cannot be passed by sales channels.

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

commercelayer orders:nullify_payment_source ID

Send 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:pending ID

Send this attribute if you want to move a draft or placing order to pending. Cannot be passed by sales channels.

USAGE
  $ commercelayer orders:pending 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 move a draft or placing order to pending. Cannot be passed by sales channels.

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

commercelayer orders:place ID

Send 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 ID

Send 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 ID

Send this attribute if you want to refund a captured order. Cannot be passed by sales channels.

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. Cannot be passed by sales channels.

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

commercelayer orders:refund_invoice ID

Send 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:reset_circuit ID

Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count. Cannot be passed by sales channels.

USAGE
  $ commercelayer orders:reset_circuit 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 reset the circuit breaker associated to this resource to 'closed' state and zero
  failures count. Cannot be passed by sales channels.

See code: src/commands/orders/reset_circuit.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 [-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 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 [-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 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 [-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 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 -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 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 [-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 ID

Send this attribute if you want to edit the order after it is placed. Remember you cannot exceed the original total amount. Cannot be passed by sales channels.

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. Cannot be passed by sales channels.

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

commercelayer orders:stop_editing ID

Send this attribute to stop the editing for the order and return back to placed status. Cannot be passed by sales channels.

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. Cannot be passed by sales
  channels.

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

commercelayer orders:unarchive ID

Send 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 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 [-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 ID

Send 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