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 ID
commercelayer adyen_payment:details ID
commercelayer authorization ID
commercelayer authorization:cancel ID
commercelayer authorization:capture ID
commercelayer authorization:capture_amount_cents ID
commercelayer authorization:forward ID
commercelayer authorization:void ID
commercelayer axerve_payment ID
commercelayer axerve_payment:update ID
commercelayer bundle ID
commercelayer bundle:compute_compare_at_amount ID
commercelayer bundle:compute_price_amount ID
commercelayer buy_x_pay_y_promotion ID
commercelayer buy_x_pay_y_promotion:disable ID
commercelayer buy_x_pay_y_promotion:enable ID
commercelayer capture ID
commercelayer capture:cancel ID
commercelayer capture:forward ID
commercelayer capture:refund ID
commercelayer capture:refund_amount_cents ID
commercelayer checkout_com_payment ID
commercelayer checkout_com_payment:details ID
commercelayer checkout_com_payment:refresh ID
commercelayer customer_password_reset ID
commercelayer customer_password_reset:reset_password_token ID
commercelayer event ID
commercelayer event:trigger ID
commercelayer external_gateway ID
commercelayer external_gateway:reset_circuit ID
commercelayer external_promotion ID
commercelayer external_promotion:disable ID
commercelayer external_promotion:enable ID
commercelayer external_promotion:reset_circuit ID
commercelayer external_tax_calculator ID
commercelayer external_tax_calculator:reset_circuit ID
commercelayer fixed_amount_promotion ID
commercelayer fixed_amount_promotion:disable ID
commercelayer fixed_amount_promotion:enable ID
commercelayer fixed_price_promotion ID
commercelayer fixed_price_promotion:disable ID
commercelayer fixed_price_promotion:enable ID
commercelayer flex_promotion ID
commercelayer flex_promotion:disable ID
commercelayer flex_promotion:enable ID
commercelayer free_gift_promotion ID
commercelayer free_gift_promotion:disable ID
commercelayer free_gift_promotion:enable ID
commercelayer free_shipping_promotion ID
commercelayer free_shipping_promotion:disable ID
commercelayer free_shipping_promotion:enable ID
commercelayer gift_card ID
commercelayer gift_card:activate ID
commercelayer gift_card:balance_change_cents ID
commercelayer gift_card:deactivate ID
commercelayer gift_card:purchase ID
commercelayer in_stock_subscription ID
commercelayer in_stock_subscription:activate ID
commercelayer in_stock_subscription:deactivate ID
commercelayer klarna_payment ID
commercelayer klarna_payment:update ID
commercelayer line_item ID
commercelayer line_item:external_price ID
commercelayer line_item:reserve_stock ID
commercelayer line_item:reset_circuit ID
commercelayer link ID
commercelayer link:disable ID
commercelayer link:enable ID
commercelayer market ID
commercelayer market:disable ID
commercelayer market:enable ID
commercelayer order ID
commercelayer order:approve ID
commercelayer order:approve_and_capture ID
commercelayer order:archive ID
commercelayer order:authorization_amount_cents ID
commercelayer order:authorize ID
commercelayer order:billing_address_clone_id ID
commercelayer order:billing_address_same_as_shipping ID
commercelayer order:cancel ID
commercelayer order:capture ID
commercelayer order:commit_invoice ID
commercelayer order:create_subscriptions ID
commercelayer order:customer_payment_source_id ID
commercelayer order:fulfill ID
commercelayer order:nullify_payment_source ID
commercelayer order:pending ID
commercelayer order:place ID
commercelayer order:refresh ID
commercelayer order:refund ID
commercelayer order:refund_invoice ID
commercelayer order:reset_circuit ID
commercelayer order:save_billing_address_to_customer_address_book ID
commercelayer order:save_payment_source_to_customer_wallet ID
commercelayer order:save_shipping_address_to_customer_address_book ID
commercelayer order:shipping_address_clone_id ID
commercelayer order:shipping_address_same_as_billing ID
commercelayer order:start_editing ID
commercelayer order:stop_editing ID
commercelayer order:unarchive ID
commercelayer order:update_taxes ID
commercelayer order:validate ID
commercelayer order_subscription ID
commercelayer order_subscription:activate ID
commercelayer order_subscription:cancel ID
commercelayer order_subscription:convert ID
commercelayer order_subscription:deactivate ID
commercelayer payment_method ID
commercelayer payment_method:disable ID
commercelayer payment_method:enable ID
commercelayer percentage_discount_promotion ID
commercelayer percentage_discount_promotion:disable ID
commercelayer percentage_discount_promotion:enable ID
commercelayer price_list_scheduler ID
commercelayer price_list_scheduler:disable ID
commercelayer price_list_scheduler:enable ID
commercelayer refund ID
commercelayer refund:forward ID
commercelayer return ID
commercelayer return:approve ID
commercelayer return:archive ID
commercelayer return:cancel ID
commercelayer return:receive ID
commercelayer return:refund ID
commercelayer return:refund_amount_cents ID
commercelayer return:reject ID
commercelayer return:request ID
commercelayer return:restock ID
commercelayer return:ship ID
commercelayer return:unarchive ID
commercelayer return_line_item ID
commercelayer return_line_item:restock ID
commercelayer satispay_payment ID
commercelayer satispay_payment:refresh ID
commercelayer shipment ID
commercelayer shipment:cancel ID
commercelayer shipment:decrement_stock ID
commercelayer shipment:deliver ID
commercelayer shipment:get_rates ID
commercelayer shipment:on_hold ID
commercelayer shipment:packing ID
commercelayer shipment:picking ID
commercelayer shipment:purchase ID
commercelayer shipment:ready_to_ship ID
commercelayer shipment:release_stock ID
commercelayer shipment:reserve_stock ID
commercelayer shipment:ship ID
commercelayer shipment:upcoming ID
commercelayer shipping_method ID
commercelayer shipping_method:disable ID
commercelayer shipping_method:enable ID
commercelayer shipping_method:reset_circuit ID
commercelayer stock_item ID
commercelayer stock_item:validate ID
commercelayer stock_line_item ID
commercelayer stock_line_item:decrement_stock ID
commercelayer stock_line_item:release_stock ID
commercelayer stock_line_item:reserve_stock ID
commercelayer stock_reservation ID
commercelayer stock_reservation:pending ID
commercelayer stock_transfer ID
commercelayer stock_transfer:cancel ID
commercelayer stock_transfer:complete ID
commercelayer stock_transfer:in_transit ID
commercelayer stock_transfer:on_hold ID
commercelayer stock_transfer:picking ID
commercelayer stock_transfer:upcoming ID
commercelayer stripe_payment ID
commercelayer stripe_payment:refresh ID
commercelayer stripe_payment:update ID
commercelayer void ID
commercelayer void:forward ID
commercelayer webhook ID
commercelayer webhook:disable ID
commercelayer webhook:enable ID
commercelayer webhook:reset_circuit ID
Execute an action on a resource of type adyen_payments.
USAGE
$ commercelayer adyen_payment ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type adyen_payments
See code: src/commands/adyen_payment/index.ts
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
Execute an action on a resource of type authorizations.
USAGE
$ commercelayer authorization ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type authorizations
See code: src/commands/authorization/index.ts
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
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
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
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
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
Execute an action on a resource of type axerve_payments.
USAGE
$ commercelayer axerve_payment ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type axerve_payments
See code: src/commands/axerve_payment/index.ts
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
Execute an action on a resource of type bundles.
USAGE
$ commercelayer bundle ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type bundles
See code: src/commands/bundle/index.ts
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
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
Execute an action on a resource of type buy_x_pay_y_promotions.
USAGE
$ commercelayer buy_x_pay_y_promotion ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type buy_x_pay_y_promotions
See code: src/commands/buy_x_pay_y_promotion/index.ts
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
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
Execute an action on a resource of type captures.
USAGE
$ commercelayer capture ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type captures
See code: src/commands/capture/index.ts
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
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
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
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
Execute an action on a resource of type checkout_com_payments.
USAGE
$ commercelayer checkout_com_payment ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type checkout_com_payments
See code: src/commands/checkout_com_payment/index.ts
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
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
Execute an action on a resource of type customer_password_resets.
USAGE
$ commercelayer customer_password_reset ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type customer_password_resets
See code: src/commands/customer_password_reset/index.ts
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
Execute an action on a resource of type events.
USAGE
$ commercelayer event ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type events
See code: src/commands/event/index.ts
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
Execute an action on a resource of type external_gateways.
USAGE
$ commercelayer external_gateway ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type external_gateways
See code: src/commands/external_gateway/index.ts
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
Execute an action on a resource of type external_promotions.
USAGE
$ commercelayer external_promotion ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type external_promotions
See code: src/commands/external_promotion/index.ts
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
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
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
Execute an action on a resource of type external_tax_calculators.
USAGE
$ commercelayer external_tax_calculator ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type external_tax_calculators
See code: src/commands/external_tax_calculator/index.ts
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
Execute an action on a resource of type fixed_amount_promotions.
USAGE
$ commercelayer fixed_amount_promotion ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type fixed_amount_promotions
See code: src/commands/fixed_amount_promotion/index.ts
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
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
Execute an action on a resource of type fixed_price_promotions.
USAGE
$ commercelayer fixed_price_promotion ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type fixed_price_promotions
See code: src/commands/fixed_price_promotion/index.ts
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
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
Execute an action on a resource of type flex_promotions.
USAGE
$ commercelayer flex_promotion ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type flex_promotions
See code: src/commands/flex_promotion/index.ts
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
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
Execute an action on a resource of type free_gift_promotions.
USAGE
$ commercelayer free_gift_promotion ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type free_gift_promotions
See code: src/commands/free_gift_promotion/index.ts
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
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
Execute an action on a resource of type free_shipping_promotions.
USAGE
$ commercelayer free_shipping_promotion ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type free_shipping_promotions
See code: src/commands/free_shipping_promotion/index.ts
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
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
Execute an action on a resource of type gift_cards.
USAGE
$ commercelayer gift_card ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type gift_cards
See code: src/commands/gift_card/index.ts
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
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
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
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
Execute an action on a resource of type in_stock_subscriptions.
USAGE
$ commercelayer in_stock_subscription ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type in_stock_subscriptions
See code: src/commands/in_stock_subscription/index.ts
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
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
Execute an action on a resource of type klarna_payments.
USAGE
$ commercelayer klarna_payment ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type klarna_payments
See code: src/commands/klarna_payment/index.ts
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
Execute an action on a resource of type line_items.
USAGE
$ commercelayer line_item ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type line_items
See code: src/commands/line_item/index.ts
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
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
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
Execute an action on a resource of type links.
USAGE
$ commercelayer link ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type links
See code: src/commands/link/index.ts
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
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
Execute an action on a resource of type markets.
USAGE
$ commercelayer market ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type markets
See code: src/commands/market/index.ts
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
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
Execute an action on a resource of type orders.
USAGE
$ commercelayer order ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type orders
See code: src/commands/order/index.ts
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
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
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
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
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
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
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
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
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
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
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
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
Send this attribute if you want to mark as fulfilled the order (shipments must be cancelled, shipped or delivered). 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).
Cannot be passed by sales channels.
See code: src/commands/order/fulfill.ts
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
Execute an action on a resource of type order_subscriptions.
USAGE
$ commercelayer order_subscription ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type order_subscriptions
See code: src/commands/order_subscription/index.ts
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
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
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
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
Execute an action on a resource of type payment_methods.
USAGE
$ commercelayer payment_method ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type payment_methods
See code: src/commands/payment_method/index.ts
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
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
Execute an action on a resource of type percentage_discount_promotions.
USAGE
$ commercelayer percentage_discount_promotion ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type percentage_discount_promotions
See code: src/commands/percentage_discount_promotion/index.ts
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
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
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_schedulers
See code: src/commands/price_list_scheduler/index.ts
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
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
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 refunds
See code: src/commands/refund/index.ts
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
Execute an action on a resource of type returns.
USAGE
$ commercelayer return ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type returns
See code: src/commands/return/index.ts
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
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
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
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
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
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
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
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
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
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
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
Execute an action on a resource of type return_line_items.
USAGE
$ commercelayer return_line_item ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type return_line_items
See code: src/commands/return_line_item/index.ts
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
Execute an action on a resource of type satispay_payments.
USAGE
$ commercelayer satispay_payment ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type satispay_payments
See code: src/commands/satispay_payment/index.ts
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
Execute an action on a resource of type shipments.
USAGE
$ commercelayer shipment ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type shipments
See code: src/commands/shipment/index.ts
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
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
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
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
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
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
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
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
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
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
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
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
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
Execute an action on a resource of type shipping_methods.
USAGE
$ commercelayer shipping_method ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type shipping_methods
See code: src/commands/shipping_method/index.ts
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
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
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
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_items
See code: src/commands/stock_item/index.ts
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
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_items
See code: src/commands/stock_line_item/index.ts
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
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
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
Execute an action on a resource of type stock_reservations.
USAGE
$ commercelayer stock_reservation ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type stock_reservations
See code: src/commands/stock_reservation/index.ts
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
Execute an action on a resource of type stock_transfers.
USAGE
$ commercelayer stock_transfer ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type stock_transfers
See code: src/commands/stock_transfer/index.ts
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
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
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
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
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
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
Execute an action on a resource of type stripe_payments.
USAGE
$ commercelayer stripe_payment ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type stripe_payments
See code: src/commands/stripe_payment/index.ts
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
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
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 voids
See code: src/commands/void/index.ts
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
Execute an action on a resource of type webhooks.
USAGE
$ commercelayer webhook ID [-u [-j -p]]
ARGUMENTS
ID the unique id of the resource
FLAGS
-j, --json print result in JSON format
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
DESCRIPTION
execute an action on a resource of type webhooks
See code: src/commands/webhook/index.ts
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
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
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