README
commercelayer-cli-plugin-triggers
Commerce Layer CLI Triggers plugin
Usage
Commands
commercelayer adyen_payment ID
commercelayer adyen_payment:details ID
commercelayer authorization ID
commercelayer authorization:capture ID
commercelayer authorization:capture_amount_cents ID
commercelayer authorization:void ID
commercelayer bundle ID
commercelayer bundle:compute_compare_at_amount ID
commercelayer bundle:compute_price_amount ID
commercelayer capture 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 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 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:customer_payment_source_id ID
commercelayer order:place ID
commercelayer order:refresh ID
commercelayer order:refund 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:unarchive ID
commercelayer order:update_taxes ID
commercelayer order_subscription ID
commercelayer order_subscription:activate ID
commercelayer order_subscription:cancel ID
commercelayer order_subscription:deactivate ID
commercelayer return ID
commercelayer return:approve ID
commercelayer return:archive ID
commercelayer return:cancel ID
commercelayer return:receive 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 shipment 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:ship ID
commercelayer stock_transfer ID
commercelayer stock_transfer:cancel ID
commercelayer stock_transfer:complete ID
commercelayer stock_transfer:in_transit ID
commercelayer stock_transfer:picking ID
commercelayer stock_transfer:upcoming ID
commercelayer stripe_payment ID
commercelayer stripe_payment:refresh ID
commercelayer webhook ID
commercelayer webhook:reset_circuit ID
commercelayer adyen_payment ID
Execute an action on a resource of type adyen_payments.
USAGE
$ commercelayer adyen_payment ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/adyen_payment/index.ts
commercelayer adyen_payment:details ID
Send this attribute if you want to send additional details the payment request..
USAGE
$ commercelayer adyen_payment:details ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/adyen_payment/details.ts
commercelayer authorization ID
Execute an action on a resource of type authorizations.
USAGE
$ commercelayer authorization ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/authorization/index.ts
commercelayer authorization:capture ID
Send this attribute if you want to create a capture for this authorization..
USAGE
$ commercelayer authorization:capture ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/authorization/capture.ts
commercelayer authorization:capture_amount_cents ID
The associated capture amount, in cents..
USAGE
$ commercelayer authorization:capture_amount_cents ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/authorization/capture_amount_cents.ts
commercelayer authorization:void ID
Send this attribute if you want to create a void for this authorization..
USAGE
$ commercelayer authorization:void ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/authorization/void.ts
commercelayer bundle ID
Execute an action on a resource of type bundles.
USAGE
$ commercelayer bundle ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/bundle/index.ts
commercelayer bundle:compute_compare_at_amount ID
Send this attribute if you want to compute the compare_at_amount_cents as the sum of the prices of the bundle SKUs for the market..
USAGE
$ commercelayer bundle:compute_compare_at_amount ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/bundle/compute_compare_at_amount.ts
commercelayer bundle:compute_price_amount ID
Send this attribute if you want to compute the price_amount_cents as the sum of the prices of the bundle SKUs for the market..
USAGE
$ commercelayer bundle:compute_price_amount ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/bundle/compute_price_amount.ts
commercelayer capture ID
Execute an action on a resource of type captures.
USAGE
$ commercelayer capture ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/capture/index.ts
commercelayer capture:refund ID
Send this attribute if you want to create a refund for this capture..
USAGE
$ commercelayer capture:refund ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/capture/refund.ts
commercelayer capture:refund_amount_cents ID
The associated refund amount, in cents..
USAGE
$ commercelayer capture:refund_amount_cents ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/capture/refund_amount_cents.ts
commercelayer checkout_com_payment ID
Execute an action on a resource of type checkout_com_payments.
USAGE
$ commercelayer checkout_com_payment ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/checkout_com_payment/index.ts
commercelayer checkout_com_payment:details ID
Send this attribute if you want to send additional details the payment request (i.e. upon 3DS check)..
USAGE
$ commercelayer checkout_com_payment:details ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/checkout_com_payment/details.ts
commercelayer checkout_com_payment:refresh ID
Send this attribute if you want to refresh all the pending transactions, can be used as webhooks fallback logic..
USAGE
$ commercelayer checkout_com_payment:refresh ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/checkout_com_payment/refresh.ts
commercelayer customer_password_reset ID
Execute an action on a resource of type customer_password_resets.
USAGE
$ commercelayer customer_password_reset ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/customer_password_reset/index.ts
commercelayer customer_password_reset:reset_password_token ID
Send the 'reset_password_token' that you got on create when updating the customer password..
USAGE
$ commercelayer customer_password_reset:reset_password_token ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/customer_password_reset/reset_password_token.ts
commercelayer gift_card ID
Execute an action on a resource of type gift_cards.
USAGE
$ commercelayer gift_card ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/gift_card/index.ts
commercelayer gift_card:activate ID
Send this attribute if you want to activate a gift card..
USAGE
$ commercelayer gift_card:activate ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/gift_card/activate.ts
commercelayer gift_card:balance_change_cents ID
The balance change, in cents. Send a negative value to reduces the card balance by the specified amount. Send a positive value to recharge the gift card (if rechargeable)..
USAGE
$ commercelayer gift_card:balance_change_cents ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/gift_card/balance_change_cents.ts
commercelayer gift_card:deactivate ID
Send this attribute if you want to deactivate a gift card..
USAGE
$ commercelayer gift_card:deactivate ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/gift_card/deactivate.ts
commercelayer gift_card:purchase ID
Send this attribute if you want to confirm a draft gift card. The gift card becomes 'inactive', waiting to be activated..
USAGE
$ commercelayer gift_card:purchase ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/gift_card/purchase.ts
commercelayer in_stock_subscription ID
Execute an action on a resource of type in_stock_subscriptions.
USAGE
$ commercelayer in_stock_subscription ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/in_stock_subscription/index.ts
commercelayer in_stock_subscription:activate ID
Send this attribute if you want to activate an inactive subscription..
USAGE
$ commercelayer in_stock_subscription:activate ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/in_stock_subscription/activate.ts
commercelayer in_stock_subscription:deactivate ID
Send this attribute if you want to dactivate an active subscription..
USAGE
$ commercelayer in_stock_subscription:deactivate ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/in_stock_subscription/deactivate.ts
commercelayer klarna_payment ID
Execute an action on a resource of type klarna_payments.
USAGE
$ commercelayer klarna_payment ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/klarna_payment/index.ts
commercelayer klarna_payment:update ID
Send this attribute if you want to update the payment session with fresh order data..
USAGE
$ commercelayer klarna_payment:update ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/klarna_payment/update.ts
commercelayer order ID
Execute an action on a resource of type orders.
USAGE
$ commercelayer order ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/order/index.ts
commercelayer order:approve ID
Send this attribute if you want to approve a placed order..
USAGE
$ commercelayer order:approve ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/order/approve.ts
commercelayer order:approve_and_capture ID
Send this attribute if you want to approve and capture a placed order..
USAGE
$ commercelayer order:approve_and_capture ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/order/approve_and_capture.ts
commercelayer order:archive ID
Send this attribute if you want to archive the order..
USAGE
$ commercelayer order:archive ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/order/archive.ts
commercelayer order:authorization_amount_cents ID
The authorization amount, in cents..
USAGE
$ commercelayer order:authorization_amount_cents ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/order/authorization_amount_cents.ts
commercelayer order:authorize ID
Send this attribute if you want to authorize the order's payment source..
USAGE
$ commercelayer order:authorize ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/order/authorize.ts
commercelayer order:billing_address_clone_id ID
The id of the address that you want to clone to create the order's billing address..
USAGE
$ commercelayer order:billing_address_clone_id ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
-v, --value=value (required) the trigger attribute value
See code: src/commands/order/billing_address_clone_id.ts
commercelayer order:billing_address_same_as_shipping ID
Send this attribute if you want the billing address to be cloned from the order's shipping address..
USAGE
$ commercelayer order:billing_address_same_as_shipping ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/order/billing_address_same_as_shipping.ts
commercelayer order:cancel ID
Send this attribute if you want to cancel a placed order. The order's authorization will be automatically voided..
USAGE
$ commercelayer order:cancel ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/order/cancel.ts
commercelayer order:capture ID
Send this attribute if you want to capture an approved order..
USAGE
$ commercelayer order:capture ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/order/capture.ts
commercelayer order:customer_payment_source_id ID
The id of the customer payment source (i.e. credit card) that you want to use as the order's payment source..
USAGE
$ commercelayer order:customer_payment_source_id ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
-v, --value=value (required) the trigger attribute value
See code: src/commands/order/customer_payment_source_id.ts
commercelayer order:place ID
Send this attribute if you want to place the order..
USAGE
$ commercelayer order:place ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/order/place.ts
commercelayer order:refresh ID
Send this attribute if you want to manually refresh the order..
USAGE
$ commercelayer order:refresh ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/order/refresh.ts
commercelayer order:refund ID
Send this attribute if you want to refund a captured order..
USAGE
$ commercelayer order:refund ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/order/refund.ts
commercelayer order:save_billing_address_to_customer_address_book ID
Send this attribute if you want the order's billing address to be saved in the customer's address book as a customer address..
USAGE
$ commercelayer order:save_billing_address_to_customer_address_book ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/order/save_billing_address_to_customer_address_book.ts
commercelayer order:save_payment_source_to_customer_wallet ID
Send this attribute if you want the order's payment source to be saved in the customer's wallet as a customer payment source..
USAGE
$ commercelayer order:save_payment_source_to_customer_wallet ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/order/save_payment_source_to_customer_wallet.ts
commercelayer order:save_shipping_address_to_customer_address_book ID
Send this attribute if you want the order's shipping address to be saved in the customer's address book as a customer address..
USAGE
$ commercelayer order:save_shipping_address_to_customer_address_book ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/order/save_shipping_address_to_customer_address_book.ts
commercelayer order:shipping_address_clone_id ID
The id of the address that you want to clone to create the order's shipping address..
USAGE
$ commercelayer order:shipping_address_clone_id ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
-v, --value=value (required) the trigger attribute value
See code: src/commands/order/shipping_address_clone_id.ts
commercelayer order:shipping_address_same_as_billing ID
Send this attribute if you want the shipping address to be cloned from the order's billing address..
USAGE
$ commercelayer order:shipping_address_same_as_billing ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/order/shipping_address_same_as_billing.ts
commercelayer order:unarchive ID
Send this attribute if you want to unarchive the order..
USAGE
$ commercelayer order:unarchive ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/order/unarchive.ts
commercelayer order:update_taxes ID
Send this attribute if you want to force tax calculation for this order (a tax calculator must be associated to the order's market)..
USAGE
$ commercelayer order:update_taxes ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/order/update_taxes.ts
commercelayer order_subscription ID
Execute an action on a resource of type order_subscriptions.
USAGE
$ commercelayer order_subscription ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/order_subscription/index.ts
commercelayer order_subscription:activate ID
Send this attribute if you want to mark this subscription as active..
USAGE
$ commercelayer order_subscription:activate ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/order_subscription/activate.ts
commercelayer order_subscription:cancel ID
Send this attribute if you want to mark this subscription as cancelled..
USAGE
$ commercelayer order_subscription:cancel ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/order_subscription/cancel.ts
commercelayer order_subscription:deactivate ID
Send this attribute if you want to mark this subscription as inactive..
USAGE
$ commercelayer order_subscription:deactivate ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/order_subscription/deactivate.ts
commercelayer return ID
Execute an action on a resource of type returns.
USAGE
$ commercelayer return ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/return/index.ts
commercelayer return:approve ID
Send this attribute if you want to mark this return as approved..
USAGE
$ commercelayer return:approve ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/return/approve.ts
commercelayer return:archive ID
Send this attribute if you want to archive the return..
USAGE
$ commercelayer return:archive ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/return/archive.ts
commercelayer return:cancel ID
Send this attribute if you want to mark this return as cancelled..
USAGE
$ commercelayer return:cancel ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/return/cancel.ts
commercelayer return:receive ID
Send this attribute if you want to mark this return as received..
USAGE
$ commercelayer return:receive ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/return/receive.ts
commercelayer return:reject ID
Send this attribute if you want to mark this return as rejected..
USAGE
$ commercelayer return:reject ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/return/reject.ts
commercelayer return:request ID
Send this attribute if you want to activate this return..
USAGE
$ commercelayer return:request ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/return/request.ts
commercelayer return:restock ID
Send this attribute if you want to restock all of the return line items..
USAGE
$ commercelayer return:restock ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/return/restock.ts
commercelayer return:ship ID
Send this attribute if you want to mark this return as shipped..
USAGE
$ commercelayer return:ship ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/return/ship.ts
commercelayer return:unarchive ID
Send this attribute if you want to unarchive the return..
USAGE
$ commercelayer return:unarchive ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/return/unarchive.ts
commercelayer return_line_item ID
Execute an action on a resource of type return_line_items.
USAGE
$ commercelayer return_line_item ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/return_line_item/index.ts
commercelayer return_line_item:restock ID
Send this attribute if you want to restock the line item..
USAGE
$ commercelayer return_line_item:restock ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/return_line_item/restock.ts
commercelayer shipment ID
Execute an action on a resource of type shipments.
USAGE
$ commercelayer shipment ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/shipment/index.ts
commercelayer shipment:get_rates ID
Send this attribute if you want get the shipping rates from the associated carrier accounts..
USAGE
$ commercelayer shipment:get_rates ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/shipment/get_rates.ts
commercelayer shipment:on_hold ID
Send this attribute if you want to put this shipment on hold..
USAGE
$ commercelayer shipment:on_hold ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/shipment/on_hold.ts
commercelayer shipment:packing ID
Send this attribute if you want to start packing this shipment..
USAGE
$ commercelayer shipment:packing ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/shipment/packing.ts
commercelayer shipment:picking ID
Send this attribute if you want to start picking this shipment..
USAGE
$ commercelayer shipment:picking ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/shipment/picking.ts
commercelayer shipment:purchase ID
Send this attribute if you want to purchase this shipment with the selected rate..
USAGE
$ commercelayer shipment:purchase ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/shipment/purchase.ts
commercelayer shipment:ready_to_ship ID
Send this attribute if you want to mark this shipment as ready to ship..
USAGE
$ commercelayer shipment:ready_to_ship ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/shipment/ready_to_ship.ts
commercelayer shipment:ship ID
Send this attribute if you want to mark this shipment as shipped..
USAGE
$ commercelayer shipment:ship ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/shipment/ship.ts
commercelayer stock_transfer ID
Execute an action on a resource of type stock_transfers.
USAGE
$ commercelayer stock_transfer ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/stock_transfer/index.ts
commercelayer stock_transfer:cancel ID
Send this attribute if you want to cancel this stock transfer..
USAGE
$ commercelayer stock_transfer:cancel ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/stock_transfer/cancel.ts
commercelayer stock_transfer:complete ID
Send this attribute if you want to complete this stock transfer..
USAGE
$ commercelayer stock_transfer:complete ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/stock_transfer/complete.ts
commercelayer stock_transfer:in_transit ID
Send this attribute if you want to mark this stock transfer as in transit..
USAGE
$ commercelayer stock_transfer:in_transit ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/stock_transfer/in_transit.ts
commercelayer stock_transfer:picking ID
Send this attribute if you want to start picking this stock transfer..
USAGE
$ commercelayer stock_transfer:picking ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/stock_transfer/picking.ts
commercelayer stock_transfer:upcoming ID
Send this attribute if you want to mark this stock transfer as upcoming..
USAGE
$ commercelayer stock_transfer:upcoming ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/stock_transfer/upcoming.ts
commercelayer stripe_payment ID
Execute an action on a resource of type stripe_payments.
USAGE
$ commercelayer stripe_payment ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/stripe_payment/index.ts
commercelayer stripe_payment:refresh ID
Send this attribute if you want to refresh the payment status, can be used as webhooks fallback logic..
USAGE
$ commercelayer stripe_payment:refresh ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/stripe_payment/refresh.ts
commercelayer webhook ID
Execute an action on a resource of type webhooks.
USAGE
$ commercelayer webhook ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/webhook/index.ts
commercelayer webhook:reset_circuit ID
Send this attribute if you want to reset the circuit breaker associated to this webhook to 'closed' state and zero failures count..
USAGE
$ commercelayer webhook:reset_circuit ID
ARGUMENTS
ID the unique id of the resource
OPTIONS
-j, --json print result in JSON format
-o, --organization=organization (required) the slug of your organization
-p, --print print out the modified resource
-u, --unformatted print JSON output without indentation
See code: src/commands/webhook/reset_circuit.ts