About the Resources V2 API

The Resources V2 API allows you to manage the resources businesses need to offer their services to customers. Resources can include meeting rooms, equipment, and any other assets that require scheduling and availability management.

To make a resource bookable for customers, associate it with a resource type. Use the Resource Types V2 API (SDK | REST) to manage these resource types.

For staff management, use the Staff Members API (SDK | REST). Note that Wix Bookings automatically creates and manages a resource for each staff member. Managing staff through the Resources V2 API can lead to data conflicts.

Before you begin

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

  • Wix Bookings must be installed on a site before you can use the Resources API.
  • Resources are visible only to the business and not to customers when booking a service (SDK | REST).
  • To ensure a resource is bookable and to prevent double bookings, it must be linked to a resource type (SDK | REST). Customers can book a service only if at least one resource of each required type is available during the selected time.
  • Each resource has an event schedule (SDK | REST), which contains information about all related bookings (SDK | REST).
  • Resources linked to staff members can only be managed through the Staff Members API (SDK | REST). Staff member resources also have a working hour schedule in addition to the event schedule. Learn more about how Bookings uses the Calendar APIs (SDK | REST). The availability of non-staff member resources depends solely on their location's (SDK | REST) business hours.

Use Cases

  • Create a bookable resource (SDK | REST).

Terminology

  • Resource: An asset or entity that a business needs to offer services to customers. For example, a specific meeting room or piece of equipment.
  • Resource type: A classification that links resources to make them bookable.
  • Staff member: An individual providing a service within Wix Bookings.
  • Event schedule: The schedule containing all sessions during which a resource is booked.
  • Working hour schedule: Specifies when a resource, associated with a staff member, is available for bookings.
  • Location: A physical site where a resource can be booked.

For a comprehensive glossary of Wix Bookings terms, see Terminology (SDK | REST).

See also

Did this help?