Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

resource

Resource

Options for assigning a schedule to a resource.

options

CreateResourceOptions

Creates a resource.


The `createResource()` function returns a Promise that resolves to the created resource.
Bookings resources are created with a schedule. The schedule determines the resource's availability by the business's default working hours.

When creating a resource using `createResource()`, get the business resource's schedule ID and include it in the `schedules` object. The default hours can bee found in the Dashboard under **Settings** in the **Bookings** section, on the **Appointment hours** page.


> **Notes:**
>- The Wix Bookings app shows default business hours on the **Staff** page in the dashboard.
>- A resource can have one schedule only.
>- You can have up to 135 active resources and an additional 135 deleted resources.

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { resources } from '@wix/bookings';

const wixClient = createClient({
  modules: { resources },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function createResource(resource, options) {
  const response = await wixClient.resources.createResource(resource, options);
}

createResource() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { resources } from '@wix/bookings';

const wixClient = createClient({
  modules: { resources },
  auth: dashboard.auth(),
  host: dashboard.host()
});

async function createResource(resource, options) {
  const response = await wixClient.resources.createResource(resource, options);
}

createResource() with Dashboard app access

createResource

string

Deletes a resource.

The `deleteResource()` function returns a Promise that is resolved when a resource is deleted.


Deleting a resource updates its status to `DELETED`.

You cannot delete a resource if it has booked sessions.


>**Notes:**
>- The Bookings app automatically creates a resource with a name and tag of value `"business"`. This resource is used for the business's schedule and working hours and cannot be deleted.
>- You can have up to 135 active resources and an additional 135 deleted resources.

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { resources } from '@wix/bookings';

const wixClient = createClient({
  modules: { resources },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function deleteResource(id) {
  const response = await wixClient.resources.deleteResource(id);
}

deleteResource() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { resources } from '@wix/bookings';

const wixClient = createClient({
  modules: { resources },
  auth: dashboard.auth(),
  host: dashboard.host()
});

async function deleteResource(id) {
  const response = await wixClient.resources.deleteResource(id);
}

deleteResource() with Dashboard app access

deleteResource

DeleteResourceResponse

UpdateResource

Updates a resource.


The `updateResource()` function returns a Promise that resolves when a resource is updated. Use this function to update all bookings resource information except for the resource's schedule. To update a resource's schedule use [`updateSchedule()`](#updateschedule).


>**Note:**
> When updating a resource you cannot change the system tags used by the Wix Bookings app. Tags used by the app have the values `"business"` and `"staff"`.

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { resources } from '@wix/bookings';

const wixClient = createClient({
  modules: { resources },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function updateResource(id, resource, options) {
  const response = await wixClient.resources.updateResource(id, resource, options);
}

updateResource() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { resources } from '@wix/bookings';

const wixClient = createClient({
  modules: { resources },
  auth: dashboard.auth(),
  host: dashboard.host()
});

async function updateResource(id, resource, options) {
  const response = await wixClient.resources.updateResource(id, resource, options);
}

updateResource() with Dashboard app access

updateResource

resourceId

schedule

Schedule

Updates a resource's schedule.


The `updateSchedule()` function returns a Promise that resolves when a resource's schedule has been updated. Use this function to update the bookings resource's schedule. To update other resource details use [`updateResource()`](#updateresource).

> **Notes:**
>- A resource can have one schedule only.
>- When updating a resource's schedule you cannot change the system tags used by the Wix Bookings app. Tags used by the app have the values `"INDIVIDUAL"`, `"GROUP"`, and `"COURSE"`.

import { createClient, ApiKeyStrategy } from '@wix/sdk';
import { resources } from '@wix/bookings';

const wixClient = createClient({
  modules: { resources },
  auth: ApiKeyStrategy({
    siteId: 'MY-SITE-ID',
    apiKey: 'MY-API-KEY'
  })
});

async function updateSchedule(resourceId, schedule, options) {
  const response = await wixClient.resources.updateSchedule(resourceId, schedule, options);
}

updateSchedule() with API Key access

import { createClient } from '@wix/sdk';
import { dashboard } from '@wix/dashboard';
import { resources } from '@wix/bookings';

const wixClient = createClient({
  modules: { resources },
  auth: dashboard.auth(),
  host: dashboard.host()
});

async function updateSchedule(resourceId, schedule, options) {
  const response = await wixClient.resources.updateSchedule(resourceId, schedule, options);
}

updateSchedule() with Dashboard app access

updateSchedule

UpdateScheduleResponse

---
title: Introduction
---
# Introduction

&nbsp;

<div style="background-color: #FEF1D1; padding: 18px 24px; border-radius: 6px; border: 1px solid #FDB10C; box-sizing: border-box; display: inline-block">
    <b>Developer Preview</b>
    <br/>
    <span>APIs in <a href="https://www.wix.com/velo/reference/api-overview/developer-preview">Developer Preview</a> are subject to change and are not intended for use in production.<br/><a href="mailto:velo-preview-feedback@wix.com">Send us</a> your suggestions for improving this API. Your feedback is valuable to us.</span>
</div>

&nbsp;


The Bookings Resources API provides functionality for creating and managing resources.

A resource is a business asset like a staff member, or equipment needed to provide a service. Each resource owns a schedule. The schedule defines the resource's availability using the business's default working hours. Resources have tags that you can use for grouping. For example, add a `"room"` tag for classroom resources, and an `"equipment"` tag for resources like computers and projectors.

With the Resources API, you can:

- [Create](https://dev.wix.com/docs/sdk/api-reference/bookings/resources/create-resource) and [delete](https://dev.wix.com/docs/sdk/api-reference/bookings/resources/delete-resource) resources.
- [Update](https://dev.wix.com/docs/sdk/api-reference/bookings/resources/update-resource) a resource. 
- [Update](https://dev.wix.com/docs/sdk/api-reference/bookings/resources/update-schedule) a resource's schedule.


## Before you begin

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

- There are 2 tags that are used by the Wix Bookings app:
    - `"staff"`: Resources with the `"staff"` tag appear in the Bookings app's **Staff** page.
    - `"business"`: The Bookings app creates a resource with a name and tag value of `"business"`. This resource owns a schedule that contains the operating hours of the business and cannot be deleted. This schedule is used when creating resources that use the business’s operating hours for the resource's working hours.
- You can have up to 135 active resources and an additional 135 deleted resources.
- A resource can have one schedule only.
- When updating a resource's schedule you cannot change the system tags used by the Wix Bookings app. Tags used by the app have the values `"INDIVIDUAL"`, `"GROUP"`, and `"COURSE"`.


## Terminology

+ __Resource:__ Business asset like a staff member, room, or equipment that's needed to provide a service.
+ __Schedule:__ Collection of all sessions that belong to the same class, course, appointment, or resource.

To use the Resources API, install the `@wix/bookings` package using npm or Yarn:
  ```console
npm install @wix/bookings
```

or

```console
yarn add @wix/bookings
```

Then import `{ resources }` from `@wix/bookings`:

```js
import { resources } from '@wix/bookings'
```
  

bookings_resources

Address

Main address line, usually street and number, as free text.

addressLine

Street name, number and apartment number.

streetAddress

Free text providing more detailed address info. Usually contains Apt, Suite, and Floor.

addressLine2

city

country

countryFullname

A string containing the full address of this location.

formattedAddress

geocode

AddressLocation

hint

postalCode

Subdivision. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2).

subdivision

Multi-level subdivisions from top to bottom.

subdivisions

latitude

number

longitude

ApprovalStatus

Availability

Constraints for calculating the schedule's availability.

constraints

AvailabilityConstraints

Date and time the schedule stops being available for booking. No value indicates no end time.

Other schedules that impact the availability calculation. Relevant only when there are availability constraints.

linkedSchedules

Date and time the schedule starts to be available for booking.

start

A list of duration options for slots, in minutes. Minimum value for a duration is 1.
The availability calculation generates slots with these durations, where there is no conflict with existing sessions or other availability constraints.

slotDurations

An object defining the time between available slots' start times.  For example, a slot with slots_split_interval=5 can start every 5 minutes. The default is the slot duration.

slotsSplitInterval

SplitInterval

Specify how to split the slots in intervals of minutes.
This value indicates the time between available slots' start time. e.g., from 5 minute slots (3:00, 3:05, 3:15) and 1 hour slots (3:00, 4:00, 5:00).
Optional. The default is the first duration in slot_durations field.
Deprecated. Use the `split_slots_interval.value_in_minutes`.

splitInterval

The number of minutes between the `end` of one slot, and the `start` of the next.
Minimum value is 0, maximum value is 120.

timeBetweenSlots

BaseEventMetadata

eventType

The identification type and identity data.

identity

IdentificationData

instanceId

CalendarConference

URL used by a guest to join the conference.

guestUrl

URL used by the host to start the conference.

hostUrl

ConferenceProvider

providerId

ConferenceType

List of schedules to be assigned for the created resource. Currently only a single schedule is allowed.
If provided, any schedules in the resource entity will be ignored.

schedules

Event

ExternalCalendarOverrides

Synced description of the external calendar event.

description

Synced title of the external calendar event.

title

Frequency

The frequency of the recurrence in weeks. i.e. when this value is 4, the interval occurs every 4 weeks. Optional. The default is 1. minimum: 1, maximum: 52.

repetition

ID of a site visitor that has not logged in to the site.

anonymousVisitorId

appId

ID of a site visitor that has logged in to the site.

memberId

ID of a Wix user (site owner, contributor, etc.).

wixUserId

identityType

WebhookIdentityType

Interval

The day the interval accrue. Optional. The default is the day of the recurring interval's start time.

daysOfWeek

The duration of the interval in minutes. Required. Part of the session end time calculation.

duration

The hour of the day the interval accrue. must be consistent with the Interval start time. Options. The default is 0. minimum: 0, maximum: 23.

hourOfDay

The minutes of hour the interval accrue. must be consistent with the Interval end time. Options. The default is 0. minimum: 0, maximum: 59.

minuteOfHour

LinkedSchedule

scheduleId

scheduleOwnerId

Sets this schedule's availability for the duration of the linked schedule's sessions.  Default is `"BUSY"`.
If set to `"BUSY"`, this schedule cannot have any available slots during the linked schedule's sessions.
If set to `"FREE"`, this schedule can have available slots during the linked schedule's sessions.

transparency

Transparency

Location

Free text address used when locationType is `OWNER_CUSTOM`.

address

Custom address, used when locationType is `"OWNER_CUSTOM"`. Might be used when locationType is `"CUSTOM"` in case the owner sets a custom address for the session which is different from the default.

customAddress

Location type.
One of:
- `"OWNER_BUSINESS"` The business address as set in the site’s general settings.
- `"OWNER_CUSTOM"` The address as set when creating the service.
- `"CUSTOM"` The address set for the individual session.

locationType

LocationType

OnResourceNotificationHandler

event

ResourceNotificationEnvelope

void

Participant

Participant ID. Currently represents the booking.id.

Approval status for the participant.

approvalStatus

contactId

email

Whether the participant was inherited from the schedule, as opposed to being booked directly to the session.

inherited

boolean

name

Group or party size. The number of people attending. Defaults to 0. Maximum is 250.

partySize

phone

Price

amount

currency

Amount of a down payment or deposit as part of the transaction.

downPayAmount

Rate

Mapping between a named price option, for example, adult or child prices, and the price, currency, and down payment amount.
When present in an update request, the `default_varied_price` is ignored to support backward compatibility.

labeledPriceOptions

Textual price information used when **Price Per Session** is set to **Custom Price** in the app's service details page.
When present in an update request, the `default_varied_price` is ignored to support backward compatibility.

priceText

RecurringInterval

Specifies the list of linked schedules and the way this link affects the corresponding schedules' availability. Can be calculated from the schedule or overridden on the recurring interval.

affectedSchedules

The end time of the recurring interval. Optional. Empty value indicates that there is no end time.

The frequency of the interval. Optional. The default is frequency with the default repetition.

frequency

The interval rules. The day, hour and minutes the interval is recurring.

interval

intervalType

RecurringIntervalType

The start time of the recurring interval. Required.

images

List of IDs of schedules owned by this resource.

scheduleIds

Resource status.

One of:
- `"CREATED"` Default status.
- `"DELETED"` The resource was deleted.
- `"UPDATED"` The resource was updated.

status

ResourceStatus

Resource tags. Tags are used to identify, group, and filter the different types of resources. For example, 'staff' or 'room'.

ResourceNotification

Updated resource entity.
'resource.schedules' is deprecated and will not be returned. Please use 'resource.scheduleIds' instead.

data

metadata

A conference created for the schedule. This is used when a participant is added to a schedule.

calendarConference

Maximum number of participants that can be added to the schedule's sessions. Must be at most `1` for schedule whose availability is affected by another schedule. For example, appointment schedules of the Wix Bookings app.

updateSchedule( )

Permission Scopes