About the Locations API

With the Locations API, Wix users can define multiple physical locations for their business. This allows them to set individual opening hours for each location.

The Locations API allows you to:

Read more about how Wix users can manage their location specific bookings. You can also read more about how to retrieve the site properties.

Use cases

Before you begin

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

  • Locations can't be deleted. Instead, you can archive a location using Archive Location. Archiving is permanent; archived locations can't be unarchived.
  • The default location can't be archived.
  • The Update Location method completely overrides an existing 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 INACTIVE location status isn't currently supported.
  • The Wix Bookings API doesn't support the businessSchedule object.

Terminology

  • 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 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.
Did this help?