Package Exports
- @commercelayer/cli-plugin-triggers
- @commercelayer/cli-plugin-triggers/lib/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@commercelayer/cli-plugin-triggers) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
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 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
commercelayer fixed_amount_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 fixed_amount_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/fixed_amount_promotion/add_tags.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_amount_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 fixed_amount_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/fixed_amount_promotion/remove_tags.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_promotionsSee code: src/commands/fixed_price_promotion/index.ts
commercelayer fixed_price_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 fixed_price_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/fixed_price_promotion/add_tags.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 fixed_price_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 fixed_price_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/fixed_price_promotion/remove_tags.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_promotionsSee code: src/commands/flex_promotion/index.ts
commercelayer flex_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 flex_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/flex_promotion/add_tags.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 flex_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 flex_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/flex_promotion/remove_tags.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_promotionsSee code: src/commands/free_gift_promotion/index.ts
commercelayer free_gift_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 free_gift_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/free_gift_promotion/add_tags.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_gift_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 free_gift_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/free_gift_promotion/remove_tags.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_promotionsSee code: src/commands/free_shipping_promotion/index.ts
commercelayer free_shipping_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 free_shipping_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/free_shipping_promotion/add_tags.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 free_shipping_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 free_shipping_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/free_shipping_promotion/remove_tags.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_cardsSee 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: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 gift_card: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/gift_card/add_tags.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 gift_card: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 gift_card: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/gift_card/remove_tags.ts
commercelayer import ID
Execute an action on a resource of type imports.
USAGE
$ commercelayer import ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the 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 importsSee code: src/commands/import/index.ts
commercelayer import:interrupt ID
Send this attribute if you want to mark status as 'interrupted'.
USAGE
$ commercelayer import: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/import/interrupt.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_subscriptionsSee 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_paymentsSee 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_itemsSee code: src/commands/line_item/index.ts
commercelayer line_item: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 line_item: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/line_item/add_tags.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: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 line_item: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/line_item/remove_tags.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 line_item_option ID
Execute an action on a resource of type line_item_options.
USAGE
$ commercelayer line_item_option ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the 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_item_optionsSee code: src/commands/line_item_option/index.ts
commercelayer line_item_option: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 line_item_option: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/line_item_option/add_tags.ts
commercelayer line_item_option: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 line_item_option: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/line_item_option/remove_tags.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 linksSee 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 marketsSee code: src/commands/market/index.ts
commercelayer market:disable ID
Send this attribute if you want to mark this resource as disabled.
USAGE
$ commercelayer market:disable ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to mark this resource as disabled.See code: src/commands/market/disable.ts
commercelayer market:enable ID
Send this attribute if you want to mark this resource as enabled.
USAGE
$ commercelayer market:enable ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to mark this resource as enabled.See code: src/commands/market/enable.ts
commercelayer order ID
Execute an action on a resource of type orders.
USAGE
$ commercelayer order ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type ordersSee code: src/commands/order/index.ts
commercelayer order: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 order: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/order/add_tags.ts
commercelayer order:approve ID
Send this attribute if you want to approve a placed order. Cannot be passed by sales channels.
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. Cannot be passed by sales channels.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. Cannot be passed by sales channels.
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. Cannot be passed by sales channels.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
Send this attribute as a value in cents if you want to overwrite the amount to be authorized.
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
Send this attribute as a value in cents if you want to overwrite the amount to be authorized.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. Cannot be passed by sales channels.
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. Cannot be passed by sales channels.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:fix_payment_source ID
Send this attribute if you want to set the payment source associated with the last succeeded authorization. At the end of the fix the order should be placed and authorized and ready to be approved. A tentative to fix the payment source is done before approval automatically. Cannot be passed by sales channels.
USAGE
$ commercelayer order:fix_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 set the payment source associated with the last succeeded authorization. At the end
of the fix the order should be placed and authorized and ready to be approved. A tentative to fix the payment source
is done before approval automatically. Cannot be passed by sales channels.See code: src/commands/order/fix_payment_source.ts
commercelayer order:fulfill ID
Send this attribute if you want to mark as fulfilled the order (shipments must be cancelled, shipped or delivered, alternatively order must be approved). Cannot be passed by sales channels.
USAGE
$ commercelayer order:fulfill ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the 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 as fulfilled the order (shipments must be cancelled, shipped or delivered,
alternatively order must be approved). Cannot be passed by sales channels.See code: src/commands/order/fulfill.ts
commercelayer order:nullify_payment_source ID
Send this attribute if you want to nullify the payment source for this order.
USAGE
$ commercelayer order:nullify_payment_source ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to nullify the payment source for this order.See code: src/commands/order/nullify_payment_source.ts
commercelayer order:pending ID
Send this attribute if you want to move a draft or placing order to pending. Cannot be passed by sales channels.
USAGE
$ commercelayer order:pending ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to move a draft or placing order to pending. Cannot be passed by sales channels.See code: src/commands/order/pending.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. Cannot be passed by sales channels.
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. Cannot be passed by sales channels.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: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 order: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/order/remove_tags.ts
commercelayer order: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 order: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/order/reset_circuit.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. Cannot be passed by sales channels.
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. Cannot be passed by sales channels.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. Cannot be passed by sales channels.
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. Cannot be passed by sales
channels.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_subscriptionsSee 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: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 order_subscription: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/order_subscription/add_tags.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:convert ID
Send this attribute if you want to convert a manual subscription to an automatic one. A subscription model is required before conversion.
USAGE
$ commercelayer order_subscription:convert ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the 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 convert a manual subscription to an automatic one. A subscription model is required
before conversion.See code: src/commands/order_subscription/convert.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 order_subscription: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 order_subscription: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/order_subscription/remove_tags.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_methodsSee code: src/commands/payment_method/index.ts
commercelayer payment_method:disable ID
Send this attribute if you want to mark this resource 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 this resource as disabled.See code: src/commands/payment_method/disable.ts
commercelayer payment_method:enable ID
Send this attribute if you want to mark this resource 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 this resource 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_promotionsSee code: src/commands/percentage_discount_promotion/index.ts
commercelayer percentage_discount_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 percentage_discount_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/percentage_discount_promotion/add_tags.ts
commercelayer percentage_discount_promotion:disable ID
Send this attribute if you want to mark this resource 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 this resource 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 this resource 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 this resource as enabled.See code: src/commands/percentage_discount_promotion/enable.ts
commercelayer percentage_discount_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 percentage_discount_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/percentage_discount_promotion/remove_tags.ts
commercelayer price_list_scheduler ID
Execute an action on a resource of type price_list_schedulers.
USAGE
$ commercelayer price_list_scheduler ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the 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 price_list_schedulersSee code: src/commands/price_list_scheduler/index.ts
commercelayer price_list_scheduler:disable ID
Send this attribute if you want to mark this resource as disabled.
USAGE
$ commercelayer price_list_scheduler: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/price_list_scheduler/disable.ts
commercelayer price_list_scheduler:enable ID
Send this attribute if you want to mark this resource as enabled.
USAGE
$ commercelayer price_list_scheduler: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/price_list_scheduler/enable.ts
commercelayer refund ID
Execute an action on a resource of type refunds.
USAGE
$ commercelayer 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
execute an action on a resource of type refundsSee code: src/commands/refund/index.ts
commercelayer refund:forward ID
Send this attribute if you want to forward a stuck transaction to succeeded and update associated order states accordingly.
USAGE
$ commercelayer refund: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/refund/forward.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 returnsSee code: src/commands/return/index.ts
commercelayer return: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 return: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/return/add_tags.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:refund ID
Send this attribute if you want to create a refund for this return.
USAGE
$ commercelayer return: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 return.See code: src/commands/return/refund.ts
commercelayer return:refund_amount_cents ID
Send this attribute as a value in cents to specify the amount to be refunded.
USAGE
$ commercelayer return: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 to specify the amount to be refunded.See code: src/commands/return/refund_amount_cents.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: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 return: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/return/remove_tags.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_itemsSee 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_paymentsSee 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 shipmentsSee code: src/commands/shipment/index.ts
commercelayer shipment: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 shipment: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/shipment/add_tags.ts
commercelayer shipment:cancel ID
Send this attribute if you want to mark this shipment as cancelled (unless already shipped or delivered). Cannot be passed by sales channels.
USAGE
$ commercelayer shipment: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 shipment as cancelled (unless already shipped or delivered). Cannot be
passed by sales channels.See code: src/commands/shipment/cancel.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. Cannot be passed by sales channels.
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. Cannot be passed by sales channels.See code: src/commands/shipment/decrement_stock.ts
commercelayer shipment:deliver ID
Send this attribute if you want to mark this shipment as delivered.
USAGE
$ commercelayer shipment:deliver ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the 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 delivered.See code: src/commands/shipment/deliver.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 destroy the stock reservations for each of the associated stock line item. Can be done only when fulfillment is in progress. Cannot be passed by sales channels.
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 destroy the stock reservations for each of the associated stock line
item. Can be done only when fulfillment is in progress. Cannot be passed by sales channels.See code: src/commands/shipment/release_stock.ts
commercelayer shipment: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 shipment: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/shipment/remove_tags.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. Cannot be passed by sales channels.
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. Cannot be passed by sales channels.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. Cannot be passed by sales channels.
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. Cannot be passed by sales channels.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_methodsSee code: src/commands/shipping_method/index.ts
commercelayer shipping_method:disable ID
Send this attribute if you want to mark this resource 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 this resource as disabled.See code: src/commands/shipping_method/disable.ts
commercelayer shipping_method:enable ID
Send this attribute if you want to mark this resource 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 this resource as enabled.See code: src/commands/shipping_method/enable.ts
commercelayer shipping_method: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 shipping_method: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/shipping_method/reset_circuit.ts
commercelayer sku ID
Execute an action on a resource of type skus.
USAGE
$ commercelayer sku ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the 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 skusSee code: src/commands/sku/index.ts
commercelayer sku: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 sku: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/sku/add_tags.ts
commercelayer sku: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 sku: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/sku/remove_tags.ts
commercelayer sku_option ID
Execute an action on a resource of type sku_options.
USAGE
$ commercelayer sku_option ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the 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 sku_optionsSee code: src/commands/sku_option/index.ts
commercelayer sku_option: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 sku_option: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/sku_option/add_tags.ts
commercelayer sku_option: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 sku_option: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/sku_option/remove_tags.ts
commercelayer stock_item ID
Execute an action on a resource of type stock_items.
USAGE
$ commercelayer stock_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 stock_itemsSee code: src/commands/stock_item/index.ts
commercelayer stock_item:validate ID
Send this attribute if you want to validate the stock item quantity against the existing reserved stock one, returns an error in case the former is smaller. Cannot be passed by sales channels.
USAGE
$ commercelayer stock_item: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 validate the stock item quantity against the existing reserved stock one, returns
an error in case the former is smaller. Cannot be passed by sales channels.See code: src/commands/stock_item/validate.ts
commercelayer stock_line_item ID
Execute an action on a resource of type stock_line_items.
USAGE
$ commercelayer stock_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 stock_line_itemsSee code: src/commands/stock_line_item/index.ts
commercelayer stock_line_item:decrement_stock ID
Send this attribute if you want to automatically decrement and release the stock this stock line item. Can be done only when fulfillment is in progress. Cannot be passed by sales channels.
USAGE
$ commercelayer stock_line_item: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 this stock line item. Can be done
only when fulfillment is in progress. Cannot be passed by sales channels.See code: src/commands/stock_line_item/decrement_stock.ts
commercelayer stock_line_item:release_stock ID
Send this attribute if you want to automatically destroy the stock reservation for this stock line item. Can be done only when fulfillment is in progress. Cannot be passed by sales channels.
USAGE
$ commercelayer stock_line_item: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 destroy the stock reservation for this stock line item. Can be done
only when fulfillment is in progress. Cannot be passed by sales channels.See code: src/commands/stock_line_item/release_stock.ts
commercelayer stock_line_item:reserve_stock ID
Send this attribute if you want to automatically reserve the stock for this stock line item. Can be done only when fulfillment is in progress. Cannot be passed by sales channels.
USAGE
$ commercelayer stock_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 automatically reserve the stock for this stock line item. Can be done only when
fulfillment is in progress. Cannot be passed by sales channels.See code: src/commands/stock_line_item/reserve_stock.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_reservationsSee 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_transfersSee 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_paymentsSee 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 vertex_account ID
Execute an action on a resource of type vertex_accounts.
USAGE
$ commercelayer vertex_account ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the 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 vertex_accountsSee code: src/commands/vertex_account/index.ts
commercelayer vertex_account:refresh_token ID
Send this attribute if you want to manually refresh the access token.
USAGE
$ commercelayer vertex_account:refresh_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 this attribute if you want to manually refresh the access token.See code: src/commands/vertex_account/refresh_token.ts
commercelayer void ID
Execute an action on a resource of type voids.
USAGE
$ commercelayer 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
execute an action on a resource of type voidsSee code: src/commands/void/index.ts
commercelayer void:forward ID
Send this attribute if you want to forward a stuck transaction to succeeded and update associated order states accordingly.
USAGE
$ commercelayer void: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/void/forward.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 webhooksSee code: src/commands/webhook/index.ts
commercelayer webhook:disable ID
Send this attribute if you want to mark this resource as disabled.
USAGE
$ commercelayer webhook: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/webhook/disable.ts
commercelayer webhook:enable ID
Send this attribute if you want to mark this resource as enabled.
USAGE
$ commercelayer webhook: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/webhook/enable.ts
commercelayer webhook: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 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 resource to 'closed' state and zero
failures count. Cannot be passed by sales channels.See code: src/commands/webhook/reset_circuit.ts