@commercelayer/cli-plugin-triggers NPM

commercelayer-cli-plugin-triggers

Commerce Layer CLI Triggers plugin

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 triggers

Commands

`commercelayer adyen_payment ID`

Execute an action on a resource of type adyen_payments.

USAGE
  $ commercelayer adyen_payment ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  execute an action on a resource of type adyen_payments

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

`commercelayer adyen_payment:details ID`

Send this attribute if you want to send additional details the payment request.

USAGE
  $ commercelayer adyen_payment:details ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  Send this attribute if you want to send additional details the payment request.

See code: src/commands/adyen_payment/details.ts

`commercelayer authorization ID`

Execute an action on a resource of type authorizations.

USAGE
  $ commercelayer authorization ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  execute an action on a resource of type authorizations

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

`commercelayer authorization:capture ID`

Send this attribute if you want to create a capture for this authorization.

USAGE
  $ commercelayer authorization:capture ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  Send this attribute if you want to create a capture for this authorization.

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

`commercelayer authorization:capture_amount_cents ID`

The associated capture amount, in cents.

USAGE
  $ commercelayer authorization:capture_amount_cents ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  The associated capture amount, in cents.

See code: src/commands/authorization/capture_amount_cents.ts

`commercelayer authorization:void ID`

Send this attribute if you want to create a void for this authorization.

USAGE
  $ commercelayer authorization:void ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  Send this attribute if you want to create a void for this authorization.

See code: src/commands/authorization/void.ts

`commercelayer axerve_payment ID`

Execute an action on a resource of type axerve_payments.

USAGE
  $ commercelayer axerve_payment ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  execute an action on a resource of type axerve_payments

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

`commercelayer axerve_payment:update ID`

Send this attribute if you want to update the payment with fresh order data.

USAGE
  $ commercelayer axerve_payment:update ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  Send this attribute if you want to update the payment with fresh order data.

See code: src/commands/axerve_payment/update.ts

`commercelayer bundle ID`

Execute an action on a resource of type bundles.

USAGE
  $ commercelayer bundle ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  execute an action on a resource of type bundles

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

`commercelayer bundle:compute_compare_at_amount ID`

Send this attribute if you want to compute the compare_at_amount_cents as the sum of the prices of the bundle SKUs for the market.

USAGE
  $ commercelayer bundle:compute_compare_at_amount ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  Send this attribute if you want to compute the compare_at_amount_cents as the sum of the prices of the bundle SKUs for
  the market.

See code: src/commands/bundle/compute_compare_at_amount.ts

`commercelayer bundle:compute_price_amount ID`

Send this attribute if you want to compute the price_amount_cents as the sum of the prices of the bundle SKUs for the market.

USAGE
  $ commercelayer bundle:compute_price_amount ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  Send this attribute if you want to compute the price_amount_cents as the sum of the prices of the bundle SKUs for the
  market.

See code: src/commands/bundle/compute_price_amount.ts

`commercelayer buy_x_pay_y_promotion ID`

Execute an action on a resource of type buy_x_pay_y_promotions.

USAGE
  $ commercelayer buy_x_pay_y_promotion ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  execute an action on a resource of type buy_x_pay_y_promotions

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

`commercelayer buy_x_pay_y_promotion:disable ID`

Send this attribute if you want to mark this resource as disabled.

USAGE
  $ commercelayer buy_x_pay_y_promotion:disable ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  Send this attribute if you want to mark this resource as disabled.

See code: src/commands/buy_x_pay_y_promotion/disable.ts

`commercelayer buy_x_pay_y_promotion:enable ID`

Send this attribute if you want to mark this resource as enabled.

USAGE
  $ commercelayer buy_x_pay_y_promotion:enable ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  Send this attribute if you want to mark this resource as enabled.

See code: src/commands/buy_x_pay_y_promotion/enable.ts

`commercelayer capture ID`

Execute an action on a resource of type captures.

USAGE
  $ commercelayer capture ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  execute an action on a resource of type captures

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

`commercelayer capture:refund ID`

Send this attribute if you want to create a refund for this capture.

USAGE
  $ commercelayer capture:refund ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  Send this attribute if you want to create a refund for this capture.

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

`commercelayer capture:refund_amount_cents ID`

The associated refund amount, in cents.

USAGE
  $ commercelayer capture:refund_amount_cents ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  The associated refund amount, in cents.

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

`commercelayer checkout_com_payment ID`

Execute an action on a resource of type checkout_com_payments.

