commercelayer-cli-plugin-triggers

Commerce Layer CLI Triggers 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 triggers

Commands

• commercelayer address ID
• commercelayer address:add_tags ID
• commercelayer address:remove_tags ID
• commercelayer adyen_gateway ID
• commercelayer adyen_gateway:disable ID
• commercelayer adyen_gateway:enable ID
• commercelayer adyen_payment ID
• commercelayer adyen_payment:authorize ID
• commercelayer adyen_payment:balance ID
• commercelayer adyen_payment:details ID
• commercelayer authorization ID
• commercelayer authorization:cancel ID
• commercelayer authorization:capture ID
• commercelayer authorization:capture_amount_cents ID
• commercelayer authorization:forward ID
• commercelayer authorization:void ID
• commercelayer axerve_gateway ID
• commercelayer axerve_gateway:disable ID
• commercelayer axerve_gateway:enable ID
• commercelayer axerve_payment ID
• commercelayer axerve_payment:update ID
• commercelayer braintree_gateway ID
• commercelayer braintree_gateway:disable ID
• commercelayer braintree_gateway:enable ID
• commercelayer bundle ID
• commercelayer bundle:add_tags ID
• commercelayer bundle:compute_compare_at_amount ID
• commercelayer bundle:compute_price_amount ID
• commercelayer bundle:remove_tags ID
• commercelayer buy_x_pay_y_promotion ID
• commercelayer buy_x_pay_y_promotion:add_tags ID
• commercelayer buy_x_pay_y_promotion:disable ID
• commercelayer buy_x_pay_y_promotion:enable ID
• commercelayer buy_x_pay_y_promotion:remove_tags ID
• commercelayer capture ID
• commercelayer capture:cancel ID
• commercelayer capture:forward ID
• commercelayer capture:refund ID
• commercelayer capture:refund_amount_cents ID
• commercelayer checkout_com_gateway ID
• commercelayer checkout_com_gateway:disable ID
• commercelayer checkout_com_gateway:enable ID
• commercelayer checkout_com_payment ID
• commercelayer checkout_com_payment:details ID
• commercelayer checkout_com_payment:refresh ID
• commercelayer cleanup ID
• commercelayer cleanup:interrupt ID
• commercelayer coupon ID
• commercelayer coupon:add_tags ID
• commercelayer coupon:remove_tags ID
• commercelayer customer ID
• commercelayer customer:add_tags ID
• commercelayer customer:cancel_anonymization ID
• commercelayer customer:remove_tags ID
• commercelayer customer:request_anonymization ID
• commercelayer customer_password_reset ID
• commercelayer customer_password_reset:reset_password_token ID
• commercelayer easypost_pickup ID
• commercelayer easypost_pickup:purchase ID
• commercelayer event ID
• commercelayer event:trigger ID
• commercelayer export ID
• commercelayer export:interrupt ID
• commercelayer external_gateway ID
• commercelayer external_gateway:disable ID
• commercelayer external_gateway:enable ID
• commercelayer external_gateway:reset_circuit ID
• commercelayer external_promotion ID
• commercelayer external_promotion:add_tags ID
• commercelayer external_promotion:disable ID
• commercelayer external_promotion:enable ID
• commercelayer external_promotion:remove_tags ID
• commercelayer external_promotion:reset_circuit ID
• commercelayer external_tax_calculator ID
• commercelayer external_tax_calculator:reset_circuit ID
• commercelayer fixed_amount_promotion ID
• commercelayer fixed_amount_promotion:add_tags ID
• commercelayer fixed_amount_promotion:disable ID
• commercelayer fixed_amount_promotion:enable ID
• commercelayer fixed_amount_promotion:remove_tags ID
• commercelayer fixed_price_promotion ID
• commercelayer fixed_price_promotion:add_tags ID
• commercelayer fixed_price_promotion:disable ID
• commercelayer fixed_price_promotion:enable ID
• commercelayer fixed_price_promotion:remove_tags ID
• commercelayer flex_promotion ID
• commercelayer flex_promotion:add_tags ID
• commercelayer flex_promotion:disable ID
• commercelayer flex_promotion:enable ID
• commercelayer flex_promotion:remove_tags ID
• commercelayer free_gift_promotion ID
• commercelayer free_gift_promotion:add_tags ID
• commercelayer free_gift_promotion:disable ID
• commercelayer free_gift_promotion:enable ID
• commercelayer free_gift_promotion:remove_tags ID
• commercelayer free_shipping_promotion ID
• commercelayer free_shipping_promotion:add_tags ID
• commercelayer free_shipping_promotion:disable ID
• commercelayer free_shipping_promotion:enable ID
• commercelayer free_shipping_promotion:remove_tags ID
• commercelayer gift_card ID
• commercelayer gift_card:activate ID
• commercelayer gift_card:add_tags ID
• commercelayer gift_card:balance_change_cents ID
• commercelayer gift_card:deactivate ID
• commercelayer gift_card:purchase ID
• commercelayer gift_card:remove_tags ID
• commercelayer import ID
• commercelayer import:interrupt ID
• commercelayer in_stock_subscription ID
• commercelayer in_stock_subscription:activate ID
• commercelayer in_stock_subscription:deactivate ID
• commercelayer klarna_gateway ID
• commercelayer klarna_gateway:disable ID
• commercelayer klarna_gateway:enable ID
• commercelayer klarna_payment ID
• commercelayer klarna_payment:update ID
• commercelayer line_item ID
• commercelayer line_item:add_tags ID
• commercelayer line_item:external_price ID
• commercelayer line_item:remove_tags ID
• commercelayer line_item:reserve_stock ID
• commercelayer line_item:reset_circuit ID
• commercelayer line_item:reset_restocked_quantity ID
• commercelayer line_item_option ID
• commercelayer line_item_option:add_tags ID
• commercelayer line_item_option:remove_tags ID
• commercelayer link ID
• commercelayer link:disable ID
• commercelayer link:enable ID
• commercelayer manual_gateway ID
• commercelayer manual_gateway:disable ID
• commercelayer manual_gateway:enable ID
• commercelayer market ID
• commercelayer market:disable ID
• commercelayer market:enable ID
• commercelayer order ID
• commercelayer order:add_tags ID
• commercelayer order:approve ID
• commercelayer order:approve_and_capture ID
• commercelayer order:archive ID
• commercelayer order:authorization_amount_cents ID
• commercelayer order:authorize ID
• commercelayer order:billing_address_clone_id ID
• commercelayer order:billing_address_same_as_shipping ID
• commercelayer order:cancel ID
• commercelayer order:capture ID
• commercelayer order:commit_invoice ID
• commercelayer order:create_subscriptions ID
• commercelayer order:customer_payment_source_id ID
• commercelayer order:fix_payment_source ID
• commercelayer order:fulfill ID
• commercelayer order:nullify_payment_source ID
• commercelayer order:pending ID
• commercelayer order:place ID
• commercelayer order:refresh ID
• commercelayer order:refund ID
• commercelayer order:refund_invoice ID
• commercelayer order:remove_tags ID
• commercelayer order:reset_circuit ID
• commercelayer order:save_billing_address_to_customer_address_book ID
• commercelayer order:save_payment_source_to_customer_wallet ID
• commercelayer order:save_shipping_address_to_customer_address_book ID
• commercelayer order:shipping_address_clone_id ID
• commercelayer order:shipping_address_same_as_billing ID
• commercelayer order:start_editing ID
• commercelayer order:stop_editing ID
• commercelayer order:unarchive ID
• commercelayer order:update_taxes ID
• commercelayer order:validate ID
• commercelayer order_subscription ID
• commercelayer order_subscription:activate ID
• commercelayer order_subscription:add_tags ID
• commercelayer order_subscription:cancel ID
• commercelayer order_subscription:convert ID
• commercelayer order_subscription:deactivate ID
• commercelayer order_subscription:remove_tags ID
• commercelayer payment_method ID
• commercelayer payment_method:disable ID
• commercelayer payment_method:enable ID
• commercelayer paypal_gateway ID
• commercelayer paypal_gateway:disable ID
• commercelayer paypal_gateway:enable ID
• commercelayer percentage_discount_promotion ID
• commercelayer percentage_discount_promotion:add_tags ID
• commercelayer percentage_discount_promotion:disable ID
• commercelayer percentage_discount_promotion:enable ID
• commercelayer percentage_discount_promotion:remove_tags ID
• commercelayer price_list_scheduler ID
• commercelayer price_list_scheduler:disable ID
• commercelayer price_list_scheduler:enable ID
• commercelayer refund ID
• commercelayer refund:forward ID
• commercelayer return ID
• commercelayer return:add_tags ID
• commercelayer return:approve ID
• commercelayer return:archive ID
• commercelayer return:cancel ID
• commercelayer return:receive ID
• commercelayer return:refund ID
• commercelayer return:refund_amount_cents ID
• commercelayer return:reject ID
• commercelayer return:remove_tags ID
• commercelayer return:request ID
• commercelayer return:restock ID
• commercelayer return:ship ID
• commercelayer return:unarchive ID
• commercelayer return_line_item ID
• commercelayer return_line_item:restock ID
• commercelayer satispay_gateway ID
• commercelayer satispay_gateway:disable ID
• commercelayer satispay_gateway:enable ID
• commercelayer satispay_payment ID
• commercelayer satispay_payment:refresh ID
• commercelayer shipment ID
• commercelayer shipment:add_tags ID
• commercelayer shipment:cancel ID
• commercelayer shipment:decrement_stock ID
• commercelayer shipment:deliver ID
• commercelayer shipment:get_rates ID
• commercelayer shipment:on_hold ID
• commercelayer shipment:packing ID
• commercelayer shipment:picking ID
• commercelayer shipment:purchase ID
• commercelayer shipment:ready_to_ship ID
• commercelayer shipment:release_stock ID
• commercelayer shipment:remove_tags ID
• commercelayer shipment:reserve_stock ID
• commercelayer shipment:ship ID
• commercelayer shipment:upcoming ID
• commercelayer shipping_method ID
• commercelayer shipping_method:add_tags ID
• commercelayer shipping_method:disable ID
• commercelayer shipping_method:enable ID
• commercelayer shipping_method:remove_tags ID
• commercelayer shipping_method:reset_circuit ID
• commercelayer sku ID
• commercelayer sku:add_tags ID
• commercelayer sku:remove_tags ID
• commercelayer sku_option ID
• commercelayer sku_option:add_tags ID
• commercelayer sku_option:remove_tags ID
• commercelayer stock_item ID
• commercelayer stock_item:validate ID
• commercelayer stock_line_item ID
• commercelayer stock_line_item:decrement_stock ID
• commercelayer stock_line_item:release_stock ID
• commercelayer stock_line_item:reserve_stock ID
• commercelayer stock_reservation ID
• commercelayer stock_reservation:pending ID
• commercelayer stock_transfer ID
• commercelayer stock_transfer:cancel ID
• commercelayer stock_transfer:complete ID
• commercelayer stock_transfer:in_transit ID
• commercelayer stock_transfer:on_hold ID
• commercelayer stock_transfer:picking ID
• commercelayer stock_transfer:upcoming ID
• commercelayer stripe_gateway ID
• commercelayer stripe_gateway:disable ID
• commercelayer stripe_gateway:enable ID
• commercelayer stripe_payment ID
• commercelayer stripe_payment:refresh ID
• commercelayer stripe_payment:update ID
• commercelayer vertex_account ID
• commercelayer vertex_account:refresh_token ID
• commercelayer void ID
• commercelayer void:forward ID
• commercelayer webhook ID
• commercelayer webhook:disable ID
• commercelayer webhook:enable ID
• commercelayer webhook:reset_circuit ID

