Events
Additional information about this section
Perform actions on an object
- onAbandonedCheckoutCreated( )
An event that triggers when an abandoned checkout is created.
- onAbandonedCheckoutRecovered( )
An event that triggers when an abandoned checkout is recovered (the customer completes the checkout).
- onBackInStockNotificationRequestCreated( )
Triggered when a back in stock notification request is created.
- onBackInStockNotificationRequestDeleted( )
Triggered when a back in stock notification request is deleted.
- onBackInStockNotificationRequestUpdated( )
Triggered when a back in stock notification request is updated.
- onCartCreated( )
An event that triggers when a new cart is created.
- onCartDeleted( )
An event that triggers when a cart is deleted.
- onCartUpdated( )
An event that triggers when a cart is updated.
- onCheckoutCompleted( )
An event that triggers when a checkout is completed. This happens either when an order is created from a checkout, or after using markCheckoutAsCompleted().
- onCheckoutCreated( )
An event that triggers when a new checkout is created. For example, when a checkout is created from a cart or after using createCheckout().
- onCheckoutSettingsUpdated( )
Triggered when checkout settings are updated.
- onCheckoutTemplateCreated( )
Triggered when a checkout template is created.
- onCheckoutTemplateDeleted( )
Triggered when a checkout template is deleted.
- onCheckoutTemplateUpdated( )
Triggered when a checkout template is updated.
- onCheckoutTemplateUsed( )
Triggered when a checkout template is used to create a checkout.
- onCheckoutUpdated( )
An event that triggers when a checkout is updated. A checkout is updated when, for example, items are added or a coupon is removed.
- onDiscountRuleCreated( )
An event that is triggered when a discount rule is created.
- onDiscountRuleDeleted( )
An event that is triggered when a discount rule is deleted.
- onDiscountRuleUpdated( )
An event that is triggered when a discount rule is updated.
- onFulfillmentsUpdated( )
An event that triggers when one or more of an order's fulfillments are created, updated, or deleted.
- onOrderApproved( )
An event that triggers when an order is approved.
- onOrderCanceled( )
Triggered when an order is canceled.
- onOrderCreated( )
Triggered when an order is created.
- onOrderPaymentStatusUpdated( )
Triggered when an order's payment status is updated to "PAID".
- onOrderTransactionsUpdated( )
Triggered when a payment or refund is added to an order, or when an existing payment is updated.
- onOrderUpdated( )
Triggered when an order is updated.
- onOrdersSettingsUpdated( )
Triggered when order settings are updated.