Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

Contains information about the archived location and metadata for the event.

event

LocationArchiveStatus

// 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_onLocationArchiveStatus(event) {
  const archivedTime = event.metadata.eventTime;

  console.log(`Location was archived at ${archivedTime}. Event details:`, event)
}

/* Full event object:
 * {
 *   "data": {
 *     "_id": "489d0ea1-9eb4-4215-9616-98e297c7337e"
 *   },
 *   "metadata": {
 *     "entityId": "489d0ea1-9eb4-4215-9616-98e297c7337e",
 *     "eventTime": "2023-11-13T08:00:47.696025Z",
 *     "id": "a92d9e8b-abd7-4903-a954-5a6848f6f4eb",
 *     "triggeredByAnonymizeRequest": false
 *   }
 * }
 */

An event that triggers when a location is archived 

onLocationArchiveStatus

void

Contains information about the created location and metadata for the event.

LocationCreated

// 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_onLocationCreated(event) {
  const createdTime = event.metadata.eventTime;

  console.log(`Location was created at ${createdTime}. Event details:`, event)
}

/* Full event object:
 * {
 *   "entity": { 
 *     "_id": "a636dae4-fdc9-4da8-9eef-7b0d23b34f22",
 *     "address": { 
 *       "city": "São Paulo", 
 *       "country": "BR", 
 *       "formatted": "123 Avenida Paulista, São Paulo", 
 *       "location": { 
 *         "latitude": -23.561722, 
 *         "longitude": -46.655275 
 *       }, 
 *       "postalCode": "01311-000" 
 *       "streetAddress": { 
 *         "apt": "" 
 *         "name": "Avenida Paulista", 
 *         "number": "123", 
 *       }, 
 *       "subdivision": "BR-SP", 
 *     }, 
 *     "archived": false, 
 *     "businessSchedule": { 
 *       "periods": [
 *         { 
 *           "closeDay": "MONDAY", 
 *           "closeTime": "18:00",
 *           "openDay": "MONDAY", 
 *           "openTime": "08:00"
 *         }, 
 *         { 
 *           "closeDay": "TUESDAY", 
 *           "closeTime": "18:00",
 *           "openDay": "TUESDAY", 
 *           "openTime": "08:00"
 *         }, 
 *         { 
 *           "closeDay": "WEDNESDAY",
 *           "closeTime": "18:00",
 *           "openDay": "WEDNESDAY",
 *           "openTime": "08:00"
 *         }, 
 *         { 
 *           "closeDay": "THURSDAY", 
 *           "closeTime": "18:00",
 *           "openDay": "THURSDAY", 
 *           "openTime": "08:00"
 *         }, 
 *         { 
 *           "closeDay": "FRIDAY", 
 *           "closeTime": "18:00",
 *           "openDay": "FRIDAY", 
 *           "openTime": "08:00"
 *         }
 *       ], 
 *       "specialHourPeriod": [
 *         { 
 *           "comment": "Half price in the lead up to Christmas!",
 *           "endDate": "2023-12-24T23:59:00Z", 
 *           "isClosed": false, 
 *           "startDate": "2023-12-01T00:00:00Z"
 *         }
 *       ] 
 *     }, 
 *     "default": false, 
 *     "description": "Our location in São Paulo City Center!", 
 *     "email": "saopaulo@example.com", 
 *     "fax": "011-55-11-987654321", 
 *     "name": "São Paulo City Center Store", 
 *     "phone": "011 98765 4321", 
 *     "revision": "1", 
 *     "status": "ACTIVE", 
 *     "timeZone": "America/Sao_Paulo", 
 *   },
 *   "metadata": { 
 *     "entityId": "a636dae4-fdc9-4da8-9eef-7b0d23b34f22", 
 *     "eventTime": "2023-11-13T08:22:25.392520Z", 
 *     "id": "a41b6434-982d-413d-8ce0-ac4dd8d3dc00",
 *     "triggeredByAnonymizeRequest": false
 *   }
 * }
 */

An event that triggers when a location is created 

onLocationCreated

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

LocationSetDefaultLocation

Triggered when a location is set as the default location.

// 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"
 *   }
 * }
*/

An event that triggers when a location is set to be the default location 

onLocationSetDefaultLocation

Contains information about the updated location and metadata for the event.

LocationUpdated

Triggered when a location is updated.


This event is triggered only in cases in which a location's writable properties are updated. Therefore, it is not triggered when a location is archived or set as the default location.

// 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_onLocationCreated(event) {
  const timeOfUpdate = event.metadata.eventTime;
  const updatedLocationName = event.entity.name;

  console.log(`${updatedLocationName} was updated at ${timeOfUpdate}. Event details:`, event)
}
  
/* Full event object:
 * {
 *   "entity": {
 *     "_id": "6c8ea272-6538-4787-b2e8-9e1e9fb40990",
 *     "address": {
 *       "city": "Barcelona",
 *       "country": "ES",
 *       "formatted": "123 Carrer de Gràcia, Barcelona",
 *       "location": {
 *         "latitude": 41.393349,
 *         "longitude": 2.162154
 *       },
 *       "postalCode": "08008",
 *       "streetAddress": {
 *         "apt": "",
 *         "name": "Carrer de Gràcia",
 *         "number": "123"
 *       },
 *       "subdivision": "ES-CT"
 *     },
 *     "archived": false,
 *     "businessSchedule": {
 *       "periods": [
 *         {
 *           "closeDay": "MONDAY",
 *           "closeTime": "18:00",
 *           "openDay": "MONDAY",
 *           "openTime": "08:00"
 *         },
 *         {
 *           "closeDay": "TUESDAY",
 *           "closeTime": "18:00",
 *           "openDay": "TUESDAY",
 *           "openTime": "08:00"
 *         },
 *         {
 *           "closeDay": "WEDNESDAY",
 *           "closeTime": "18:00",
 *           "openDay": "WEDNESDAY",
 *           "openTime": "08:00"
 *         },
 *         {
 *           "closeDay": "THURSDAY",
 *           "closeTime": "18:00",
 *           "openDay": "THURSDAY",
 *           "openTime": "08:00"
 *         },
 *         {
 *           "closeDay": "FRIDAY",
 *           "closeTime": "18:00",
 *           "openDay": "FRIDAY",
 *           "openTime": "08:00"
 *         }
 *       ],
 *       "specialHourPeriod": [
 *         {
 *           "comment": "Half price in the lead up to Christmas!",
 *           "endDate": "2023-12-24T23:59:00Z",
 *           "isClosed": false,
 *           "startDate": "2023-12-01T00:00:00Z"
 *         }
 *       ]
 *     },
 *     "default": false,
 *     "description": "Our location in Barcelona City Center!",
 *     "email": "barcelona@example.com",
 *     "fax": "011-34-93-8765432",
 *     "name": "Barcelona City Center Store",
 *     "phone": "011 34 93 876 5432",
 *     "revision": "2",
 *     "status": "ACTIVE",
 *     "timeZone": "Europe/Madrid"
 *   },
 *   "metadata": {
 *     "entityId": "6c8ea272-6538-4787-b2e8-9e1e9fb40990",
 *     "eventTime": "2023-11-13T09:18:32.050964Z",
 *     "id": "c7f35c35-cdbb-42d2-9bf9-0389d644387e",
 *     "triggeredByAnonymizeRequest": false
 *   }
 * }
 */

onLocationUpdated

velo-events_wix-business-tools.v2

Address

city

string

2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.

country

formatted

location

AddressLocation

postalCode

Street address. Includes street name, number, and apartment number in separate fields.

streetAddress

StreetAddress

Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format.

subdivision

Latitude of the location. Must be between -90 and 90.

latitude

number

Longitude of the location. Must be between -180 and 180.

longitude

ArchiveLocation

BackendEventMetadata

ID of the entity associated with the event.

entityId

eventTime

Whether the event was triggered as a result of a privacy regulation application (for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)). For advanced users.

triggeredByAnonymizeRequest

boolean

BusinessSchedule

Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.

periods

Exceptions to the business's regular hours. The business can be open or closed during the exception.

specialHourPeriod

DayOfWeek

Location

address

Whether the location is archived. Archived locations can't be updated.
__Note:__ [Archiving a location](https://dev.wix.com/api/rest/business-info/locations/archive-location)
doesn't affect its `status`.

archived

Business schedule. Array of weekly recurring time periods when the location is open for business. Limited to 100 time periods.

__Note:__ Not supported by Wix Bookings.

businessSchedule

Whether this is the default location. There can only be one default location per site. The default location can't be archived.

default

description

email

Location type.

**Note:** Currently not supported.

locationType

LocationType

locationTypes

name

phone

Revision number, which increments by 1 each time the location is updated.
To prevent conflicting changes, the existing revision must be used when updating a location.

revision

Location status. Defaults to `ACTIVE`.
__Note:__ [Archiving a location](https://dev.wix.com/api/rest/business-info/locations/archive-location)
doesn't affect the location's status. `INACTIVE` is currently not supported.

status

LocationStatus

timeZone

data

metadata

entity

SetDefaultLocation

currDefaultLocationId

prevDefaultLocationId

SpecialHourPeriod

Additional info about the exception. For example, "We close earlier on New Year's Eve."

comment

End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).

endDate

Whether the business is closed (or the service is not available) during the exception.

Default: `true`.

isClosed

Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).

startDate

TimePeriod

closeDay

Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
midnight at the end of the specified day.

__Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.

closeTime

openDay

Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
midnight at the end of the specified day.

openTime

apartmentNumber

coordinates

GeoCoordinates

Two-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.

Google-formatted version of this address.

googleFormattedAddress

Extra information to be displayed in the address.

hint

AddressHint

Whether this address represents a physical location.

isPhysical

state

street

streetNumber

Where the extra text should be displayed.

placement

PlacementType

Extra text displayed next to, or instead of, the actual address.

text

businessTermId

primary

secondary

ConsentPolicy

Whether the site uses cookies that collect information allowing better customization of the experience for a current visitor.

advertising

Whether the site uses cookies that collect analytics about how the site is used (in order to improve it).

analytics

dataToThirdParty

Whether the site uses cookies that are essential to site operation.

essential

Whether the site uses cookies that affect site performance and other functional measurements.

functional

Locale

Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format.

Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.

languageCode

Multilingual

autoRedirect

supportedLanguages

Properties

Supported values: `FITNESS SERVICE`, `RESTAURANT`, `BLOG`, `STORE`, `EVENT`, `UNKNOWN`.

Site business type.

businessConfig

businessName

Business schedule. Regular and exceptional time periods when the business is open or the service is available.

__Note:__ Not supported by Wix Bookings.

consentPolicy

External site url that uses Wix as its headless business solution

externalSiteUrl

Site language.

Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.

language

locale

Path to the site's logo in Wix Media (without Wix Media base URL).

logo

Supported languages of a site and the primary language.

multilingual

Site currency format used to bill customers.

Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.

onLocationArchiveStatus( )