commercelayer address ID

Execute an action on a resource of type addresses.

USAGE
  $ commercelayer address 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 addresses

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

commercelayer address:add_tags ID

Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.

USAGE
  $ commercelayer address:add_tags 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
  Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by
  sales channels.

See code: src/commands/address/add_tags.ts

commercelayer address:remove_tags ID

Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.

USAGE
  $ commercelayer address:remove_tags 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
  Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed
  by sales channels.

See code: src/commands/address/remove_tags.ts

commercelayer adyen_gateway ID

Execute an action on a resource of type adyen_gateways.

USAGE
  $ commercelayer adyen_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 adyen_gateways

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

commercelayer adyen_gateway:disable ID

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

USAGE
  $ commercelayer adyen_gateway: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/adyen_gateway/disable.ts

commercelayer adyen_gateway:enable ID

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

USAGE
  $ commercelayer adyen_gateway: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/adyen_gateway/enable.ts

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:authorize ID

Send this attribute if you want to authorize the payment.

USAGE
  $ commercelayer adyen_payment: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 payment.

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

commercelayer adyen_payment:balance ID

Send this attribute if you want retrieve the balance remaining on a shopper's gift card.

USAGE
  $ commercelayer adyen_payment:balance 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 retrieve the balance remaining on a shopper's gift card.