USAGE
  $ commercelayer checkout_com_payment ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  execute an action on a resource of type checkout_com_payments

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

`commercelayer checkout_com_payment:details ID`

Send this attribute if you want to send additional details the payment request (i.e. upon 3DS check).

USAGE
  $ commercelayer checkout_com_payment:details ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  Send this attribute if you want to send additional details the payment request (i.e. upon 3DS check).

See code: src/commands/checkout_com_payment/details.ts

`commercelayer checkout_com_payment:refresh ID`

Send this attribute if you want to refresh all the pending transactions, can be used as webhooks fallback logic.

USAGE
  $ commercelayer checkout_com_payment:refresh ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  Send this attribute if you want to refresh all the pending transactions, can be used as webhooks fallback logic.

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

`commercelayer customer_password_reset ID`

Execute an action on a resource of type customer_password_resets.

USAGE
  $ commercelayer customer_password_reset ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  execute an action on a resource of type customer_password_resets

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

`commercelayer customer_password_reset:reset_password_token ID`

Send the 'reset_password_token' that you got on create when updating the customer password.

USAGE
  $ commercelayer customer_password_reset:reset_password_token ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  Send the 'reset_password_token' that you got on create when updating the customer password.

See code: src/commands/customer_password_reset/reset_password_token.ts

`commercelayer external_gateway ID`

Execute an action on a resource of type external_gateways.

USAGE
  $ commercelayer external_gateway ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  execute an action on a resource of type external_gateways

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

`commercelayer external_gateway: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.

USAGE
  $ commercelayer external_gateway:reset_circuit ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -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.

See code: src/commands/external_gateway/reset_circuit.ts

`commercelayer external_promotion ID`

Execute an action on a resource of type external_promotions.

USAGE
  $ commercelayer external_promotion ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  execute an action on a resource of type external_promotions

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

`commercelayer external_promotion:disable ID`

Send this attribute if you want to mark this resource as disabled.

USAGE
  $ commercelayer external_promotion:disable ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  Send this attribute if you want to mark this resource as disabled.

See code: src/commands/external_promotion/disable.ts

`commercelayer external_promotion:enable ID`

Send this attribute if you want to mark this resource as enabled.

USAGE
  $ commercelayer external_promotion:enable ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  Send this attribute if you want to mark this resource as enabled.

See code: src/commands/external_promotion/enable.ts

`commercelayer external_promotion: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.

USAGE
  $ commercelayer external_promotion:reset_circuit ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -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.

See code: src/commands/external_promotion/reset_circuit.ts

`commercelayer external_tax_calculator ID`

Execute an action on a resource of type external_tax_calculators.

USAGE
  $ commercelayer external_tax_calculator ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  execute an action on a resource of type external_tax_calculators

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

