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 adyen_payment ID
• commercelayer adyen_payment:details ID
• commercelayer authorization ID
• commercelayer authorization:capture ID
• commercelayer authorization:capture_amount_cents ID
• commercelayer authorization:void ID
• commercelayer axerve_payment ID
• commercelayer axerve_payment:update ID
• commercelayer bundle ID
• commercelayer bundle:compute_compare_at_amount ID
• commercelayer bundle:compute_price_amount ID
• commercelayer buy_x_pay_y_promotion ID
• commercelayer buy_x_pay_y_promotion:disable ID
• commercelayer buy_x_pay_y_promotion:enable ID
• commercelayer capture ID
• commercelayer capture:refund ID
• commercelayer capture:refund_amount_cents ID
• commercelayer checkout_com_payment ID
• commercelayer checkout_com_payment:details ID
• commercelayer checkout_com_payment:refresh ID
• commercelayer customer_password_reset ID
• commercelayer customer_password_reset:reset_password_token ID
• commercelayer external_promotion ID
• commercelayer external_promotion:disable ID
• commercelayer external_promotion:enable ID
• commercelayer fixed_amount_promotion ID
• commercelayer fixed_amount_promotion:disable ID
• commercelayer fixed_amount_promotion:enable ID
• commercelayer fixed_price_promotion ID
• commercelayer fixed_price_promotion:disable ID
• commercelayer fixed_price_promotion:enable ID
• commercelayer free_gift_promotion ID
• commercelayer free_gift_promotion:disable ID
• commercelayer free_gift_promotion:enable ID
• commercelayer free_shipping_promotion ID
• commercelayer free_shipping_promotion:disable ID
• commercelayer free_shipping_promotion:enable ID
• commercelayer gift_card ID
• commercelayer gift_card:activate ID
• commercelayer gift_card:balance_change_cents ID
• commercelayer gift_card:deactivate ID
• commercelayer gift_card:purchase ID
• commercelayer in_stock_subscription ID
• commercelayer in_stock_subscription:activate ID
• commercelayer in_stock_subscription:deactivate ID
• commercelayer klarna_payment ID
• commercelayer klarna_payment:update ID
• commercelayer line_item ID
• commercelayer line_item:external_price ID
• commercelayer line_item:reserve_stock ID
• commercelayer market ID
• commercelayer market:disable ID
• commercelayer market:enable ID
• commercelayer order 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:nullify_payment_source ID
• commercelayer order:place ID
• commercelayer order:refresh ID
• commercelayer order:refund ID
• commercelayer order:refund_invoice 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:cancel ID
• commercelayer order_subscription:deactivate ID
• commercelayer payment_method ID
• commercelayer payment_method:disable ID
• commercelayer payment_method:enable ID
• commercelayer percentage_discount_promotion ID
• commercelayer percentage_discount_promotion:disable ID
• commercelayer percentage_discount_promotion:enable ID
• commercelayer return ID
• commercelayer return:approve ID
• commercelayer return:archive ID
• commercelayer return:cancel ID
• commercelayer return:receive ID
• commercelayer return:reject 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_payment ID
• commercelayer satispay_payment:refresh ID
• commercelayer shipment ID
• commercelayer shipment:decrement_stock 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:reserve_stock ID
• commercelayer shipment:ship ID
• commercelayer shipment:upcoming ID
• commercelayer shipping_method ID
• commercelayer shipping_method:disable ID
• commercelayer shipping_method:enable 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_payment ID
• commercelayer stripe_payment:refresh ID
• commercelayer stripe_payment:update ID
• commercelayer webhook ID
• commercelayer webhook:reset_circuit ID

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 the promotion 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 the promotion 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 the promotion 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 the promotion 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_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 the promotion 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 the promotion as disabled.

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

commercelayer external_promotion:enable ID

Send this attribute if you want to mark the promotion 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 the promotion as enabled.

See code: src/commands/external_promotion/enable.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 the promotion 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 the promotion 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 the promotion 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 the promotion 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 the promotion 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 the promotion 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 the promotion 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 the promotion 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 the promotion 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 the promotion 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 the promotion 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 the promotion 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 the promotion 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 the promotion 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 the promotion 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 the promotion 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 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 the market 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 the market as disabled.

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

