About the Resources API

The Resources API is an integral part of the Wix Bookings app, designed to manage and interact with various types of resources that can be booked by customers. These resources could include meeting rooms, equipment, event spaces, or any other assets that require scheduling and availability management.

The Resources API provides functionality to manage resources, including creating, updating, deleting, and querying resources.

Before you begin

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

  • Ensure that the Wix Bookings app is installed and configured on the site before using this API.
  • Resources API is part of the Resource Management feature in Wix Bookings. Learn more about managing your resources.
  • In order for a resource to be bookable and to avoid double bookings, it must be associated with a resource type. In turn, the resource type must be connected to the
    relevant services. Learn more about Resource Types and Services.
  • At least one resource of each resource type that is connected to a service must be available at the chosen time in order for customers to book.
  • Resources are only visible to the business. Customers are not able to see them when booking a service.
  • A resource that is associated with a staff member can only be managed via the Staff Member API. Learn more about managing your staff and Staff Member API.
  • Only a resource that is associated with a staff member has a working hours schedule to specify the availability. The availability of any other type of resource is solely based on their location.
  • When deleting a resource, the associated events schedule and any working hours schedule that is not shared are automatically cancelled.

Use Cases

Terminology

  • Resource: An asset or entity that can be reserved or booked for a specified period within Wix Bookings.
  • Resource type: A classification of resources. A resource must be associated with a resource type to be bookable.
  • Staff member: An individual who provides booking services on the site.
  • Working hours schedule: The schedule that defines when a resource is available for bookings. Currently, only a resource that is associated with a staff member can have a working hours schedule.
  • Location: A physical place where a resource is available for booking.
  • Events schedule: The schedule that contains all session in which a resource is booked.

For a comprehensive glossary of Wix Bookings terms, see Terminology

See also

Did this help?