`commercelayer external_tax_calculator: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.

USAGE
  $ commercelayer external_tax_calculator:reset_circuit ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -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.

See code: src/commands/external_tax_calculator/reset_circuit.ts

`commercelayer fixed_amount_promotion ID`

Execute an action on a resource of type fixed_amount_promotions.

USAGE
  $ commercelayer fixed_amount_promotion ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  execute an action on a resource of type fixed_amount_promotions

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

`commercelayer fixed_amount_promotion:disable ID`

Send this attribute if you want to mark this resource as disabled.

USAGE
  $ commercelayer fixed_amount_promotion:disable ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  Send this attribute if you want to mark this resource as disabled.

See code: src/commands/fixed_amount_promotion/disable.ts

`commercelayer fixed_amount_promotion:enable ID`

Send this attribute if you want to mark this resource as enabled.

USAGE
  $ commercelayer fixed_amount_promotion:enable ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  Send this attribute if you want to mark this resource as enabled.

See code: src/commands/fixed_amount_promotion/enable.ts

`commercelayer fixed_price_promotion ID`

Execute an action on a resource of type fixed_price_promotions.

USAGE
  $ commercelayer fixed_price_promotion ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  execute an action on a resource of type fixed_price_promotions

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

`commercelayer fixed_price_promotion:disable ID`

Send this attribute if you want to mark this resource as disabled.

USAGE
  $ commercelayer fixed_price_promotion:disable ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  Send this attribute if you want to mark this resource as disabled.

See code: src/commands/fixed_price_promotion/disable.ts

`commercelayer fixed_price_promotion:enable ID`

Send this attribute if you want to mark this resource as enabled.

USAGE
  $ commercelayer fixed_price_promotion:enable ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  Send this attribute if you want to mark this resource as enabled.

See code: src/commands/fixed_price_promotion/enable.ts

`commercelayer free_gift_promotion ID`

Execute an action on a resource of type free_gift_promotions.

USAGE
  $ commercelayer free_gift_promotion ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  execute an action on a resource of type free_gift_promotions

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

`commercelayer free_gift_promotion:disable ID`

Send this attribute if you want to mark this resource as disabled.

USAGE
  $ commercelayer free_gift_promotion:disable ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  Send this attribute if you want to mark this resource as disabled.

See code: src/commands/free_gift_promotion/disable.ts

`commercelayer free_gift_promotion:enable ID`

Send this attribute if you want to mark this resource as enabled.

USAGE
  $ commercelayer free_gift_promotion:enable ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  Send this attribute if you want to mark this resource as enabled.

See code: src/commands/free_gift_promotion/enable.ts

`commercelayer free_shipping_promotion ID`

Execute an action on a resource of type free_shipping_promotions.

USAGE
  $ commercelayer free_shipping_promotion ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  execute an action on a resource of type free_shipping_promotions

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

`commercelayer free_shipping_promotion:disable ID`

Send this attribute if you want to mark this resource as disabled.

USAGE
  $ commercelayer free_shipping_promotion:disable ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  Send this attribute if you want to mark this resource as disabled.

See code: src/commands/free_shipping_promotion/disable.ts

`commercelayer free_shipping_promotion:enable ID`

Send this attribute if you want to mark this resource as enabled.

USAGE
  $ commercelayer free_shipping_promotion:enable ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  Send this attribute if you want to mark this resource as enabled.

See code: src/commands/free_shipping_promotion/enable.ts

`commercelayer gift_card ID`

Execute an action on a resource of type gift_cards.

USAGE
  $ commercelayer gift_card ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  execute an action on a resource of type gift_cards

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

`commercelayer gift_card:activate ID`

Send this attribute if you want to activate a gift card.

USAGE
  $ commercelayer gift_card:activate ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  Send this attribute if you want to activate a gift card.

See code: src/commands/gift_card/activate.ts

`commercelayer gift_card:balance_change_cents ID`

The balance change, in cents. Send a negative value to reduces the card balance by the specified amount. Send a positive value to recharge the gift card (if rechargeable).

USAGE
  $ commercelayer gift_card:balance_change_cents ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  The balance change, in cents. Send a negative value to reduces the card balance by the specified amount. Send a
  positive value to recharge the gift card (if rechargeable).

See code: src/commands/gift_card/balance_change_cents.ts

`commercelayer gift_card:deactivate ID`

Send this attribute if you want to deactivate a gift card.

USAGE
  $ commercelayer gift_card:deactivate ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  Send this attribute if you want to deactivate a gift card.

See code: src/commands/gift_card/deactivate.ts

`commercelayer gift_card:purchase ID`

Send this attribute if you want to confirm a draft gift card. The gift card becomes 'inactive', waiting to be activated.

USAGE
  $ commercelayer gift_card:purchase ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  Send this attribute if you want to confirm a draft gift card. The gift card becomes 'inactive', waiting to be
  activated.

See code: src/commands/gift_card/purchase.ts

`commercelayer in_stock_subscription ID`

Execute an action on a resource of type in_stock_subscriptions.

USAGE
  $ commercelayer in_stock_subscription ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  execute an action on a resource of type in_stock_subscriptions

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

`commercelayer in_stock_subscription:activate ID`

Send this attribute if you want to activate an inactive subscription.

USAGE
  $ commercelayer in_stock_subscription:activate ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  Send this attribute if you want to activate an inactive subscription.

See code: src/commands/in_stock_subscription/activate.ts

`commercelayer in_stock_subscription:deactivate ID`

Send this attribute if you want to dactivate an active subscription.

USAGE
  $ commercelayer in_stock_subscription:deactivate ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  Send this attribute if you want to dactivate an active subscription.

See code: src/commands/in_stock_subscription/deactivate.ts

`commercelayer klarna_payment ID`

Execute an action on a resource of type klarna_payments.

USAGE
  $ commercelayer klarna_payment ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  execute an action on a resource of type klarna_payments

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

`commercelayer klarna_payment:update ID`

Send this attribute if you want to update the payment session with fresh order data.

USAGE
  $ commercelayer klarna_payment:update ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  Send this attribute if you want to update the payment session with fresh order data.

See code: src/commands/klarna_payment/update.ts

`commercelayer line_item ID`

Execute an action on a resource of type line_items.

USAGE
  $ commercelayer line_item ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  execute an action on a resource of type line_items

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

`commercelayer line_item:external_price ID`

When creating or updating a new line item, set this attribute to '1' if you want to inject the unit_amount_cents price from an external source. Any successive price computation will be done externally, until the attribute is reset to '0'.

USAGE
  $ commercelayer line_item:external_price ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  When creating or updating a new line item, set this attribute to '1' if you want to inject the unit_amount_cents price
  from an external source. Any successive price computation will be done externally, until the attribute is reset to
  '0'.

See code: src/commands/line_item/external_price.ts

`commercelayer line_item:reserve_stock ID`

Send this attribute if you want to reserve the stock for the line item's SKUs quantity. Stock reservations expiration depends on the inventory model's cutoff. When used on update the existing active stock reservations are renewed.

USAGE
  $ commercelayer line_item:reserve_stock ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  Send this attribute if you want to reserve the stock for the line item's SKUs quantity. Stock reservations expiration
  depends on the inventory model's cutoff. When used on update the existing active stock reservations are renewed.

See code: src/commands/line_item/reserve_stock.ts

`commercelayer line_item: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.

