Introduction

With Locations, you can define multiple physical locations for their business. You can also set individual opening hours for each location.

The Locations API allows you to:

• Get, list, and query existing locations.
• Create, update, and archive locations.
• Set a default location that is reflected in the site properties.

Read more about how site owners can manage their location-specific bookings.

To use the Locations API, import { locations } from wix-business-tools.v2:

Before you begin

It’s important to note the following points before starting to code:

• The Wix Bookings API doesn't support the businessSchedule object.
• You can't delete a location. Instead, you can archive a location using the archiveLocation() function.
• You can't archive the default location.
• You can't unarchive an archived location.
• You must pass the full location object in the location parameter when using the updateLocation() function. Currently, you can't partially update a location.
• locationType isn't currently supported.
• The status INACTIVE isn't currently supported.

Terminology

• Type: Describes whether a location is an office, reception, branch or the headquarters.
• Status: Indicates whether a location is ACTIVE or INACTIVE.

Permissions information

Functions in the Locations API are restricted and only run if you elevate permissions using the wix-auth elevate() function.