Setup

Retrieves an available multiService TimeSlot that match the provided filters.

Throws SlotNotFound if there is no such available time slot.

By default, if you don't provide a service.includeResourceTypeIds or service.resourceIds in request, we return for each TimeSlot.NestedTimeSlot all AvailableResources with all AvailableResources.resources which are available to provide the corresponding service within the time slot.

If you specify service.includeResourceTypeIds or service.resourceIds in request, the returned TimeSlot.NestedTimeSlot for this service will contain only AvailableResources with at least one available resource which match the given resources filters, each contains all available resources out of those requested.

• Notes:
• All nested time slots share the same location.
• You can pass up to 8 services.

function getMultiServiceAvailabilityTimeSlot(services: Array<Service>, localStartDate: string, localEndDate: string, timeZone: string, location: Location): Promise<GetMultiServiceAvailabilityTimeSlotResponse>

Retrieves a list of multiService TimeSlots that match the provided filters.

The request body must include either:

• All of the following filters: service.serviceId, fromLocalDate, toLocalDate, location, and timeZone. You may add additional filters as you wish.
• A cursorPaging with a valid cursor from previous response.

Each TimeSlot in response represents the availability of the given sequence of services in a specific order, location, and within a given range of time.

Each TimeSlot.NestedTimeSlot represents a single service from the given list. The order of the NestedTimeSlots is the same as the order of the given services in request. The first NestedTimeSlot has localStartDate within the given fromLocalDate and toLocalDate exclusive, and each following NestedTimeSlot has a localStartDate that equals to the previous NestedTimeSlot's localEndDate.

By default, the response contains at most 1000 results. If there are more than 1000 results, we return a cursorPagingMetadata with a cursor for the next page of results, regardless of whether a cursorPaging was provided in request.

AvailableResources in response:

The TimeSlot.NestedTimeSlot's AvailableResources contains information about the resources that are available to provide the service within the NestedTimeSlot range of time. Each AvailableResources contains information about available resources of the same type.

If you wish to get a list of available resources for a TimeSlot.NestedTimeSlot you should either:

• provide service.resourceIds in request.
• provide service.includeResourceTypeIds in request.

Notes:

• In both cases the returned TimeSlot.NestedTimeSlot contains up to 10 AvailableResources that match the provided filters. Each AvailableResources contains up to 10 available resources of the same type that match the provided filters.
• If an AvailableResources has more available resources which are not listed within it, we return AvailableResources.hasMoreAvailableResources as true.
• If you wish to get the full available resources list for all NestedTimeSlot of a specific TimeSlot, you should call GetMultiServiceAvailabilityTimeSlot.

Availability VS Bookability

An available time slot is not necessarily bookable. The bookable field of a TimeSlot indicates whether the customer can book all of the of the services within the given time slot, at a specific period of time. Read more about Availability VS Bookability.

By default,

• The response does not contains unavailable TimeSlots.For example, if there are no available resources to provide one of the services from 2024-01-30T14:30:00 to 2024-01-30T15:30:00, we don't return TimeSlots with NestedTimeSlot.localStartDate within this range for this service.
• The response contains both bookable and un-bookable TimeSlots.For example, if one of the services has a booking policy which enforces booking the service up to 10 minutes before the session starts, we return TimeSlots with the violating NestedTimeSlot.localStartDate, with bookable as false. If you want to list only bookable TimeSlots you should pass bookable as true.
• If booking one of the NestedTimeSlots violates one of the corresponding service's booking policies, the TimeSlot returns with bookable as false. There is no indication which service's policy was violated.

ListAvailabilityTimeSlots runs with the following defaults:

• localStartDate is sorted in ASC order.
• cursorPaging.limit is 1000.

function listMultiServiceAvailabilityTimeSlots(options: ListMultiServiceAvailabilityTimeSlotsOptions): Promise<ListMultiServiceAvailabilityTimeSlotsResponse>