onLocationSetDefaultLocation( )


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 a location is set as default.

Method Declaration
Copy
function wixLocations_onLocationSetDefaultLocation(
  event: LocationSetDefaultLocation,
): void;
Method Parameters
eventLocationSetDefaultLocation

Contains information about the new default location and metadata for the event.

An event that triggers when a location is set to be the default location
JavaScript
// Place this code in the events.js file // of your site's Backend section. // Add the file if it doesn't exist. export function wixLocations_onLocationSetDefaultLocation(event) { const changeOfDefaultTime = event.metadata.eventTime; const oldDefault = event.data.prevDefaultLocationId; const newDefault = event.data.currDefaultLocationId; console.log( `Default location has been changed from location with id ${oldDefault} to location with id ${newDefault}. The change took place at ${changeOfDefaultTime}. Event details:`, event, ); } /* Full event object: * { * "metadata": { * "entityId":"a636dae4-fdc9-4da8-9eef-7b0d23b34f22", * "eventTime":"2023-11-13T09:01:28.564399Z", * "id": "4d896c67-74f0-4103-86bd-db7b0cbded81", * "triggeredByAnonymizeRequest":false * }, * "data": { * "currDefaultLocationId":"a636dae4-fdc9-4da8-9eef-7b0d23b34f22", * "prevDefaultLocationId":"6a7a7356-a122-4de6-943c-3ea9e66f0d0a" * } * } */
Errors

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

Did this help?