commercelayer market:enable ID

Send this attribute if you want to mark the market 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 the market 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:place ID

Send this attribute if you want to place the order.

USAGE
  $ commercelayer order:place 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 place the order.

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

commercelayer order:refresh ID

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

USAGE
  $ commercelayer order: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 manually refresh the order.

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

commercelayer order:refund ID

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

USAGE
  $ commercelayer order: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 refund a captured order.

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

commercelayer order: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 order:refund_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 refund the sales tax invoice to the associated tax calculator (currently supported by
  Avalara).

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

commercelayer order: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 order:save_billing_address_to_customer_address_book 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 order's billing address to be saved in the customer's address book as a customer
  address.

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

commercelayer order: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 order:save_payment_source_to_customer_wallet 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 order's payment source to be saved in the customer's wallet as a customer payment
  source.

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

commercelayer order: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 order:save_shipping_address_to_customer_address_book 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 order's shipping address to be saved in the customer's address book as a customer
  address.

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

commercelayer order:shipping_address_clone_id ID

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

USAGE
  $ commercelayer order:shipping_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 shipping address.

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

commercelayer order: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 order:shipping_address_same_as_billing 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 shipping address to be cloned from the order's billing address.

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

commercelayer order: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.

USAGE
  $ commercelayer order:start_editing 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 edit the order after it is placed. Remember you cannot exceed the original total
  amount.

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

commercelayer order:stop_editing ID

Send this attribute to stop the editing for the order and return back to placed status.

USAGE
  $ commercelayer order:stop_editing 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 to stop the editing for the order and return back to placed status.

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

commercelayer order:unarchive ID

Send this attribute if you want to unarchive the order.

USAGE
  $ commercelayer order:unarchive 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 unarchive the order.

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

