With Locations, site owners can define multiple physical locations for their business. This allows them to set individual opening hours for each location.

The Locations API allows your app to:

• List 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. You can also read more about how to retrieve the site properties.

• Default location: Location reflected in the site properties. This location is used on invoices.
• Type: Describes whether a location is an office, reception, branch or the headquarters.
• Status: Indicates whether a location is ACTIVE or INACTIVE.
• Business Schedule: Describes the location's regular and exceptional opening hours.
  • Period: Regular, weekly recurring opening hours of the location.
  • Special Hour Period: Exception to the location's regular hours. The location can be either open or closed during the Special Hour Period.

• The Wix Bookings API doesn't support the businessSchedule object.
• You can't delete a location. Instead, you can archive a location using the Archive Location endpoint.
• You can't archive the default location.
• Archived locations can't be unarchived.
• The Update Location endpoint replaces a location. Currently, you can't partially update a location.
• Currently, the location type is just informational and doesn't affect a location's functionality.
• The status INACTIVE isn't currently supported.

This article shares a possible use case for your app, as well as an example flow that supports it. You're certainly not limited to this use case, but it can be a helpful jumping off point as you plan your app's implementation.

Your app can help the site owners create a new business location, set it as default, and update the opening hours for a location.

1. Call the Create Location endpoint.

2. Set the new location as default via the Set Default Location endpoint.

3. List all existing locations by calling the List Locations endpoint.

   Note: Make sure to extract the relevant locations’ IDs from the response and save it for future calls.

4. Update a location's opening hours via the Update Location endpoint.

   Note: Currently, it isn't possible to partially update a location. Therefore, you'll need to pass the full location object in the body of the call.