onCheckoutSettingsUpdated( )

Developer Preview

Triggered when checkout settings are updated.

Description

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.

Syntax

function wixEcom_onCheckoutSettingsUpdated(event: CheckoutSettingsUpdated): void

onCheckoutSettingsUpdated Parameters

NAME

TYPE

DESCRIPTION

event

Optional

CheckoutSettingsUpdated

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

Returns

This function does not return anything.

Return Type:

void

Was this helpful?

onCheckoutSettingsUpdated example

Copy Code

1
2  export function wixEcom_onCheckoutSettingsUpdated(event) {
3    const eventId = event.metadata.id
4    const entityId = event.entity._id;
5  }
6
7