
Security News
The Changelog Podcast: Practical Steps to Stay Safe on npm
Learn the essential steps every developer should take to stay secure on npm and reduce exposure to supply chain attacks.
@commercelayer/cli-plugin-triggers
Advanced tools
Commerce Layer CLI Triggers plugin
commercelayer COMMAND
commercelayer [COMMAND] (--help | -h) for detailed information about plugin commands.
To install as a Commerce Layer CLI plugin run the following command:
$ commercelayer plugins:install triggers
commercelayer adyen_payment IDcommercelayer adyen_payment:details IDcommercelayer authorization IDcommercelayer authorization:capture IDcommercelayer authorization:capture_amount_cents IDcommercelayer authorization:void IDcommercelayer bundle IDcommercelayer bundle:compute_compare_at_amount IDcommercelayer bundle:compute_price_amount IDcommercelayer capture IDcommercelayer capture:refund IDcommercelayer capture:refund_amount_cents IDcommercelayer checkout_com_payment IDcommercelayer checkout_com_payment:details IDcommercelayer checkout_com_payment:refresh IDcommercelayer customer_password_reset IDcommercelayer customer_password_reset:reset_password_token IDcommercelayer gift_card IDcommercelayer gift_card:activate IDcommercelayer gift_card:balance_change_cents IDcommercelayer gift_card:deactivate IDcommercelayer gift_card:purchase IDcommercelayer in_stock_subscription IDcommercelayer in_stock_subscription:activate IDcommercelayer in_stock_subscription:deactivate IDcommercelayer klarna_payment IDcommercelayer klarna_payment:update IDcommercelayer market IDcommercelayer market:disable IDcommercelayer market:enable IDcommercelayer order 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:customer_payment_source_id IDcommercelayer order:nullify_payment_source IDcommercelayer order:place IDcommercelayer order:refresh IDcommercelayer order:refund IDcommercelayer order:refund_invoice 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:unarchive IDcommercelayer order:update_taxes IDcommercelayer order_subscription IDcommercelayer order_subscription:activate IDcommercelayer order_subscription:cancel IDcommercelayer order_subscription:deactivate IDcommercelayer payment_method IDcommercelayer payment_method:disable IDcommercelayer payment_method:enable IDcommercelayer return IDcommercelayer return:approve IDcommercelayer return:archive IDcommercelayer return:cancel IDcommercelayer return:receive IDcommercelayer return:reject IDcommercelayer return:request IDcommercelayer return:restock IDcommercelayer return:ship IDcommercelayer return:unarchive IDcommercelayer return_line_item IDcommercelayer return_line_item:restock IDcommercelayer shipment IDcommercelayer shipment:get_rates IDcommercelayer shipment:on_hold IDcommercelayer shipment:packing IDcommercelayer shipment:picking IDcommercelayer shipment:purchase IDcommercelayer shipment:ready_to_ship IDcommercelayer shipment:ship IDcommercelayer shipping_method IDcommercelayer shipping_method:disable IDcommercelayer shipping_method:enable IDcommercelayer stock_transfer IDcommercelayer stock_transfer:cancel IDcommercelayer stock_transfer:complete IDcommercelayer stock_transfer:in_transit IDcommercelayer stock_transfer:picking IDcommercelayer stock_transfer:upcoming IDcommercelayer stripe_payment IDcommercelayer stripe_payment:refresh IDcommercelayer webhook IDcommercelayer webhook:reset_circuit IDcommercelayer adyen_payment IDExecute an action on a resource of type adyen_payments.
USAGE
$ commercelayer adyen_payment [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type adyen_payments
See code: src/commands/adyen_payment/index.ts
commercelayer adyen_payment:details IDSend this attribute if you want to send additional details the payment request.
USAGE
$ commercelayer adyen_payment:details [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 IDExecute an action on a resource of type authorizations.
USAGE
$ commercelayer authorization [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type authorizations
See code: src/commands/authorization/index.ts
commercelayer authorization:capture IDSend this attribute if you want to create a capture for this authorization.
USAGE
$ commercelayer authorization:capture [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 IDThe associated capture amount, in cents.
USAGE
$ commercelayer authorization:capture_amount_cents [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
The associated capture amount, in cents.
See code: src/commands/authorization/capture_amount_cents.ts
commercelayer authorization:void IDSend this attribute if you want to create a void for this authorization.
USAGE
$ commercelayer authorization:void [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 bundle IDExecute an action on a resource of type bundles.
USAGE
$ commercelayer bundle [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type bundles
See code: src/commands/bundle/index.ts
commercelayer bundle:compute_compare_at_amount IDSend 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] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 IDSend 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] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 capture IDExecute an action on a resource of type captures.
USAGE
$ commercelayer capture [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type captures
See code: src/commands/capture/index.ts
commercelayer capture:refund IDSend this attribute if you want to create a refund for this capture.
USAGE
$ commercelayer capture:refund [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 IDThe associated refund amount, in cents.
USAGE
$ commercelayer capture:refund_amount_cents [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
The associated refund amount, in cents.
See code: src/commands/capture/refund_amount_cents.ts
commercelayer checkout_com_payment IDExecute an action on a resource of type checkout_com_payments.
USAGE
$ commercelayer checkout_com_payment [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type checkout_com_payments
See code: src/commands/checkout_com_payment/index.ts
commercelayer checkout_com_payment:details IDSend this attribute if you want to send additional details the payment request (i.e. upon 3DS check).
USAGE
$ commercelayer checkout_com_payment:details [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 IDSend 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] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to refresh all the pending transactions, can be used as webhooks fallback logic.
See code: src/commands/checkout_com_payment/refresh.ts
commercelayer customer_password_reset IDExecute an action on a resource of type customer_password_resets.
USAGE
$ commercelayer customer_password_reset [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type customer_password_resets
See code: src/commands/customer_password_reset/index.ts
commercelayer customer_password_reset:reset_password_token IDSend the 'reset_password_token' that you got on create when updating the customer password.
USAGE
$ commercelayer customer_password_reset:reset_password_token [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 gift_card IDExecute an action on a resource of type gift_cards.
USAGE
$ commercelayer gift_card [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type gift_cards
See code: src/commands/gift_card/index.ts
commercelayer gift_card:activate IDSend this attribute if you want to activate a gift card.
USAGE
$ commercelayer gift_card:activate [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to activate a gift card.
See code: src/commands/gift_card/activate.ts
commercelayer gift_card:balance_change_cents IDThe 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] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 IDSend this attribute if you want to deactivate a gift card.
USAGE
$ commercelayer gift_card:deactivate [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 IDSend 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] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to confirm a draft gift card. The gift card becomes 'inactive', waiting to be
activated.
See code: src/commands/gift_card/purchase.ts
commercelayer in_stock_subscription IDExecute an action on a resource of type in_stock_subscriptions.
USAGE
$ commercelayer in_stock_subscription [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type in_stock_subscriptions
See code: src/commands/in_stock_subscription/index.ts
commercelayer in_stock_subscription:activate IDSend this attribute if you want to activate an inactive subscription.
USAGE
$ commercelayer in_stock_subscription:activate [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 IDSend this attribute if you want to dactivate an active subscription.
USAGE
$ commercelayer in_stock_subscription:deactivate [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 IDExecute an action on a resource of type klarna_payments.
USAGE
$ commercelayer klarna_payment [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type klarna_payments
See code: src/commands/klarna_payment/index.ts
commercelayer klarna_payment:update IDSend this attribute if you want to update the payment session with fresh order data.
USAGE
$ commercelayer klarna_payment:update [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 market IDExecute an action on a resource of type markets.
USAGE
$ commercelayer market [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type markets
See code: src/commands/market/index.ts
commercelayer market:disable IDSend this attribute if you want to mark the market as disabled.
USAGE
$ commercelayer market:disable [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to mark the market as disabled.
See code: src/commands/market/disable.ts
commercelayer market:enable IDSend this attribute if you want to mark the market as enabled.
USAGE
$ commercelayer market:enable [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to mark the market as enabled.
See code: src/commands/market/enable.ts
commercelayer order IDExecute an action on a resource of type orders.
USAGE
$ commercelayer order [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type orders
See code: src/commands/order/index.ts
commercelayer order:approve IDSend this attribute if you want to approve a placed order.
USAGE
$ commercelayer order:approve [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to approve a placed order.
See code: src/commands/order/approve.ts
commercelayer order:approve_and_capture IDSend this attribute if you want to approve and capture a placed order.
USAGE
$ commercelayer order:approve_and_capture [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to approve and capture a placed order.
See code: src/commands/order/approve_and_capture.ts
commercelayer order:archive IDSend this attribute if you want to archive the order.
USAGE
$ commercelayer order:archive [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 IDThe authorization amount, in cents.
USAGE
$ commercelayer order:authorization_amount_cents [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
The authorization amount, in cents.
See code: src/commands/order/authorization_amount_cents.ts
commercelayer order:authorize IDSend this attribute if you want to authorize the order's payment source.
USAGE
$ commercelayer order:authorize [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 IDThe id of the address that you want to clone to create the order's billing address.
USAGE
$ commercelayer order:billing_address_clone_id [ID] -o <value> -v <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 IDSend 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] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 IDSend this attribute if you want to cancel a placed order. The order's authorization will be automatically voided.
USAGE
$ commercelayer order:cancel [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 IDSend this attribute if you want to capture an authorized order.
USAGE
$ commercelayer order:capture [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to capture an authorized order.
See code: src/commands/order/capture.ts
commercelayer order:commit_invoice IDSend 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] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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:customer_payment_source_id IDThe 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] -o <value> -v <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
-v, --value=<value> (required) the trigger attribute value
DESCRIPTION
The id of the customer payment source (i.e. credit card) that you want to use as the order's payment source.
See code: src/commands/order/customer_payment_source_id.ts
commercelayer order:nullify_payment_source IDSend this attribute if you want to nullify the payment source for this order.
USAGE
$ commercelayer order:nullify_payment_source [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to nullify the payment source for this order.
See code: src/commands/order/nullify_payment_source.ts
commercelayer order:place IDSend this attribute if you want to place the order.
USAGE
$ commercelayer order:place [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 IDSend this attribute if you want to manually refresh the order.
USAGE
$ commercelayer order:refresh [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 IDSend this attribute if you want to refund a captured order.
USAGE
$ commercelayer order:refund [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to refund a captured order.
See code: src/commands/order/refund.ts
commercelayer order:refund_invoice IDSend 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] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want refund the sales tax invoice to the associated tax calculator (currently supported by
Avalara).
See code: src/commands/order/refund_invoice.ts
commercelayer order:save_billing_address_to_customer_address_book IDSend 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] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 IDSend 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] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 IDSend 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] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 IDThe id of the address that you want to clone to create the order's shipping address.
USAGE
$ commercelayer order:shipping_address_clone_id [ID] -o <value> -v <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 IDSend 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] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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:unarchive IDSend this attribute if you want to unarchive the order.
USAGE
$ commercelayer order:unarchive [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 IDSend 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] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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_subscription IDExecute an action on a resource of type order_subscriptions.
USAGE
$ commercelayer order_subscription [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type order_subscriptions
See code: src/commands/order_subscription/index.ts
commercelayer order_subscription:activate IDSend this attribute if you want to mark this subscription as active.
USAGE
$ commercelayer order_subscription:activate [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to mark this subscription as active.
See code: src/commands/order_subscription/activate.ts
commercelayer order_subscription:cancel IDSend this attribute if you want to mark this subscription as cancelled.
USAGE
$ commercelayer order_subscription:cancel [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to mark this subscription as cancelled.
See code: src/commands/order_subscription/cancel.ts
commercelayer order_subscription:deactivate IDSend this attribute if you want to mark this subscription as inactive.
USAGE
$ commercelayer order_subscription:deactivate [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to mark this subscription as inactive.
See code: src/commands/order_subscription/deactivate.ts
commercelayer payment_method IDExecute an action on a resource of type payment_methods.
USAGE
$ commercelayer payment_method [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type payment_methods
See code: src/commands/payment_method/index.ts
commercelayer payment_method:disable IDSend this attribute if you want to mark the payment method as disabled.
USAGE
$ commercelayer payment_method:disable [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to mark the payment method as disabled.
See code: src/commands/payment_method/disable.ts
commercelayer payment_method:enable IDSend this attribute if you want to mark the payment method as enabled.
USAGE
$ commercelayer payment_method:enable [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to mark the payment method as enabled.
See code: src/commands/payment_method/enable.ts
commercelayer return IDExecute an action on a resource of type returns.
USAGE
$ commercelayer return [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type returns
See code: src/commands/return/index.ts
commercelayer return:approve IDSend this attribute if you want to mark this return as approved.
USAGE
$ commercelayer return:approve [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 IDSend this attribute if you want to archive the return.
USAGE
$ commercelayer return:archive [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 IDSend this attribute if you want to mark this return as cancelled.
USAGE
$ commercelayer return:cancel [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 IDSend this attribute if you want to mark this return as received.
USAGE
$ commercelayer return:receive [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to mark this return as received.
See code: src/commands/return/receive.ts
commercelayer return:reject IDSend this attribute if you want to mark this return as rejected.
USAGE
$ commercelayer return:reject [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to mark this return as rejected.
See code: src/commands/return/reject.ts
commercelayer return:request IDSend this attribute if you want to activate this return.
USAGE
$ commercelayer return:request [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 IDSend this attribute if you want to restock all of the return line items.
USAGE
$ commercelayer return:restock [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 IDSend this attribute if you want to mark this return as shipped.
USAGE
$ commercelayer return:ship [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 IDSend this attribute if you want to unarchive the return.
USAGE
$ commercelayer return:unarchive [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 IDExecute an action on a resource of type return_line_items.
USAGE
$ commercelayer return_line_item [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type return_line_items
See code: src/commands/return_line_item/index.ts
commercelayer return_line_item:restock IDSend this attribute if you want to restock the line item.
USAGE
$ commercelayer return_line_item:restock [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 shipment IDExecute an action on a resource of type shipments.
USAGE
$ commercelayer shipment [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type shipments
See code: src/commands/shipment/index.ts
commercelayer shipment:get_rates IDSend this attribute if you want get the shipping rates from the associated carrier accounts.
USAGE
$ commercelayer shipment:get_rates [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 IDSend this attribute if you want to put this shipment on hold.
USAGE
$ commercelayer shipment:on_hold [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 IDSend this attribute if you want to start packing this shipment.
USAGE
$ commercelayer shipment:packing [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 IDSend this attribute if you want to start picking this shipment.
USAGE
$ commercelayer shipment:picking [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 IDSend this attribute if you want to purchase this shipment with the selected rate.
USAGE
$ commercelayer shipment:purchase [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 IDSend this attribute if you want to mark this shipment as ready to ship.
USAGE
$ commercelayer shipment:ready_to_ship [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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:ship IDSend this attribute if you want to mark this shipment as shipped.
USAGE
$ commercelayer shipment:ship [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 shipping_method IDExecute an action on a resource of type shipping_methods.
USAGE
$ commercelayer shipping_method [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type shipping_methods
See code: src/commands/shipping_method/index.ts
commercelayer shipping_method:disable IDSend this attribute if you want to mark the shipping method as disabled.
USAGE
$ commercelayer shipping_method:disable [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to mark the shipping method as disabled.
See code: src/commands/shipping_method/disable.ts
commercelayer shipping_method:enable IDSend this attribute if you want to mark the shipping method as enabled.
USAGE
$ commercelayer shipping_method:enable [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to mark the shipping method as enabled.
See code: src/commands/shipping_method/enable.ts
commercelayer stock_transfer IDExecute an action on a resource of type stock_transfers.
USAGE
$ commercelayer stock_transfer [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type stock_transfers
See code: src/commands/stock_transfer/index.ts
commercelayer stock_transfer:cancel IDSend this attribute if you want to cancel this stock transfer.
USAGE
$ commercelayer stock_transfer:cancel [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 IDSend this attribute if you want to complete this stock transfer.
USAGE
$ commercelayer stock_transfer:complete [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 IDSend this attribute if you want to mark this stock transfer as in transit.
USAGE
$ commercelayer stock_transfer:in_transit [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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:picking IDSend this attribute if you want to start picking this stock transfer.
USAGE
$ commercelayer stock_transfer:picking [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 IDSend this attribute if you want to mark this stock transfer as upcoming.
USAGE
$ commercelayer stock_transfer:upcoming [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 IDExecute an action on a resource of type stripe_payments.
USAGE
$ commercelayer stripe_payment [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type stripe_payments
See code: src/commands/stripe_payment/index.ts
commercelayer stripe_payment:refresh IDSend this attribute if you want to refresh the payment status, can be used as webhooks fallback logic.
USAGE
$ commercelayer stripe_payment:refresh [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-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 webhook IDExecute an action on a resource of type webhooks.
USAGE
$ commercelayer webhook [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type webhooks
See code: src/commands/webhook/index.ts
commercelayer webhook:reset_circuit IDSend this attribute if you want to reset the circuit breaker associated to this webhook to 'closed' state and zero failures count.
USAGE
$ commercelayer webhook:reset_circuit [ID] -o <value> [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-o, --organization=<value> (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
Send this attribute if you want to reset the circuit breaker associated to this webhook to 'closed' state and zero
failures count.
See code: src/commands/webhook/reset_circuit.ts
FAQs
Commerce Layer CLI Triggers plugin
The npm package @commercelayer/cli-plugin-triggers receives a total of 7 weekly downloads. As such, @commercelayer/cli-plugin-triggers popularity was classified as not popular.
We found that @commercelayer/cli-plugin-triggers demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Security News
Learn the essential steps every developer should take to stay secure on npm and reduce exposure to supply chain attacks.

Security News
Experts push back on new claims about AI-driven ransomware, warning that hype and sponsored research are distorting how the threat is understood.

Security News
Ruby's creator Matz assumes control of RubyGems and Bundler repositories while former maintainers agree to step back and transfer all rights to end the dispute.