See code: src/commands/adyen_payment/balance.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:cancel ID

Send this attribute if you want to void a succeeded authorization of a pending order (which is left unpaid).

USAGE
  $ commercelayer authorization: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 void a succeeded authorization of a pending order (which is left unpaid).

See code: src/commands/authorization/cancel.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

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

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

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

commercelayer authorization:forward ID

Send this attribute if you want to forward a stuck transaction to succeeded and update associated order states accordingly.

USAGE
  $ commercelayer authorization:forward 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 forward a stuck transaction to succeeded and update associated order states
  accordingly.

See code: src/commands/authorization/forward.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_gateway ID

Execute an action on a resource of type axerve_gateways.

USAGE
  $ commercelayer axerve_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 axerve_gateways

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

commercelayer axerve_gateway:disable ID

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

USAGE
  $ commercelayer axerve_gateway: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/axerve_gateway/disable.ts

commercelayer axerve_gateway:enable ID

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

USAGE
  $ commercelayer axerve_gateway: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/axerve_gateway/enable.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 braintree_gateway ID

Execute an action on a resource of type braintree_gateways.

USAGE
  $ commercelayer braintree_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 braintree_gateways

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

commercelayer braintree_gateway:disable ID

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

USAGE
  $ commercelayer braintree_gateway: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/braintree_gateway/disable.ts

