@commercelayer/cli-plugin-triggers v4.14.0
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 triggersCommands
commercelayer address IDcommercelayer address:add_tags IDcommercelayer address:remove_tags IDcommercelayer adyen_payment IDcommercelayer adyen_payment:authorize IDcommercelayer adyen_payment:balance IDcommercelayer adyen_payment:details IDcommercelayer authorization IDcommercelayer authorization:cancel IDcommercelayer authorization:capture IDcommercelayer authorization:capture_amount_cents IDcommercelayer authorization:forward IDcommercelayer authorization:void IDcommercelayer axerve_payment IDcommercelayer axerve_payment:update IDcommercelayer bundle IDcommercelayer bundle:add_tags IDcommercelayer bundle:compute_compare_at_amount IDcommercelayer bundle:compute_price_amount IDcommercelayer bundle:remove_tags IDcommercelayer buy_x_pay_y_promotion IDcommercelayer buy_x_pay_y_promotion:add_tags IDcommercelayer buy_x_pay_y_promotion:disable IDcommercelayer buy_x_pay_y_promotion:enable IDcommercelayer buy_x_pay_y_promotion:remove_tags IDcommercelayer capture IDcommercelayer capture:cancel IDcommercelayer capture:forward IDcommercelayer capture:refund IDcommercelayer capture:refund_amount_cents IDcommercelayer checkout_com_payment IDcommercelayer checkout_com_payment:details IDcommercelayer checkout_com_payment:refresh IDcommercelayer cleanup IDcommercelayer cleanup:interrupt IDcommercelayer coupon IDcommercelayer coupon:add_tags IDcommercelayer coupon:remove_tags IDcommercelayer customer IDcommercelayer customer:add_tags IDcommercelayer customer:cancel_anonymization IDcommercelayer customer:remove_tags IDcommercelayer customer:request_anonymization IDcommercelayer customer_password_reset IDcommercelayer customer_password_reset:reset_password_token IDcommercelayer easypost_pickup IDcommercelayer easypost_pickup:purchase IDcommercelayer event IDcommercelayer event:trigger IDcommercelayer export IDcommercelayer export:interrupt IDcommercelayer external_gateway IDcommercelayer external_gateway:reset_circuit IDcommercelayer external_promotion IDcommercelayer external_promotion:add_tags IDcommercelayer external_promotion:disable IDcommercelayer external_promotion:enable IDcommercelayer external_promotion:remove_tags IDcommercelayer external_promotion:reset_circuit IDcommercelayer external_tax_calculator IDcommercelayer external_tax_calculator:reset_circuit IDcommercelayer fixed_amount_promotion IDcommercelayer fixed_amount_promotion:add_tags IDcommercelayer fixed_amount_promotion:disable IDcommercelayer fixed_amount_promotion:enable IDcommercelayer fixed_amount_promotion:remove_tags IDcommercelayer fixed_price_promotion IDcommercelayer fixed_price_promotion:add_tags IDcommercelayer fixed_price_promotion:disable IDcommercelayer fixed_price_promotion:enable IDcommercelayer fixed_price_promotion:remove_tags IDcommercelayer flex_promotion IDcommercelayer flex_promotion:add_tags IDcommercelayer flex_promotion:disable IDcommercelayer flex_promotion:enable IDcommercelayer flex_promotion:remove_tags IDcommercelayer free_gift_promotion IDcommercelayer free_gift_promotion:add_tags IDcommercelayer free_gift_promotion:disable IDcommercelayer free_gift_promotion:enable IDcommercelayer free_gift_promotion:remove_tags IDcommercelayer free_shipping_promotion IDcommercelayer free_shipping_promotion:add_tags IDcommercelayer free_shipping_promotion:disable IDcommercelayer free_shipping_promotion:enable IDcommercelayer free_shipping_promotion:remove_tags IDcommercelayer gift_card IDcommercelayer gift_card:activate IDcommercelayer gift_card:add_tags IDcommercelayer gift_card:balance_change_cents IDcommercelayer gift_card:deactivate IDcommercelayer gift_card:purchase IDcommercelayer gift_card:remove_tags IDcommercelayer import IDcommercelayer import:interrupt IDcommercelayer in_stock_subscription IDcommercelayer in_stock_subscription:activate IDcommercelayer in_stock_subscription:deactivate IDcommercelayer klarna_payment IDcommercelayer klarna_payment:update IDcommercelayer line_item IDcommercelayer line_item:add_tags IDcommercelayer line_item:external_price IDcommercelayer line_item:remove_tags IDcommercelayer line_item:reserve_stock IDcommercelayer line_item:reset_circuit IDcommercelayer line_item_option IDcommercelayer line_item_option:add_tags IDcommercelayer line_item_option:remove_tags IDcommercelayer link IDcommercelayer link:disable IDcommercelayer link:enable IDcommercelayer market IDcommercelayer market:disable IDcommercelayer market:enable IDcommercelayer order IDcommercelayer order:add_tags IDcommercelayer order:approve IDcommercelayer order:approve_and_capture IDcommercelayer order:archive IDcommercelayer order:authorization_amount_cents IDcommercelayer order:authorize IDcommercelayer order:billing_address_clone_id IDcommercelayer order:billing_address_same_as_shipping IDcommercelayer order:cancel IDcommercelayer order:capture IDcommercelayer order:commit_invoice IDcommercelayer order:create_subscriptions IDcommercelayer order:customer_payment_source_id IDcommercelayer order:fix_payment_source IDcommercelayer order:fulfill IDcommercelayer order:nullify_payment_source IDcommercelayer order:pending IDcommercelayer order:place IDcommercelayer order:refresh IDcommercelayer order:refund IDcommercelayer order:refund_invoice IDcommercelayer order:remove_tags IDcommercelayer order:reset_circuit IDcommercelayer order:save_billing_address_to_customer_address_book IDcommercelayer order:save_payment_source_to_customer_wallet IDcommercelayer order:save_shipping_address_to_customer_address_book IDcommercelayer order:shipping_address_clone_id IDcommercelayer order:shipping_address_same_as_billing IDcommercelayer order:start_editing IDcommercelayer order:stop_editing IDcommercelayer order:unarchive IDcommercelayer order:update_taxes IDcommercelayer order:validate IDcommercelayer order_subscription IDcommercelayer order_subscription:activate IDcommercelayer order_subscription:add_tags IDcommercelayer order_subscription:cancel IDcommercelayer order_subscription:convert IDcommercelayer order_subscription:deactivate IDcommercelayer order_subscription:remove_tags IDcommercelayer payment_method IDcommercelayer payment_method:disable IDcommercelayer payment_method:enable IDcommercelayer percentage_discount_promotion IDcommercelayer percentage_discount_promotion:add_tags IDcommercelayer percentage_discount_promotion:disable IDcommercelayer percentage_discount_promotion:enable IDcommercelayer percentage_discount_promotion:remove_tags IDcommercelayer price_list_scheduler IDcommercelayer price_list_scheduler:disable IDcommercelayer price_list_scheduler:enable IDcommercelayer refund IDcommercelayer refund:forward IDcommercelayer return IDcommercelayer return:add_tags IDcommercelayer return:approve IDcommercelayer return:archive IDcommercelayer return:cancel IDcommercelayer return:receive IDcommercelayer return:refund IDcommercelayer return:refund_amount_cents IDcommercelayer return:reject IDcommercelayer return:remove_tags IDcommercelayer return:request IDcommercelayer return:restock IDcommercelayer return:ship IDcommercelayer return:unarchive IDcommercelayer return_line_item IDcommercelayer return_line_item:restock IDcommercelayer satispay_payment IDcommercelayer satispay_payment:refresh IDcommercelayer shipment IDcommercelayer shipment:add_tags IDcommercelayer shipment:cancel IDcommercelayer shipment:decrement_stock IDcommercelayer shipment:deliver IDcommercelayer shipment:get_rates IDcommercelayer shipment:on_hold IDcommercelayer shipment:packing IDcommercelayer shipment:picking IDcommercelayer shipment:purchase IDcommercelayer shipment:ready_to_ship IDcommercelayer shipment:release_stock IDcommercelayer shipment:remove_tags IDcommercelayer shipment:reserve_stock IDcommercelayer shipment:ship IDcommercelayer shipment:upcoming IDcommercelayer shipping_method IDcommercelayer shipping_method:disable IDcommercelayer shipping_method:enable IDcommercelayer shipping_method:reset_circuit IDcommercelayer sku IDcommercelayer sku:add_tags IDcommercelayer sku:remove_tags IDcommercelayer sku_option IDcommercelayer sku_option:add_tags IDcommercelayer sku_option:remove_tags IDcommercelayer stock_item IDcommercelayer stock_item:validate IDcommercelayer stock_line_item IDcommercelayer stock_line_item:decrement_stock IDcommercelayer stock_line_item:release_stock IDcommercelayer stock_line_item:reserve_stock IDcommercelayer stock_reservation IDcommercelayer stock_reservation:pending IDcommercelayer stock_transfer IDcommercelayer stock_transfer:cancel IDcommercelayer stock_transfer:complete IDcommercelayer stock_transfer:in_transit IDcommercelayer stock_transfer:on_hold IDcommercelayer stock_transfer:picking IDcommercelayer stock_transfer:upcoming IDcommercelayer stripe_payment IDcommercelayer stripe_payment:refresh IDcommercelayer stripe_payment:update IDcommercelayer vertex_account IDcommercelayer vertex_account:refresh_token IDcommercelayer void IDcommercelayer void:forward IDcommercelayer webhook IDcommercelayer webhook:disable IDcommercelayer webhook:enable IDcommercelayer webhook:reset_circuit ID
commercelayer address ID
Execute an action on a resource of type addresses.
USAGE
$ commercelayer address ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type addressesSee code: src/commands/address/index.ts
commercelayer address:add_tags ID
Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
USAGE
$ commercelayer address:add_tags ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by
sales channels.See code: src/commands/address/add_tags.ts
commercelayer address:remove_tags ID
Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
USAGE
$ commercelayer address:remove_tags ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed
by sales channels.See code: src/commands/address/remove_tags.ts
commercelayer adyen_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_paymentsSee code: src/commands/adyen_payment/index.ts
commercelayer adyen_payment:authorize ID
Send this attribute if you want to authorize the payment.
USAGE
$ commercelayer adyen_payment:authorize ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to authorize the payment.See code: src/commands/adyen_payment/authorize.ts
commercelayer adyen_payment:balance ID
Send this attribute if you want retrieve the balance remaining on a shopper's gift card.
USAGE
$ commercelayer adyen_payment:balance ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want retrieve the balance remaining on a shopper's gift card.See code: src/commands/adyen_payment/balance.ts
commercelayer adyen_payment:details ID
Send this attribute if you want to send additional details the payment request.
USAGE
$ commercelayer adyen_payment:details ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to send additional details the payment request.See code: src/commands/adyen_payment/details.ts
commercelayer authorization ID
Execute an action on a resource of type authorizations.
USAGE
$ commercelayer authorization ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type authorizationsSee 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_paymentsSee 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 bundlesSee code: src/commands/bundle/index.ts
commercelayer bundle:add_tags ID
Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
USAGE
$ commercelayer bundle:add_tags ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by
sales channels.See code: src/commands/bundle/add_tags.ts
commercelayer bundle:compute_compare_at_amount ID
Send this attribute if you want to compute the compare_at_amount_cents as the sum of the prices of the bundle SKUs for the market.
USAGE
$ commercelayer bundle:compute_compare_at_amount ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to compute the compare_at_amount_cents as the sum of the prices of the bundle SKUs for
the market.See code: src/commands/bundle/compute_compare_at_amount.ts
commercelayer bundle:compute_price_amount ID
Send this attribute if you want to compute the price_amount_cents as the sum of the prices of the bundle SKUs for the market.
USAGE
$ commercelayer bundle:compute_price_amount ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to compute the price_amount_cents as the sum of the prices of the bundle SKUs for the
market.See code: src/commands/bundle/compute_price_amount.ts
commercelayer bundle:remove_tags ID
Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
USAGE
$ commercelayer bundle:remove_tags ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed
by sales channels.See code: src/commands/bundle/remove_tags.ts
commercelayer buy_x_pay_y_promotion ID
Execute an action on a resource of type buy_x_pay_y_promotions.
USAGE
$ commercelayer buy_x_pay_y_promotion ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type buy_x_pay_y_promotionsSee code: src/commands/buy_x_pay_y_promotion/index.ts
commercelayer buy_x_pay_y_promotion:add_tags ID
Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
USAGE
$ commercelayer buy_x_pay_y_promotion:add_tags ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by
sales channels.See code: src/commands/buy_x_pay_y_promotion/add_tags.ts
commercelayer buy_x_pay_y_promotion:disable ID
Send this attribute if you want to mark this resource as disabled.
USAGE
$ commercelayer buy_x_pay_y_promotion:disable ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to mark this resource as disabled.See code: src/commands/buy_x_pay_y_promotion/disable.ts
commercelayer buy_x_pay_y_promotion:enable ID
Send this attribute if you want to mark this resource as enabled.
USAGE
$ commercelayer buy_x_pay_y_promotion:enable ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to mark this resource as enabled.See code: src/commands/buy_x_pay_y_promotion/enable.ts
commercelayer buy_x_pay_y_promotion:remove_tags ID
Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
USAGE
$ commercelayer buy_x_pay_y_promotion:remove_tags ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed
by sales channels.See code: src/commands/buy_x_pay_y_promotion/remove_tags.ts
commercelayer capture ID
Execute an action on a resource of type captures.
USAGE
$ commercelayer capture ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type capturesSee 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_paymentsSee code: src/commands/checkout_com_payment/index.ts
commercelayer checkout_com_payment:details ID
Send this attribute if you want to send additional details the payment request (i.e. upon 3DS check).
USAGE
$ commercelayer checkout_com_payment:details ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to send additional details the payment request (i.e. upon 3DS check).See code: src/commands/checkout_com_payment/details.ts
commercelayer checkout_com_payment:refresh ID
Send this attribute if you want to refresh all the pending transactions, can be used as webhooks fallback logic.
USAGE
$ commercelayer checkout_com_payment:refresh ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to refresh all the pending transactions, can be used as webhooks fallback logic.See code: src/commands/checkout_com_payment/refresh.ts
commercelayer cleanup ID
Execute an action on a resource of type cleanups.
USAGE
$ commercelayer cleanup ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type cleanupsSee code: src/commands/cleanup/index.ts
commercelayer cleanup:interrupt ID
Send this attribute if you want to mark status as 'interrupted'.
USAGE
$ commercelayer cleanup:interrupt ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to mark status as 'interrupted'.See code: src/commands/cleanup/interrupt.ts
commercelayer coupon ID
Execute an action on a resource of type coupons.
USAGE
$ commercelayer coupon ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type couponsSee code: src/commands/coupon/index.ts
commercelayer coupon:add_tags ID
Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
USAGE
$ commercelayer coupon:add_tags ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by
sales channels.See code: src/commands/coupon/add_tags.ts
commercelayer coupon:remove_tags ID
Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
USAGE
$ commercelayer coupon:remove_tags ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed
by sales channels.See code: src/commands/coupon/remove_tags.ts
commercelayer customer ID
Execute an action on a resource of type customers.
USAGE
$ commercelayer customer ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type customersSee code: src/commands/customer/index.ts
commercelayer customer:add_tags ID
Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
USAGE
$ commercelayer customer:add_tags ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by
sales channels.See code: src/commands/customer/add_tags.ts
commercelayer customer:cancel_anonymization ID
Send this attribute if you want to trigger a cancellation of anonymization. Cannot be passed by sales channels.
USAGE
$ commercelayer customer:cancel_anonymization ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to trigger a cancellation of anonymization. Cannot be passed by sales channels.See code: src/commands/customer/cancel_anonymization.ts
commercelayer customer:remove_tags ID
Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
USAGE
$ commercelayer customer:remove_tags ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed
by sales channels.See code: src/commands/customer/remove_tags.ts
commercelayer customer:request_anonymization ID
Send this attribute if you want to trigger anonymization. Cannot be passed by sales channels.
USAGE
$ commercelayer customer:request_anonymization ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to trigger anonymization. Cannot be passed by sales channels.See code: src/commands/customer/request_anonymization.ts
commercelayer customer_password_reset ID
Execute an action on a resource of type customer_password_resets.
USAGE
$ commercelayer customer_password_reset ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type customer_password_resetsSee code: src/commands/customer_password_reset/index.ts
commercelayer customer_password_reset:reset_password_token ID
Send the 'reset_password_token' that you got on create when updating the customer password.
USAGE
$ commercelayer customer_password_reset:reset_password_token ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send the 'reset_password_token' that you got on create when updating the customer password.See code: src/commands/customer_password_reset/reset_password_token.ts
commercelayer easypost_pickup ID
Execute an action on a resource of type easypost_pickups.
USAGE
$ commercelayer easypost_pickup ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type easypost_pickupsSee code: src/commands/easypost_pickup/index.ts
commercelayer easypost_pickup:purchase ID
Send this attribute if you want to purchase this pick up with the selected rate.
USAGE
$ commercelayer easypost_pickup:purchase ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to purchase this pick up with the selected rate.See code: src/commands/easypost_pickup/purchase.ts
commercelayer event ID
Execute an action on a resource of type events.
USAGE
$ commercelayer event ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type eventsSee 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 export ID
Execute an action on a resource of type exports.
USAGE
$ commercelayer export ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the 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 exportsSee code: src/commands/export/index.ts
commercelayer export:interrupt ID
Send this attribute if you want to mark status as 'interrupted'.
USAGE
$ commercelayer export:interrupt ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to mark status as 'interrupted'.See code: src/commands/export/interrupt.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_gatewaysSee 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_promotionsSee code: src/commands/external_promotion/index.ts
commercelayer external_promotion:add_tags ID
Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
USAGE
$ commercelayer external_promotion:add_tags ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by
sales channels.See code: src/commands/external_promotion/add_tags.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:remove_tags ID
Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels.
USAGE
$ commercelayer external_promotion:remove_tags ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed
by sales channels.See code: src/commands/external_promotion/remove_tags.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_calculatorsSee 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_promotionsSee code: src/commands/fixed_amount_promotion/index.ts
`comme
9 months ago
11 months ago
5 months ago
9 months ago
6 months ago
8 months ago
7 months ago
9 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago