Location Object


Properties
idstringRead-onlyformat GUID

Location ID.


namestringmaxLength 150

Location name.


descriptionstringmaxLength 500

Location description.


defaultbooleanRead-only

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


statusstring

Location status. Defaults to ACTIVE. Note: Archiving a location doesn't affect the location's status. INACTIVE is currently not supported.


locationTypestring

Location type.

Note: Currently not supported.


faxstring

Fax number.


timeZonestring

Timezone in America/New_York format.


emailstring

Email address.


phonestring

Phone number.


addressAddress

Address.


businessScheduleBusinessSchedule

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.


revisionRevision

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.


archivedbooleanRead-only

Whether the location is archived. Archived locations can't be updated. Note: Archiving a location doesn't affect its status.

Did this help?