@commercelayer/cli-plugin-triggers
v4.9.1
Published
Commerce Layer CLI Triggers plugin
Downloads
104
Readme
commercelayer-cli-plugin-triggers
Commerce Layer CLI Triggers plugin
Usage
commercelayer COMMAND
commercelayer [COMMAND] (--help | -h) for detailed information about plugin commands.
To install as a Commerce Layer CLI plugin run the following command:
$ commercelayer plugins:install triggers
Commands
commercelayer adyen_payment ID
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_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:cancel ID
commercelayer capture:forward 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 event ID
commercelayer event:trigger ID
commercelayer external_gateway ID
commercelayer external_gateway:reset_circuit ID
commercelayer external_promotion ID
commercelayer external_promotion:disable ID
commercelayer external_promotion:enable 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: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 flex_promotion ID
commercelayer flex_promotion:disable ID
commercelayer flex_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 line_item:reset_circuit ID
commercelayer link ID
commercelayer link:disable ID
commercelayer link:enable 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: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: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:cancel ID
commercelayer order_subscription:convert 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 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: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: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: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: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 shipping_method:reset_circuit 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_payment ID
commercelayer stripe_payment:refresh ID
commercelayer stripe_payment:update 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 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: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_payment ID
Execute an action on a resource of type axerve_payments.
USAGE
$ commercelayer axerve_payment ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type axerve_payments
See code: src/commands/axerve_payment/index.ts
commercelayer axerve_payment:update ID
Send this attribute if you want to update the payment with fresh order data.
USAGE
$ commercelayer axerve_payment:update ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to update the payment with fresh order data.
See code: src/commands/axerve_payment/update.ts
commercelayer bundle ID
Execute an action on a resource of type bundles.
USAGE
$ commercelayer bundle ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type bundles
See code: src/commands/bundle/index.ts
commercelayer bundle:compute_compare_at_amount ID
Send this attribute if you want to compute the compare_at_amount_cents as the sum of the prices of the bundle SKUs for the market.
USAGE
$ commercelayer bundle:compute_compare_at_amount ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to compute the compare_at_amount_cents as the sum of the prices of the bundle SKUs for
the market.
See code: src/commands/bundle/compute_compare_at_amount.ts
commercelayer bundle:compute_price_amount ID
Send this attribute if you want to compute the price_amount_cents as the sum of the prices of the bundle SKUs for the market.
USAGE
$ commercelayer bundle:compute_price_amount ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to compute the price_amount_cents as the sum of the prices of the bundle SKUs for the
market.
See code: src/commands/bundle/compute_price_amount.ts
commercelayer buy_x_pay_y_promotion ID
Execute an action on a resource of type buy_x_pay_y_promotions.
USAGE
$ commercelayer buy_x_pay_y_promotion ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type buy_x_pay_y_promotions
See code: src/commands/buy_x_pay_y_promotion/index.ts
commercelayer buy_x_pay_y_promotion:disable ID
Send this attribute if you want to mark this resource as disabled.
USAGE
$ commercelayer buy_x_pay_y_promotion:disable ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to mark this resource as disabled.
See code: src/commands/buy_x_pay_y_promotion/disable.ts
commercelayer buy_x_pay_y_promotion:enable ID
Send this attribute if you want to mark this resource as enabled.
USAGE
$ commercelayer buy_x_pay_y_promotion:enable ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to mark this resource as enabled.
See code: src/commands/buy_x_pay_y_promotion/enable.ts
commercelayer capture ID
Execute an action on a resource of type captures.
USAGE
$ commercelayer capture ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type captures
See code: src/commands/capture/index.ts
commercelayer capture: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_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 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 print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type events
See code: src/commands/event/index.ts
commercelayer event:trigger ID
Send this attribute if you want to force webhooks execution for this event. Cannot be passed by sales channels.
USAGE
$ commercelayer event:trigger ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the 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 webhooks execution for this event. Cannot be passed by sales channels.
See code: src/commands/event/trigger.ts
commercelayer external_gateway ID
Execute an action on a resource of type external_gateways.
USAGE
$ commercelayer external_gateway ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type external_gateways
See code: src/commands/external_gateway/index.ts
commercelayer external_gateway:reset_circuit ID
Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count. Cannot be passed by sales channels.
USAGE
$ commercelayer external_gateway:reset_circuit ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero
failures count. Cannot be passed by sales channels.
See code: src/commands/external_gateway/reset_circuit.ts
commercelayer external_promotion ID
Execute an action on a resource of type external_promotions.
USAGE
$ commercelayer external_promotion ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type external_promotions
See code: src/commands/external_promotion/index.ts
commercelayer external_promotion:disable ID
Send this attribute if you want to mark this resource as disabled.
USAGE
$ commercelayer external_promotion:disable ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to mark this resource as disabled.
See code: src/commands/external_promotion/disable.ts
commercelayer external_promotion:enable ID
Send this attribute if you want to mark this resource as enabled.
USAGE
$ commercelayer external_promotion:enable ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to mark this resource as enabled.
See code: src/commands/external_promotion/enable.ts
commercelayer external_promotion:reset_circuit ID
Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count. Cannot be passed by sales channels.
USAGE
$ commercelayer external_promotion:reset_circuit ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero
failures count. Cannot be passed by sales channels.
See code: src/commands/external_promotion/reset_circuit.ts
commercelayer external_tax_calculator ID
Execute an action on a resource of type external_tax_calculators.
USAGE
$ commercelayer external_tax_calculator ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type external_tax_calculators
See code: src/commands/external_tax_calculator/index.ts
commercelayer external_tax_calculator:reset_circuit ID
Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count. Cannot be passed by sales channels.
USAGE
$ commercelayer external_tax_calculator:reset_circuit ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero
failures count. Cannot be passed by sales channels.
See code: src/commands/external_tax_calculator/reset_circuit.ts
commercelayer fixed_amount_promotion ID
Execute an action on a resource of type fixed_amount_promotions.
USAGE
$ commercelayer fixed_amount_promotion ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type fixed_amount_promotions
See code: src/commands/fixed_amount_promotion/index.ts
commercelayer fixed_amount_promotion:disable ID
Send this attribute if you want to mark this resource as disabled.
USAGE
$ commercelayer fixed_amount_promotion:disable ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to mark this resource as disabled.
See code: src/commands/fixed_amount_promotion/disable.ts
commercelayer fixed_amount_promotion:enable ID
Send this attribute if you want to mark this resource as enabled.
USAGE
$ commercelayer fixed_amount_promotion:enable ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to mark this resource as enabled.
See code: src/commands/fixed_amount_promotion/enable.ts
commercelayer fixed_price_promotion ID
Execute an action on a resource of type fixed_price_promotions.
USAGE
$ commercelayer fixed_price_promotion ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type fixed_price_promotions
See code: src/commands/fixed_price_promotion/index.ts
commercelayer fixed_price_promotion:disable ID
Send this attribute if you want to mark this resource as disabled.
USAGE
$ commercelayer fixed_price_promotion:disable ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to mark this resource as disabled.
See code: src/commands/fixed_price_promotion/disable.ts
commercelayer fixed_price_promotion:enable ID
Send this attribute if you want to mark this resource as enabled.
USAGE
$ commercelayer fixed_price_promotion:enable ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to mark this resource as enabled.
See code: src/commands/fixed_price_promotion/enable.ts
commercelayer flex_promotion ID
Execute an action on a resource of type flex_promotions.
USAGE
$ commercelayer flex_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 flex_promotions
See code: src/commands/flex_promotion/index.ts
commercelayer flex_promotion:disable ID
Send this attribute if you want to mark this resource as disabled.
USAGE
$ commercelayer flex_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/flex_promotion/disable.ts
commercelayer flex_promotion:enable ID
Send this attribute if you want to mark this resource as enabled.
USAGE
$ commercelayer flex_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/flex_promotion/enable.ts
commercelayer free_gift_promotion ID
Execute an action on a resource of type free_gift_promotions.
USAGE
$ commercelayer free_gift_promotion ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type free_gift_promotions
See code: src/commands/free_gift_promotion/index.ts
commercelayer free_gift_promotion:disable ID
Send this attribute if you want to mark this resource as disabled.
USAGE
$ commercelayer free_gift_promotion:disable ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to mark this resource as disabled.
See code: src/commands/free_gift_promotion/disable.ts
commercelayer free_gift_promotion:enable ID
Send this attribute if you want to mark this resource as enabled.
USAGE
$ commercelayer free_gift_promotion:enable ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to mark this resource as enabled.
See code: src/commands/free_gift_promotion/enable.ts
commercelayer free_shipping_promotion ID
Execute an action on a resource of type free_shipping_promotions.
USAGE
$ commercelayer free_shipping_promotion ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type free_shipping_promotions
See code: src/commands/free_shipping_promotion/index.ts
commercelayer free_shipping_promotion:disable ID
Send this attribute if you want to mark this resource as disabled.
USAGE
$ commercelayer free_shipping_promotion:disable ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to mark this resource as disabled.
See code: src/commands/free_shipping_promotion/disable.ts
commercelayer free_shipping_promotion:enable ID
Send this attribute if you want to mark this resource as enabled.
USAGE
$ commercelayer free_shipping_promotion:enable ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to mark this resource as enabled.
See code: src/commands/free_shipping_promotion/enable.ts
commercelayer gift_card ID
Execute an action on a resource of type gift_cards.
USAGE
$ commercelayer gift_card ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type gift_cards
See code: src/commands/gift_card/index.ts
commercelayer gift_card:activate ID
Send this attribute if you want to activate a gift card.
USAGE
$ commercelayer gift_card:activate ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to activate a gift card.
See code: src/commands/gift_card/activate.ts
commercelayer gift_card:balance_change_cents ID
The balance change, in cents. Send a negative value to reduces the card balance by the specified amount. Send a positive value to recharge the gift card (if rechargeable).
USAGE
$ commercelayer gift_card:balance_change_cents ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
The balance change, in cents. Send a negative value to reduces the card balance by the specified amount. Send a
positive value to recharge the gift card (if rechargeable).
See code: src/commands/gift_card/balance_change_cents.ts
commercelayer gift_card:deactivate ID
Send this attribute if you want to deactivate a gift card.
USAGE
$ commercelayer gift_card:deactivate ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to deactivate a gift card.
See code: src/commands/gift_card/deactivate.ts
commercelayer gift_card:purchase ID
Send this attribute if you want to confirm a draft gift card. The gift card becomes 'inactive', waiting to be activated.
USAGE
$ commercelayer gift_card:purchase ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to confirm a draft gift card. The gift card becomes 'inactive', waiting to be
activated.
See code: src/commands/gift_card/purchase.ts
commercelayer in_stock_subscription ID
Execute an action on a resource of type in_stock_subscriptions.
USAGE
$ commercelayer in_stock_subscription ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type in_stock_subscriptions
See code: src/commands/in_stock_subscription/index.ts
commercelayer in_stock_subscription:activate ID
Send this attribute if you want to activate an inactive subscription.
USAGE
$ commercelayer in_stock_subscription:activate ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to activate an inactive subscription.
See code: src/commands/in_stock_subscription/activate.ts
commercelayer in_stock_subscription:deactivate ID
Send this attribute if you want to dactivate an active subscription.
USAGE
$ commercelayer in_stock_subscription:deactivate ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to dactivate an active subscription.
See code: src/commands/in_stock_subscription/deactivate.ts
commercelayer klarna_payment ID
Execute an action on a resource of type klarna_payments.
USAGE
$ commercelayer klarna_payment ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type klarna_payments
See code: src/commands/klarna_payment/index.ts
commercelayer klarna_payment:update ID
Send this attribute if you want to update the payment session with fresh order data.
USAGE
$ commercelayer klarna_payment:update ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to update the payment session with fresh order data.
See code: src/commands/klarna_payment/update.ts
commercelayer line_item ID
Execute an action on a resource of type line_items.
USAGE
$ commercelayer line_item ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type line_items
See code: src/commands/line_item/index.ts
commercelayer line_item:external_price ID
When creating or updating a new line item, set this attribute to '1' if you want to inject the unit_amount_cents price from an external source. Any successive price computation will be done externally, until the attribute is reset to '0'.
USAGE
$ commercelayer line_item:external_price ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
When creating or updating a new line item, set this attribute to '1' if you want to inject the unit_amount_cents price
from an external source. Any successive price computation will be done externally, until the attribute is reset to
'0'.
See code: src/commands/line_item/external_price.ts
commercelayer line_item:reserve_stock ID
Send this attribute if you want to reserve the stock for the line item's SKUs quantity. Stock reservations expiration depends on the inventory model's cutoff. When used on update the existing active stock reservations are renewed. Cannot be passed by sales channels.
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.
Cannot be passed by sales channels.
See code: src/commands/line_item/reserve_stock.ts
commercelayer line_item:reset_circuit ID
Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero failures count. Cannot be passed by sales channels.
USAGE
$ commercelayer line_item:reset_circuit ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to reset the circuit breaker associated to this resource to 'closed' state and zero
failures count. Cannot be passed by sales channels.
See code: src/commands/line_item/reset_circuit.ts
commercelayer link ID
Execute an action on a resource of type links.
USAGE
$ commercelayer link ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the 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 links
See code: src/commands/link/index.ts
commercelayer link:disable ID
Send this attribute if you want to mark this resource as disabled.
USAGE
$ commercelayer link: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/link/disable.ts
commercelayer link:enable ID
Send this attribute if you want to mark this resource as enabled.
USAGE
$ commercelayer link: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/link/enable.ts
commercelayer market ID
Execute an action on a resource of type markets.
USAGE
$ commercelayer market ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type markets
See code: src/commands/market/index.ts
commercelayer market:disable ID
Send this attribute if you want to mark this resource as disabled.
USAGE
$ commercelayer market:disable ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to mark this resource as disabled.
See code: src/commands/market/disable.ts
commercelayer market:enable ID
Send this attribute if you want to mark this resource as enabled.
USAGE
$ commercelayer market:enable ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want