commercelayer braintree_gateway:enable ID

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

USAGE
  $ commercelayer braintree_gateway: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/braintree_gateway/enable.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:add_tags ID

Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.

USAGE
  $ commercelayer bundle:add_tags 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
  Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by
  sales channels.

See code: src/commands/bundle/add_tags.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 bundle:remove_tags ID

Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.

USAGE
  $ commercelayer bundle:remove_tags 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
  Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed
  by sales channels.

See code: src/commands/bundle/remove_tags.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:add_tags ID

Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.

USAGE
  $ commercelayer buy_x_pay_y_promotion:add_tags 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
  Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by
  sales channels.

See code: src/commands/buy_x_pay_y_promotion/add_tags.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 buy_x_pay_y_promotion:remove_tags ID

Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.

USAGE
  $ commercelayer buy_x_pay_y_promotion:remove_tags 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
  Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed
  by sales channels.

See code: src/commands/buy_x_pay_y_promotion/remove_tags.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:cancel ID

Send this attribute if you want to refund a succeeded capture of a pending order (which is left unpaid).

USAGE
  $ commercelayer capture: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 refund a succeeded capture of a pending order (which is left unpaid).

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

commercelayer capture:forward ID

Send this attribute if you want to forward a stuck transaction to succeeded and update associated order states accordingly.

USAGE
  $ commercelayer capture:forward 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 forward a stuck transaction to succeeded and update associated order states
  accordingly.

See code: src/commands/capture/forward.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

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

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

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

commercelayer checkout_com_gateway ID

Execute an action on a resource of type checkout_com_gateways.

USAGE
  $ commercelayer checkout_com_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 checkout_com_gateways

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

commercelayer checkout_com_gateway:disable ID

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

USAGE
  $ commercelayer checkout_com_gateway: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/checkout_com_gateway/disable.ts

commercelayer checkout_com_gateway:enable ID

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

USAGE
  $ commercelayer checkout_com_gateway: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/checkout_com_gateway/enable.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 cleanup ID

Execute an action on a resource of type cleanups.

USAGE
  $ commercelayer cleanup 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 cleanups

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

commercelayer cleanup:interrupt ID

Send this attribute if you want to mark status as 'interrupted'.

USAGE
  $ commercelayer cleanup:interrupt 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 status as 'interrupted'.

See code: src/commands/cleanup/interrupt.ts

commercelayer coupon ID

Execute an action on a resource of type coupons.

USAGE
  $ commercelayer coupon 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 coupons

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

commercelayer coupon:add_tags ID

Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.

USAGE
  $ commercelayer coupon:add_tags 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
  Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by
  sales channels.

See code: src/commands/coupon/add_tags.ts

commercelayer coupon:remove_tags ID

Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.

USAGE
  $ commercelayer coupon:remove_tags 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
  Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed
  by sales channels.

See code: src/commands/coupon/remove_tags.ts

commercelayer customer ID

Execute an action on a resource of type customers.

USAGE
  $ commercelayer customer 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 customers

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

commercelayer customer:add_tags ID

Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.

USAGE
  $ commercelayer customer:add_tags 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
  Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by
  sales channels.

See code: src/commands/customer/add_tags.ts

commercelayer customer:cancel_anonymization ID

Send this attribute if you want to trigger a cancellation of anonymization. Cannot be passed by sales channels.

USAGE
  $ commercelayer customer:cancel_anonymization 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 trigger a cancellation of anonymization. Cannot be passed by sales channels.

See code: src/commands/customer/cancel_anonymization.ts

commercelayer customer:remove_tags ID

Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.

USAGE
  $ commercelayer customer:remove_tags 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
  Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed
  by sales channels.

See code: src/commands/customer/remove_tags.ts

commercelayer customer:request_anonymization ID

Send this attribute if you want to trigger anonymization. Cannot be passed by sales channels.

USAGE
  $ commercelayer customer:request_anonymization 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 trigger anonymization. Cannot be passed by sales channels.

See code: src/commands/customer/request_anonymization.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 easypost_pickup ID

Execute an action on a resource of type easypost_pickups.

USAGE
  $ commercelayer easypost_pickup 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 easypost_pickups

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

commercelayer easypost_pickup:purchase ID

Send this attribute if you want to purchase this pick up with the selected rate.

USAGE
  $ commercelayer easypost_pickup: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 purchase this pick up with the selected rate.

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

commercelayer event ID

Execute an action on a resource of type events.

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

ARGUMENTS
  ID  the unique id of the resource

FLAGS
  -j, --json         print result in JSON format
  -p, --print        p