USAGE
  $ commercelayer line_item:reset_circuit ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -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.

See code: src/commands/line_item/reset_circuit.ts

`commercelayer market ID`

Execute an action on a resource of type markets.

USAGE
  $ commercelayer market ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  execute an action on a resource of type markets

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

`commercelayer market:disable ID`

Send this attribute if you want to mark this resource as disabled.

USAGE
  $ commercelayer market:disable ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  Send this attribute if you want to mark this resource as disabled.

See code: src/commands/market/disable.ts

`commercelayer market:enable ID`

Send this attribute if you want to mark this resource as enabled.

USAGE
  $ commercelayer market:enable ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  Send this attribute if you want to mark this resource as enabled.

See code: src/commands/market/enable.ts

`commercelayer order ID`

Execute an action on a resource of type orders.

USAGE
  $ commercelayer order ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  execute an action on a resource of type orders

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

`commercelayer order:approve ID`

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

USAGE
  $ commercelayer order:approve ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

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

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

`commercelayer order:approve_and_capture ID`

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

USAGE
  $ commercelayer order:approve_and_capture ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

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

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

`commercelayer order:archive ID`

Send this attribute if you want to archive the order.

USAGE
  $ commercelayer order:archive ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

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

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

`commercelayer order:authorization_amount_cents ID`

The authorization amount, in cents.

USAGE
  $ commercelayer order:authorization_amount_cents ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  The authorization amount, in cents.

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

`commercelayer order:authorize ID`

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

USAGE
  $ commercelayer order:authorize ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -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/order/authorize.ts

`commercelayer order:billing_address_clone_id ID`

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

USAGE
  $ commercelayer order:billing_address_clone_id ID -v <value> [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json           print result in JSON format
  -p, --print          print out the modified resource
  -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/order/billing_address_clone_id.ts

`commercelayer order: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 order:billing_address_same_as_shipping ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -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/order/billing_address_same_as_shipping.ts

`commercelayer order:cancel ID`

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

USAGE
  $ commercelayer order:cancel ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -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/order/cancel.ts

`commercelayer order:capture ID`

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

USAGE
  $ commercelayer order:capture ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output without indentation

DESCRIPTION
  Send this attribute if you want to capture an authorized order.

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

`commercelayer order: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 order:commit_invoice ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -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/order/commit_invoice.ts

`commercelayer order: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 order:create_subscriptions ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -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/order/create_subscriptions.ts

`commercelayer order: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 order:customer_payment_source_id ID -v <value> [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json           print result in JSON format
  -p, --print          print out the modified resource
  -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/order/customer_payment_source_id.ts

`commercelayer order:nullify_payment_source ID`

Send this attribute if you want to nullify the payment source for this order.

USAGE
  $ commercelayer order:nullify_payment_source ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -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/order/nullify_payment_source.ts

`commercelayer order:pending ID`

Send this attribute if you want to move a draft or placing order to pending.

USAGE
  $ commercelayer order:pending ID [-u [-j -p]]

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        print out the modified resource
  -u, --unformatted  print JSON output

ecommerce cli commercelayer

@commercelayer/cli-core @commercelayer/sdk @oclif/core inquirer tslib

@everything-registry/sub-chunk-190 @infinitebrahmanuniverse/nolb-_comm

9 days ago

24 days ago

24 days ago

26 days ago