onCheckoutSettingsUpdated( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when checkout settings are updated.

The onCheckoutSettingsUpdated() event handler runs when checkout settings are updated. The received CheckoutSettingsUpdated object contains information about the checkout settings that were updated and event metadata.

Note: Backend events don't work when previewing your site.

Method Declaration
Copy
function wixEcom_onCheckoutSettingsUpdated(
  event: CheckoutSettingsUpdated,
): void;
Method Parameters
eventCheckoutSettingsUpdated

Information about the checkout settings that were updated and event metadata.

onCheckoutSettingsUpdated example
JavaScript
export function wixEcom_onCheckoutSettingsUpdated(event) { const eventId = event.metadata.id; const entityId = event.entity._id; }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?