commercelayer order: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 order:update_taxes 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 force tax calculation for this order (a tax calculator must be associated to the
  order's market).

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

commercelayer order:validate ID

Send this attribute if you want to trigger the external validation for the order.

USAGE
  $ commercelayer order:validate 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 the external validation for the order.

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

commercelayer order_subscription ID

Execute an action on a resource of type order_subscriptions.

USAGE
  $ commercelayer order_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 order_subscriptions

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

commercelayer order_subscription:activate ID

Send this attribute if you want to mark this subscription as active.

USAGE
  $ commercelayer order_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 mark this subscription as active.

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

commercelayer order_subscription:cancel ID

Send this attribute if you want to mark this subscription as cancelled.

USAGE
  $ commercelayer order_subscription: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 mark this subscription as cancelled.

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

commercelayer order_subscription:deactivate ID

Send this attribute if you want to mark this subscription as inactive.

USAGE
  $ commercelayer order_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 mark this subscription as inactive.

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

commercelayer payment_method ID

Execute an action on a resource of type payment_methods.

USAGE
  $ commercelayer payment_method 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 payment_methods

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

commercelayer payment_method:disable ID

Send this attribute if you want to mark the payment method as disabled.

USAGE
  $ commercelayer payment_method: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 the payment method as disabled.

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

commercelayer payment_method:enable ID

Send this attribute if you want to mark the payment method as enabled.

USAGE
  $ commercelayer payment_method: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 the payment method as enabled.

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

commercelayer percentage_discount_promotion ID

Execute an action on a resource of type percentage_discount_promotions.

USAGE
  $ commercelayer percentage_discount_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 percentage_discount_promotions

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

commercelayer percentage_discount_promotion:disable ID

Send this attribute if you want to mark the promotion as disabled.

USAGE
  $ commercelayer percentage_discount_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 the promotion as disabled.

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

commercelayer percentage_discount_promotion:enable ID

Send this attribute if you want to mark the promotion as enabled.

USAGE
  $ commercelayer percentage_discount_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 the promotion as enabled.

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

commercelayer return ID

Execute an action on a resource of type returns.

USAGE
  $ commercelayer return 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 returns

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

commercelayer return:approve ID

Send this attribute if you want to mark this return as approved.

USAGE
  $ commercelayer return: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 mark this return as approved.

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

commercelayer return:archive ID

Send this attribute if you want to archive the return.

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

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

commercelayer return:cancel ID

Send this attribute if you want to mark this return as cancelled.

USAGE
  $ commercelayer return: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 mark this return as cancelled.

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

commercelayer return:receive ID

Send this attribute if you want to mark this return as received.

USAGE
  $ commercelayer return:receive 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 return as received.

See code: src/commands/return/receive.ts

commercelayer return:reject ID

Send this attribute if you want to mark this return as rejected.

USAGE
  $ commercelayer return:reject 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 return as rejected.

See code: src/commands/return/reject.ts

commercelayer return:request ID

Send this attribute if you want to activate this return.

USAGE
  $ commercelayer return:request 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 this return.

See code: src/commands/return/request.ts

commercelayer return:restock ID

Send this attribute if you want to restock all of the return line items.

USAGE
  $ commercelayer return:restock 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 restock all of the return line items.

See code: src/commands/return/restock.ts

commercelayer return:ship ID

Send this attribute if you want to mark this return as shipped.

USAGE
  $ commercelayer return:ship 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 return as shipped.

See code: src/commands/return/ship.ts

commercelayer return:unarchive ID

Send this attribute if you want to unarchive the return.

USAGE
  $ commercelayer return:unarchive 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 unarchive the return.

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

commercelayer return_line_item ID

Execute an action on a resource of type return_line_items.

USAGE
  $ commercelayer return_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 return_line_items

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

commercelayer return_line_item:restock ID

Send this attribute if you want to restock the line item.

USAGE
  $ commercelayer return_line_item:restock 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 restock the line item.

See code: src/commands/return_line_item/restock.ts

commercelayer satispay_payment ID

Execute an action on a resource of type satispay_payments.

USAGE
  $ commercelayer satispay_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 satispay_payments

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

commercelayer satispay_payment:refresh ID

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

USAGE
  $ commercelayer satispay_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/satispay_payment/refresh.ts

commercelayer shipment ID

Execute an action on a resource of type shipments.

USAGE
  $ commercelayer shipment 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 shipments

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

commercelayer shipment:decrement_stock ID

Send this attribute if you want to automatically decrement and release the stock for each of the associated stock line item. Can be done only when fulfillment is in progress.

USAGE
  $ commercelayer shipment:decrement_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 automatically decrement and release the stock for each of the associated stock line
  item. Can be done only when fulfillment is in progress.

See code: src/commands/shipment/decrement_stock.ts

commercelayer shipment:get_rates ID

Send this attribute if you want get the shipping rates from the associated carrier accounts.

USAGE
  $ commercelayer shipment:get_rates 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 get the shipping rates from the associated carrier accounts.

See code: src/commands/shipment/get_rates.ts

commercelayer shipment:on_hold ID

Send this attribute if you want to put this shipment on hold.

USAGE
  $ commercelayer shipment:on_hold 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 put this shipment on hold.

See code: src/commands/shipment/on_hold.ts

commercelayer shipment:packing ID

Send this attribute if you want to start packing this shipment.

USAGE
  $ commercelayer shipment:packing 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 start packing this shipment.

See code: src/commands/shipment/packing.ts

commercelayer shipment:picking ID

Send this attribute if you want to start picking this shipment.

USAGE
  $ commercelayer shipment:picking 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 start picking this shipment.

See code: src/commands/shipment/picking.ts

commercelayer shipment:purchase ID

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

USAGE
  $ commercelayer shipment: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 shipment with the selected rate.

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

commercelayer shipment:ready_to_ship ID

Send this attribute if you want to mark this shipment as ready to ship.

USAGE
  $ commercelayer shipment:ready_to_ship 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 shipment as ready to ship.

See code: src/commands/shipment/ready_to_ship.ts

commercelayer shipment:release_stock ID

Send this attribute if you want to automatically release the stock for each of the associated stock line item. Can be done only when fulfillment is in progress.

USAGE
  $ commercelayer shipment:release_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 automatically release the stock for each of the associated stock line item. Can be
  done only when fulfillment is in progress.

See code: src/commands/shipment/release_stock.ts

commercelayer shipment:reserve_stock ID

Send this attribute if you want to automatically reserve the stock for each of the associated stock line item. Can be done only when fulfillment is in progress.

USAGE
  $ commercelayer shipment: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 automatically reserve the stock for each of the associated stock line item. Can be
  done only when fulfillment is in progress.

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

commercelayer shipment:ship ID

Send this attribute if you want to mark this shipment as shipped.

USAGE
  $ commercelayer shipment:ship 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 shipment as shipped.

See code: src/commands/shipment/ship.ts

commercelayer shipment:upcoming ID

Send this attribute if you want to mark this shipment as upcoming.

USAGE
  $ commercelayer shipment:upcoming 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 shipment as upcoming.

See code: src/commands/shipment/upcoming.ts

commercelayer shipping_method ID

Execute an action on a resource of type shipping_methods.

USAGE
  $ commercelayer shipping_method 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 shipping_methods

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

commercelayer shipping_method:disable ID

Send this attribute if you want to mark the shipping method as disabled.

USAGE
  $ commercelayer shipping_method: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 the shipping method as disabled.

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

commercelayer shipping_method:enable ID

Send this attribute if you want to mark the shipping method as enabled.

USAGE
  $ commercelayer shipping_method: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 the shipping method as enabled.

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

commercelayer stock_reservation ID

Execute an action on a resource of type stock_reservations.

USAGE
  $ commercelayer stock_reservation 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 stock_reservations

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

commercelayer stock_reservation:pending ID

Send this attribute if you want to mark this stock reservation as pending.

USAGE
  $ commercelayer stock_reservation: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 without indentation

DESCRIPTION
  Send this attribute if you want to mark this stock reservation as pending.

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

commercelayer stock_transfer ID

Execute an action on a resource of type stock_transfers.

USAGE
  $ commercelayer stock_transfer 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 stock_transfers

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

commercelayer stock_transfer:cancel ID

Send this attribute if you want to cancel this stock transfer.

USAGE
  $ commercelayer stock_transfer: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 this stock transfer.

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

commercelayer stock_transfer:complete ID

Send this attribute if you want to complete this stock transfer.

USAGE
  $ commercelayer stock_transfer:complete 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 complete this stock transfer.

See code: src/commands/stock_transfer/complete.ts

commercelayer stock_transfer:in_transit ID

Send this attribute if you want to mark this stock transfer as in transit.

USAGE
  $ commercelayer stock_transfer:in_transit 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 stock transfer as in transit.

See code: src/commands/stock_transfer/in_transit.ts

commercelayer stock_transfer:on_hold ID

Send this attribute if you want to put this stock transfer on hold.

USAGE
  $ commercelayer stock_transfer:on_hold 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 put this stock transfer on hold.

See code: src/commands/stock_transfer/on_hold.ts

commercelayer stock_transfer:picking ID

Send this attribute if you want to start picking this stock transfer.

USAGE
  $ commercelayer stock_transfer:picking 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 start picking this stock transfer.

See code: src/commands/stock_transfer/picking.ts

commercelayer stock_transfer:upcoming ID

Send this attribute if you want to mark this stock transfer as upcoming.

USAGE
  $ commercelayer stock_transfer:upcoming 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 stock transfer as upcoming.

See code: src/commands/stock_transfer/upcoming.ts

commercelayer stripe_payment ID

Execute an action on a resource of type stripe_payments.

USAGE
  $ commercelayer stripe_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 stripe_payments

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

commercelayer stripe_payment:refresh ID

Send this attribute if you want to refresh the payment status, can be used as webhooks fallback logic.

USAGE
  $ commercelayer stripe_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 the payment status, can be used as webhooks fallback logic.

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

commercelayer stripe_payment:update ID

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

USAGE
  $ commercelayer stripe_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 created payment intent with fresh order data.

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

commercelayer webhook ID

Execute an action on a resource of type webhooks.

USAGE
  $ commercelayer webhook 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 webhooks

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

commercelayer webhook:reset_circuit ID

Send this attribute if you want to reset the circuit breaker associated to this webhook to 'closed' state and zero failures count.

USAGE
  $ commercelayer webhook: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 webhook to 'closed' state and zero
  failures count.

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