> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # ListMultiServiceAvailabilityTimeSlots # Package: timeSlots # Namespace: MultiServiceAvailabilityTimeSlots # Method link: https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/list-multi-service-availability-time-slots.md ## Permission Scopes: Read Bookings Calendar Availability: SCOPE.DC-BOOKINGS.READ-CALENDAR ## Introduction Retrieves a list of multi-service time slots that match the provided filters. --- ## REST API ### Schema ``` Method: listMultiServiceAvailabilityTimeSlots Description: Retrieves a list of multi-service time slots that match the provided filters. ### Required filters You must specify one of: - `services.serviceId`, `fromLocalDate`, `toLocalDate`, `location`, and `timeZone` (additional filters are optional). - `cursorPaging.cursor` returned from a previous response. Each returned `timeSlot` acts as a container spanning the entire service sequence, with nested time slots providing individual service details. ### Defaults - Results are sorted by `localStartDate` in ascending order. - `cursorPaging.limit` is `1000`. - The response contains both bookable and non-bookable slots. ### Service type limitations Only appointment-type services are supported. To retrieve appointment availability for a single service, call [List Availability Time Slots](https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/list-availability-time-slots.md). ### Booking policy filtering Use `bookingPolicyViolations` to filter slots based on booking restrictions defined in your [booking policies](https://dev.wix.com/docs/api-reference/business-solutions/bookings/policies/booking-policies/introduction.md). *Default behavior**: When you don't specify any `bookingPolicyViolations` filters, all slots are returned regardless of their booking policy status. - Set `tooEarlyToBook` to `true` and optionally specify `earliestBookingDate` to retrieve slots that can't be booked yet due to minimum advance booking time restrictions. Use `earliestBookingDate` to further filter by when the slot becomes bookable. - Set `tooLateToBook` to `true` to retrieve slots that can no longer be booked due to maximum advance booking time restrictions. - Set `bookOnlineDisabled` to `true` or `false` to filter by online booking availability settings. ### Customer choices Use `services.customerChoices` to calculate availability based on the customer's selected service duration or add-ons for each service. When using [add-ons](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/add-ons/introduction.md), we recommend passing only `addOnIds` in `customerChoices` and omitting `durationInMinutes`. Wix Bookings then calculates the total duration automatically. If you specify both `addOnIds` and `durationInMinutes`, `durationInMinutes` must equal the service duration plus all selected add-on durations. URL: https://www.wixapis.com/_api/service-availability/v2/multi-service-time-slots Method: POST Method parameters: param name: bookable | type: bookable | description: Whether the time slot is bookable according to all services' booking policies. If not specified, returns both bookable and non-bookable time slots. param name: bookingPolicyViolations | type: BookingPolicyViolations - name: tooEarlyToBook | type: boolean | description: Whether it's too early for customers to book the slot. By default, all slots are returned. Specifying `{"tooEarlyToBook": false}` returns only those that customers can already book, while specifying `{"tooEarlyToBook": true}` returns only those that can't be booked yet. - name: earliestBookingDate | type: string | description: Earliest time for booking the slot in `YYYY-MM-DDThh:mm:ss.sssZ` format. *In responses**: Contains a value when `tooEarlyToBook` is `true`, indicating the earliest time customers can book the slot. *In requests**: Don't specify a value for this field. Use `tooEarlyToBook` to filter slots that can't be booked yet due to minimum advance booking time restrictions. - name: tooLateToBook | type: boolean | description: Whether it's too late for customers to book the slot. By default, all slots are returned. Specifying `{"tooLateToBook": false}` returns only those that customers can still book, while specifying `{"tooLateToBook": true}` returns only those that can no longer be booked. - name: bookOnlineDisabled | type: boolean | description: Whether customers can book the service online. By default, both services with online booking enabled and disabled are returned. Providing the boolean set to `true` or `false` returns only matching slots. param name: cursorPaging | type: CursorPaging - name: limit | type: integer | description: Number of results to load. Default: `1000`. Max: `1000`. - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. You can get the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. param name: fromLocalDate | type: fromLocalDate | description: Lower boundary for `localStartDate` in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601). For example, `2026-01-30T13:30:00`. Each returned time slot has a `localStartDate` between `fromLocalDate` and `toLocalDate`. Required unless you specify `cursorPaging.cursor`. param name: location | type: Location - name: id | type: string | description: [Location GUID](https://dev.wix.com/docs/api-reference/business-management/locations/introduction.md). Available only for business locations. - name: name | type: string | description: Location name. - name: formattedAddress | type: string | description: Formatted location address. - name: locationType | type: LocationType | description: Location type. - enum: - BUSINESS: A business location, either the default business address, or locations defined for the business by the Business Info. - CUSTOM: The location is unique to this service and isn't defined as 1 of the business locations. - CUSTOMER: The location can be determined by the customer and isn't set up beforehand. param name: services | type: array | description: Services for which the multi-service time slots are returned. Each service can include its own resource filters. Required unless you specify `cursorPaging.cursor`. Min: 2 services Max: 8 services - name: serviceId | type: string | description: Service GUID. - name: includeResourceTypeIds | type: array | description: Resource [type GUIDs](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resource-types-v2/introduction.md) to include in returned time slots. This is in addition to the specifically requested resources.
Currently supported only for Staff Member resource type. Staff members belong to resource type GUID `1cd44cf8-756f-41c3-bd90-3e2ffcaf1155`.
- name: customerChoices | type: CustomerChoices | description: Selected customer choices. If specified, the selected choices are used to calculate service configuration. If not specified, the service default configuration is used. Enforcing this field is the responsibility of the service plugin implementer, and not the Time Slots V2 API. When using [add-ons](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/add-ons/introduction.md), we recommend passing only `addOnIds` and omitting `durationInMinutes`. Wix Bookings then calculates the total duration automatically. If you specify both `addOnIds` and `durationInMinutes`, `durationInMinutes` must equal the service duration plus all selected add-on durations. - name: durationInMinutes | type: integer | description: Selected duration in minutes, based on a [service variant](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/service-options-and-variants/introduction.md) the customer chose. When using [add-ons](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/add-ons/introduction.md), we recommend passing only `addOnIds` instead of `durationInMinutes`. Wix Bookings then calculates the total duration automatically. If you specify both `addOnIds` and `durationInMinutes`, `durationInMinutes` must equal the service duration plus all selected add-on durations. Min: `1` minute Max: `44639` minutes (30 days, 23 hours, and 59 minutes) Default: `15` minutes - name: addOnIds | type: array | description: Selected [add-on](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/add-ons/introduction.md) GUIDs. When specifying this field, we recommend omitting `durationInMinutes`. Wix Bookings then calculates the total duration based on the service duration plus all selected add-on durations. Max: 21 (3 add-on groups × 7 add-ons per group). - name: resourceTypes | type: array | description: Resource types to filter time slots. Only returns time slots that have these specific resource types available. This filters the time slots themselves, unlike `includeResourceTypeIds` which only controls response details. - name: resourceTypeId | type: string | description: [Resource type GUID](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resource-types-v2/introduction.md). - name: resourceIds | type: array | description: Resource GUIDs. Available only if there is at least 1 resource available for the slot. param name: timeSlotsPerDay | type: timeSlotsPerDay | description: Maximum number of slots to return for each day in the specified time range. If `bookable` filter isn't specified, bookable slots are returned first. param name: timeZone | type: timeZone | description: Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate` values. For example, `America/New_York` or `UTC`. Required unless you specify `cursorPaging.cursor`. Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties.md). param name: toLocalDate | type: toLocalDate | description: Upper boundary for `localToDate` in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601). For example, `2026-01-30T13:30:00`. Each returned time slot has a `localEndDate` between `fromLocalDate` and `toLocalDate`. Required unless you specify `cursorPaging.cursor`. Return type: ListMultiServiceAvailabilityTimeSlotsResponse - name: timeSlots | type: array | description: Retrieved time slots. Sorted by `localStartDate` in ascending order. When multiple slots have the same start time, no specific secondary sorting is guaranteed. - name: serviceId | type: string | description: [Service GUID] (https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/introduction.md). Available only for single-service bookings. For multi-service bookings, this field is empty and individual service GUIDs are provided in `nestedTimeSlots`. - name: localStartDate | type: string | description: Local start date of the time slot in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601). For example, `2026-01-30T13:30:00`. For multi-service bookings, this represents the start time of the first service in the sequence. In `ListAvailabilityTimeSlotEndOptions`, this is identical on every entry and equals the request's `localStartDate`. - name: localEndDate | type: string | description: Local end date of the time slot in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601). For example, `2026-01-30T14:00:00`. For multi-service bookings, this represents the end time of the last service in the sequence. - name: bookable | type: boolean | description: Whether customers can book the slot according to the service's [booking policies](https://dev.wix.com/docs/api-reference/business-solutions/bookings/policies/booking-policies/introduction.md). For multi-service bookings, this is `true` only when all services in the sequence comply with their respective booking policies. - name: location | type: Location | description: Information about where the business provides the service to the customer. In `ListAvailabilityTimeSlotEndOptions`, this is the requested location, identical on every entry. - name: id | type: string | description: [Location GUID](https://dev.wix.com/docs/api-reference/business-management/locations/introduction.md). Available only for business locations. - name: name | type: string | description: Location name. - name: formattedAddress | type: string | description: Formatted location address. - name: locationType | type: LocationType | description: Location type. - enum: - BUSINESS: A business location, either the default business address, or locations defined for the business by the Business Info. - CUSTOM: The location is unique to this service and isn't defined as 1 of the business locations. - CUSTOMER: The location can be determined by the customer and isn't set up beforehand. - name: eventInfo | type: EventInfo | description: Information about the [event](https://dev.wix.com/docs/api-reference/business-management/calendar/events-v3/introduction.md) related to the slot. Available only for classes. Not available for appointment-based services and courses. - name: eventId | type: string | description: Event GUID. - name: waitingList | type: WaitingList | description: Information about the event's waitlist. Available only if the service has a waitlist. - name: totalCapacity | type: integer | description: Total number of spots in the waitlist. - name: remainingCapacity | type: integer | description: Number of remaining spots in the waitlist. For example, an event with a waitlist for 10 people and 3 registrants, results in a remaining capacity of `7`. - name: eventTitle | type: string | description: Event title. - name: totalCapacity | type: integer | description: Total number of spots for the slot. For multi-service bookings, this is always `1` because customers book the entire service sequence as a single unit. In `ListAvailabilityTimeSlotEndOptions`, capacity reflects whether at least one resource can cover `[localStartDate, localEndDate]`; the specific resource is selected later via `GetAvailabilityTimeSlot`. - name: remainingCapacity | type: integer | description: Remaining number of spots for the slot. - For appointment bookings: Either `1` (available) or `0` (unavailable). - For classes: Total capacity minus booked spots. Doesn't account for waitlist reservations. For classes with waitlists, use `bookableCapacity` to get the actual number of spots customers can book. - For courses: Total capacity minus booked spots. Courses don't currently support waitlists. In `ListAvailabilityTimeSlotEndOptions`, capacity reflects whether at least one resource can cover `[localStartDate, localEndDate]`; the specific resource is selected later via `GetAvailabilityTimeSlot`. - name: bookableCapacity | type: integer | description: Number of spots that customers can book for the slot. Calculated as the remaining capacity minus the spots reserved for the waitlist. If the service has no waitlist, identical to `remainingCapacity`. For multi-service bookings, this is either `1` (sequence can be booked) or `0` (sequence can't be booked). In `ListAvailabilityTimeSlotEndOptions`, capacity reflects whether at least one resource can cover `[localStartDate, localEndDate]`; the specific resource is selected later via `GetAvailabilityTimeSlot`. - name: bookingPolicyViolations | type: BookingPolicyViolations | description: Information about booking policy violations for the slot. For multi-service bookings, this aggregates violations from all services in the sequence. - name: tooEarlyToBook | type: boolean | description: Whether it's too early for customers to book the slot. By default, all slots are returned. Specifying `{"tooEarlyToBook": false}` returns only those that customers can already book, while specifying `{"tooEarlyToBook": true}` returns only those that can't be booked yet. - name: earliestBookingDate | type: string | description: Earliest time for booking the slot in `YYYY-MM-DDThh:mm:ss.sssZ` format. *In responses**: Contains a value when `tooEarlyToBook` is `true`, indicating the earliest time customers can book the slot. *In requests**: Don't specify a value for this field. Use `tooEarlyToBook` to filter slots that can't be booked yet due to minimum advance booking time restrictions. - name: tooLateToBook | type: boolean | description: Whether it's too late for customers to book the slot. By default, all slots are returned. Specifying `{"tooLateToBook": false}` returns only those that customers can still book, while specifying `{"tooLateToBook": true}` returns only those that can no longer be booked. - name: bookOnlineDisabled | type: boolean | description: Whether customers can book the service online. By default, both services with online booking enabled and disabled are returned. Providing the boolean set to `true` or `false` returns only matching slots. - name: availableResources | type: array | description: List of [resources](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resources-v2/introduction.md) available during the time slot. Available only for single-service bookings. For multi-service bookings, resource information is provided in `nestedTimeSlots`. __Note__: Behavior varies by method: - For [List Availability Time Slots](https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/list-availability-time-slots.md), this list is empty by default. To include resource details, specify `includeResourceTypeIds` or `resourceIds` in the request. - For [Get Availability Time Slot](https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/get-availability-time-slot.md), all resources are returned by default. - **End options** (`ListAvailabilityTimeSlotEndOptions`): Always empty. The response does not surface resource lists for end options. If the customer hasn't already picked a resource earlier in the flow, call `GetAvailabilityTimeSlot` with the picked `localEndDate` to retrieve candidate resources before booking; if a resource is already chosen, pass it through to booking directly. - name: resourceTypeId | type: string | description: [Resource type GUID](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resource-types-v2/introduction.md). - name: resources | type: array | description: Details about resources available during the time slot. Behavior varies by method: List methods (List Availability Time Slots and List Multi Service Availability Time Slots): - Empty by default. - Up to 10 resources when specifying `includeResourceTypeIds` or `resourceIds` in the request. Get methods (Get Availability Time Slots and Get Multi Service Availability Time Slots): - All resources by default. - Filtered resources when specifying `includeResourceTypeIds` or `resourceIds` in the request. - name: id | type: string | description: Resource GUID. - name: name | type: string | description: Resource name. - name: hasMoreAvailableResources | type: boolean | description: Whether there are more available resources for the slot than those listed in `resources`. - name: nestedTimeSlots | type: array | description: Nested time slots for multi-service bookings. Each nested slot represents 1 service in the sequence, ordered according to the service sequence specified in the request. Available only for multi-service bookings. Empty for single-service bookings. - name: serviceId | type: string | description: Service GUID of the nested time slot. - name: localStartDate | type: string | description: Local start date of the nested time slot in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601). For example, `2026-01-30T13:30:00`. - name: localEndDate | type: string | description: Local end date of the nested time slot in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601). For example, `2026-01-30T13:30:00`. - name: availableResources | type: array | description: List of [resources](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resources-v2/introduction.md) available during the nested time slot. - name: scheduleId | type: string | description: The schedule GUID associated with this nested time slot. Same as the service's schedule GUID. - name: nonBookableReasons | type: NonBookableReasons | description: Information about why customers can't book the time slot. - name: noRemainingCapacity | type: boolean | description: Whether the slot is fully booked with no remaining capacity. - name: violatesBookingPolicy | type: boolean | description: Whether booking the slot violates any of the service's booking policies. - name: reservedForWaitingList | type: boolean | description: Whether the slot is reserved for the waitlist. A new customer can't book the reserved slot. - name: eventCancelled | type: boolean | description: Whether the related event is cancelled. - name: scheduleId | type: string | description: Schedule GUID associated with this time slot. Same as the service's schedule GUID. - name: allDay | type: boolean | description: Whether this time slot spans one or more full days. Populated only for class- and course-based services. Not populated for appointment-based services. When `true`, `localStartDate` is `00:00:00` of the first day and `localEndDate` is `00:00:00` of the day after the last day (exclusive). Midnight boundaries are interpreted in the event's `timeZone`. The time component should be ignored for display purposes. Default: `false` - name: timeZone | type: string | description: Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate`. For example, `America/New_York` or `UTC`. Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties.md). - name: cursorPagingMetadata | type: CursorPagingMetadata | description: Paging metadata for the next page of results. Contains a cursor if there are more than 1000 results. - name: cursors | type: Cursors | description: Offset that was requested. - name: next | type: string | description: Cursor pointing to next page in the list of results. - name: prev | type: string | description: Cursor pointing to previous page in the list of results. - name: hasNext | type: boolean | description: Indicates if there are more results after the current page. If `true`, another page of results can be retrieved. If `false`, this is the last page. Possible Errors: HTTP Code: 400 | Status Code: INVALID_ARGUMENT | Application Code: INVALID_SERVICES_SIZE | Description: The number of services is invalid. Provide between 2 and 8 services. HTTP Code: 400 | Status Code: INVALID_ARGUMENT | Application Code: MISSING_ARGUMENTS | Description: Required request parameters are missing. Verify all required fields are provided. HTTP Code: 403 | Status Code: PERMISSION_DENIED | Application Code: UNAUTHORIZED_OPERATION | Description: The [identity](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities.md) used to call the method doesn't have the required permissions. HTTP Code: 404 | Status Code: NOT_FOUND | Application Code: MULTIPLE_IMPLEMENTERS_FOUND | Description: Multiple availability providers are installed. Only 1 provider can be active at a time. HTTP Code: 404 | Status Code: NOT_FOUND | Application Code: NO_IMPLEMENTERS_FOUND | Description: No availability provider is installed or configured for this operation. ``` ### Examples ### Paginate multi-service availability results (spa package - next page) Retrieves the next page of results when listing multi-service availability using cursor pagination from a previous query. ```curl curl -X POST 'https://www.wixapis.com/_api/service-availability/v2/multi-service-time-slots' \ -H 'Authorization: ' \ -d '{ "cursorPaging": { "cursor": "JWE.eyJhbGciOiJBMTI4S1ciLCJlbmMiOiJBMTI4Q0JDLUhTMjU2Iiwia2lkIjoiSGp3NWZDbWcifQ.WjIC6Jq1obLASY3YUD4E81rAEG0dC2iuLgAZ_R_IIe3yODIVXWMLfg.0DYReO5DgulBSDi1s-mnZw.kH5h9VeGE2fFMlVLUmi7sBjG1E9G64Bx8QuF4EtDvtQoXnbyJkke_TnYQ6XRv6vEj3D7UHruu6ZY_IRA4OMVkW58DVN418R4J2KfsLWFtKujmtTEeR5RP0zBQWF-tawHtt2bp_xbVxPRkJxdHEfiAXnhMS80wTm3rUb1gYMFvpPLBNAxeqxaVkiS-9jB4USa-gQExRt11R96TJbWquaNDOukkF456IEtxv9WpBQgQd41P58qZaXJAl40IrHJIqLDJMz7XGRRDcK0gNcrO0h1ep2Mmjc8TP9FeqL7TDGUvy4FqkDvqRSqkpnQbLTLjkh6HwQWfbfCJGVw0lKzab9HtrFwifLxpgCb8XrYISCjmYqEcB-YnwJ0CSrxFUVhNQx5Ld6pc0BRWG_p57YM8vOWJNfh8BRG3x3aiG4KfeaO8t0rD_lJTJxHqYqMaW2YR5rzHZ6gveq6R1v946j-Xd35Z8cEitjzqQTZLi04uiM6jVLk4CfSFo4eQDqKotR3mPnU1ySBo-PBYWL7WHrv-n61thGWJir2RQ8mzdPP8XS9mwn3nunq6UjJVytB3CpKkMsooUIzUwkDq0aotXQcIk56xHdEsUkr_CPe_gZyCD5cfmnkNsNYax5p5q5eVxcJUwqDD7qBLYm6N9N69gpQqW0ioy-TsG488oDYMvw7-Pb9R2_Jm47FRln2scofOnimbcu6wmBwfUa650M4MnWEa5gekpW3tkSYKU_FnjQYL_jtQT2hmLcTR62FdkuqMhonG5h7H7lJbgktx7PmspGLOX9MT4HiHdDPL9O4JdhR2nuq6Qxwp_yetryZ-Cw3_k1yC8VBr91muWTYkxBSgbKTXI_o1PTn0AyBe8A4uydmOy5rGDkjqRkn93KivU2bsE3jKDQOB_SebLwSMQHCdDOq8ngOX9s4lfiVuCPix-4367JbBOnAucspLcLZIPO-qVv_Vxuj._BtL_oMfO9HhTq2ahUAjfA", "limit": 5 } }' ``` ### Available days for multi-service booking (spa package) Retrieves available days for booking a spa package consisting of a massage followed by a facial treatment, limiting to one slot per day. ```curl curl -X POST 'https://www.wixapis.com/_api/service-availability/v2/multi-service-time-slots' \ -H 'Authorization: ' \ -d '{ "services": [ { "includeResourceTypeIds": [ "1cd44cf8-756f-41c3-bd90-3e2ffcaf1155" ], "serviceId": "27f2fb02-8925-4ede-be26-991411d6c905" }, { "resourceTypes": [ { "resourceTypeId": "1cd44cf8-756f-41c3-bd90-3e2ffcaf1155", "resourceIds": [ "2dc664dd-e897-4c37-b389-571145432a4d", "409760c8-aaac-4a6f-aa60-c9d94f57d2a4", "acb5a567-6a52-41d0-94df-ca56bd4eb2fb", "3f1f9e43-5bab-4a99-b4c9-5a6219e51d18", "2ef6ba0d-6270-4a9f-aab3-7dfd70f0887a" ] } ], "serviceId": "79301196-ae46-4f47-b5cd-62c5d3cfa48f" } ], "fromLocalDate": "2025-09-15T00:00:00", "toLocalDate": "2025-09-30T23:59:59", "timeZone": "America/New_York", "location": { "id": "b4698671-3412-49b5-bff1-f50d4d0fe3b3", "locationType": "BUSINESS" }, "timeSlotsPerDay": 1, "cursorPaging": { "limit": 5 } }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.timeSlots.MultiServiceAvailabilityTimeSlots.listMultiServiceAvailabilityTimeSlots(options) Description: Retrieves a list of multi-service time slots that match the provided filters. ### Required filters You must specify one of: - `services.serviceId`, `fromLocalDate`, `toLocalDate`, `location`, and `timeZone` (additional filters are optional). - `cursorPaging.cursor` returned from a previous response. Each returned `timeSlot` acts as a container spanning the entire service sequence, with nested time slots providing individual service details. ### Defaults - Results are sorted by `localStartDate` in ascending order. - `cursorPaging.limit` is `1000`. - The response contains both bookable and non-bookable slots. ### Service type limitations Only appointment-type services are supported. To retrieve appointment availability for a single service, call [List Availability Time Slots](https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/list-availability-time-slots.md). ### Booking policy filtering Use `bookingPolicyViolations` to filter slots based on booking restrictions defined in your [booking policies](https://dev.wix.com/docs/api-reference/business-solutions/bookings/policies/booking-policies/introduction.md). *Default behavior**: When you don't specify any `bookingPolicyViolations` filters, all slots are returned regardless of their booking policy status. - Set `tooEarlyToBook` to `true` and optionally specify `earliestBookingDate` to retrieve slots that can't be booked yet due to minimum advance booking time restrictions. Use `earliestBookingDate` to further filter by when the slot becomes bookable. - Set `tooLateToBook` to `true` to retrieve slots that can no longer be booked due to maximum advance booking time restrictions. - Set `bookOnlineDisabled` to `true` or `false` to filter by online booking availability settings. ### Customer choices Use `services.customerChoices` to calculate availability based on the customer's selected service duration or add-ons for each service. When using [add-ons](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/add-ons/introduction.md), we recommend passing only `addOnIds` in `customerChoices` and omitting `durationInMinutes`. Wix Bookings then calculates the total duration automatically. If you specify both `addOnIds` and `durationInMinutes`, `durationInMinutes` must equal the service duration plus all selected add-on durations. Method parameters: param name: options | type: ListMultiServiceAvailabilityTimeSlotsOptions none - name: services | type: array | description: Services for which the multi-service time slots are returned. Each service can include its own resource filters. Required unless you specify `cursorPaging.cursor`. Min: 2 services Max: 8 services - name: serviceId | type: string | description: Service GUID. - name: includeResourceTypeIds | type: array | description: Resource [type GUIDs](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resource-types-v2/introduction.md) to include in returned time slots. This is in addition to the specifically requested resources.
Currently supported only for Staff Member resource type. Staff members belong to resource type GUID `1cd44cf8-756f-41c3-bd90-3e2ffcaf1155`.
- name: customerChoices | type: CustomerChoices | description: Selected customer choices. If specified, the selected choices are used to calculate service configuration. If not specified, the service default configuration is used. Enforcing this field is the responsibility of the service plugin implementer, and not the Time Slots V2 API. When using [add-ons](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/add-ons/introduction.md), we recommend passing only `addOnIds` and omitting `durationInMinutes`. Wix Bookings then calculates the total duration automatically. If you specify both `addOnIds` and `durationInMinutes`, `durationInMinutes` must equal the service duration plus all selected add-on durations. - name: durationInMinutes | type: integer | description: Selected duration in minutes, based on a [service variant](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/service-options-and-variants/introduction.md) the customer chose. When using [add-ons](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/add-ons/introduction.md), we recommend passing only `addOnIds` instead of `durationInMinutes`. Wix Bookings then calculates the total duration automatically. If you specify both `addOnIds` and `durationInMinutes`, `durationInMinutes` must equal the service duration plus all selected add-on durations. Min: `1` minute Max: `44639` minutes (30 days, 23 hours, and 59 minutes) Default: `15` minutes - name: addOnIds | type: array | description: Selected [add-on](https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/add-ons/introduction.md) GUIDs. When specifying this field, we recommend omitting `durationInMinutes`. Wix Bookings then calculates the total duration based on the service duration plus all selected add-on durations. Max: 21 (3 add-on groups × 7 add-ons per group). - name: resourceTypes | type: array | description: Resource types to filter time slots. Only returns time slots that have these specific resource types available. This filters the time slots themselves, unlike `includeResourceTypeIds` which only controls response details. - name: resourceTypeId | type: string | description: [Resource type GUID](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resource-types-v2/introduction.md). - name: resourceIds | type: array | description: Resource GUIDs. Available only if there is at least 1 resource available for the slot. - name: fromLocalDate | type: string | description: Lower boundary for `localStartDate` in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601). For example, `2026-01-30T13:30:00`. Each returned time slot has a `localStartDate` between `fromLocalDate` and `toLocalDate`. Required unless you specify `cursorPaging.cursor`. - name: toLocalDate | type: string | description: Upper boundary for `localToDate` in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601). For example, `2026-01-30T13:30:00`. Each returned time slot has a `localEndDate` between `fromLocalDate` and `toLocalDate`. Required unless you specify `cursorPaging.cursor`. - name: timeZone | type: string | description: Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate` values. For example, `America/New_York` or `UTC`. Required unless you specify `cursorPaging.cursor`. Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties.md). - name: location | type: Location | description: Location for which the multi-service time slots are returned. If you filter by `{"type": "BUSINESS"}`, you must also specify a location GUID. Filters for `location.name` and `location.formattedAddress` are ignored. Required unless you specify `cursorPaging.cursor`. - name: _id | type: string | description: [Location GUID](https://dev.wix.com/docs/api-reference/business-management/locations/introduction.md). Available only for business locations. - name: name | type: string | description: Location name. - name: formattedAddress | type: string | description: Formatted location address. - name: locationType | type: LocationType | description: Location type. - enum: - BUSINESS: A business location, either the default business address, or locations defined for the business by the Business Info. - CUSTOM: The location is unique to this service and isn't defined as 1 of the business locations. - CUSTOMER: The location can be determined by the customer and isn't set up beforehand. - name: bookable | type: boolean | description: Whether the time slot is bookable according to all services' booking policies. If not specified, returns both bookable and non-bookable time slots. - name: bookingPolicyViolations | type: BookingPolicyViolations | description: Indicators for service's booking policy violations. Allows filtering for time slots with specific violation types based on [booking policies](https://dev.wix.com/docs/api-reference/business-solutions/bookings/policies/booking-policies/introduction.md). When you don't specify `bookingPolicyViolations` filters, all slots are returned regardless of their booking policy status. - name: tooEarlyToBook | type: boolean | description: Whether it's too early for customers to book the slot. By default, all slots are returned. Specifying `{"tooEarlyToBook": false}` returns only those that customers can already book, while specifying `{"tooEarlyToBook": true}` returns only those that can't be booked yet. - name: earliestBookingDate | type: Date | description: Earliest time for booking the slot in `YYYY-MM-DDThh:mm:ss.sssZ` format. *In responses**: Contains a value when `tooEarlyToBook` is `true`, indicating the earliest time customers can book the slot. *In requests**: Don't specify a value for this field. Use `tooEarlyToBook` to filter slots that can't be booked yet due to minimum advance booking time restrictions. - name: tooLateToBook | type: boolean | description: Whether it's too late for customers to book the slot. By default, all slots are returned. Specifying `{"tooLateToBook": false}` returns only those that customers can still book, while specifying `{"tooLateToBook": true}` returns only those that can no longer be booked. - name: bookOnlineDisabled | type: boolean | description: Whether customers can book the service online. By default, both services with online booking enabled and disabled are returned. Providing the boolean set to `true` or `false` returns only matching slots. - name: timeSlotsPerDay | type: integer | description: Maximum number of slots to return for each day in the specified time range. If `bookable` filter isn't specified, bookable slots are returned first. - name: cursorPaging | type: CursorPaging | description: Cursor-based paging configuration. Enables fetching results in smaller chunks by setting a limit on the number of results. For consistent pagination behavior, use the same `limit` value throughout a pagination sequence. When specifying a new `limit` in follow-up requests, the API respects the new value. - name: limit | type: integer | description: Number of results to load. Default: `1000`. Max: `1000`. - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. You can get the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. Return type: PROMISE - name: timeSlots | type: array | description: Retrieved time slots. Sorted by `localStartDate` in ascending order. When multiple slots have the same start time, no specific secondary sorting is guaranteed. - name: serviceId | type: string | description: [Service GUID] (https://dev.wix.com/docs/api-reference/business-solutions/bookings/services/services-v2/introduction.md). Available only for single-service bookings. For multi-service bookings, this field is empty and individual service GUIDs are provided in `nestedTimeSlots`. - name: localStartDate | type: string | description: Local start date of the time slot in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601). For example, `2026-01-30T13:30:00`. For multi-service bookings, this represents the start time of the first service in the sequence. In `ListAvailabilityTimeSlotEndOptions`, this is identical on every entry and equals the request's `localStartDate`. - name: localEndDate | type: string | description: Local end date of the time slot in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601). For example, `2026-01-30T14:00:00`. For multi-service bookings, this represents the end time of the last service in the sequence. - name: bookable | type: boolean | description: Whether customers can book the slot according to the service's [booking policies](https://dev.wix.com/docs/api-reference/business-solutions/bookings/policies/booking-policies/introduction.md). For multi-service bookings, this is `true` only when all services in the sequence comply with their respective booking policies. - name: location | type: Location | description: Information about where the business provides the service to the customer. In `ListAvailabilityTimeSlotEndOptions`, this is the requested location, identical on every entry. - name: _id | type: string | description: [Location GUID](https://dev.wix.com/docs/api-reference/business-management/locations/introduction.md). Available only for business locations. - name: name | type: string | description: Location name. - name: formattedAddress | type: string | description: Formatted location address. - name: locationType | type: LocationType | description: Location type. - enum: - BUSINESS: A business location, either the default business address, or locations defined for the business by the Business Info. - CUSTOM: The location is unique to this service and isn't defined as 1 of the business locations. - CUSTOMER: The location can be determined by the customer and isn't set up beforehand. - name: eventInfo | type: EventInfo | description: Information about the [event](https://dev.wix.com/docs/api-reference/business-management/calendar/events-v3/introduction.md) related to the slot. Available only for classes. Not available for appointment-based services and courses. - name: eventId | type: string | description: Event GUID. - name: waitingList | type: WaitingList | description: Information about the event's waitlist. Available only if the service has a waitlist. - name: totalCapacity | type: integer | description: Total number of spots in the waitlist. - name: remainingCapacity | type: integer | description: Number of remaining spots in the waitlist. For example, an event with a waitlist for 10 people and 3 registrants, results in a remaining capacity of `7`. - name: eventTitle | type: string | description: Event title. - name: totalCapacity | type: integer | description: Total number of spots for the slot. For multi-service bookings, this is always `1` because customers book the entire service sequence as a single unit. In `ListAvailabilityTimeSlotEndOptions`, capacity reflects whether at least one resource can cover `[localStartDate, localEndDate]`; the specific resource is selected later via `GetAvailabilityTimeSlot`. - name: remainingCapacity | type: integer | description: Remaining number of spots for the slot. - For appointment bookings: Either `1` (available) or `0` (unavailable). - For classes: Total capacity minus booked spots. Doesn't account for waitlist reservations. For classes with waitlists, use `bookableCapacity` to get the actual number of spots customers can book. - For courses: Total capacity minus booked spots. Courses don't currently support waitlists. In `ListAvailabilityTimeSlotEndOptions`, capacity reflects whether at least one resource can cover `[localStartDate, localEndDate]`; the specific resource is selected later via `GetAvailabilityTimeSlot`. - name: bookableCapacity | type: integer | description: Number of spots that customers can book for the slot. Calculated as the remaining capacity minus the spots reserved for the waitlist. If the service has no waitlist, identical to `remainingCapacity`. For multi-service bookings, this is either `1` (sequence can be booked) or `0` (sequence can't be booked). In `ListAvailabilityTimeSlotEndOptions`, capacity reflects whether at least one resource can cover `[localStartDate, localEndDate]`; the specific resource is selected later via `GetAvailabilityTimeSlot`. - name: bookingPolicyViolations | type: BookingPolicyViolations | description: Information about booking policy violations for the slot. For multi-service bookings, this aggregates violations from all services in the sequence. - name: tooEarlyToBook | type: boolean | description: Whether it's too early for customers to book the slot. By default, all slots are returned. Specifying `{"tooEarlyToBook": false}` returns only those that customers can already book, while specifying `{"tooEarlyToBook": true}` returns only those that can't be booked yet. - name: earliestBookingDate | type: Date | description: Earliest time for booking the slot in `YYYY-MM-DDThh:mm:ss.sssZ` format. *In responses**: Contains a value when `tooEarlyToBook` is `true`, indicating the earliest time customers can book the slot. *In requests**: Don't specify a value for this field. Use `tooEarlyToBook` to filter slots that can't be booked yet due to minimum advance booking time restrictions. - name: tooLateToBook | type: boolean | description: Whether it's too late for customers to book the slot. By default, all slots are returned. Specifying `{"tooLateToBook": false}` returns only those that customers can still book, while specifying `{"tooLateToBook": true}` returns only those that can no longer be booked. - name: bookOnlineDisabled | type: boolean | description: Whether customers can book the service online. By default, both services with online booking enabled and disabled are returned. Providing the boolean set to `true` or `false` returns only matching slots. - name: availableResources | type: array | description: List of [resources](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resources-v2/introduction.md) available during the time slot. Available only for single-service bookings. For multi-service bookings, resource information is provided in `nestedTimeSlots`. __Note__: Behavior varies by method: - For [List Availability Time Slots](https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/list-availability-time-slots.md), this list is empty by default. To include resource details, specify `includeResourceTypeIds` or `resourceIds` in the request. - For [Get Availability Time Slot](https://dev.wix.com/docs/api-reference/business-solutions/bookings/time-slots/time-slots-v2/get-availability-time-slot.md), all resources are returned by default. - **End options** (`ListAvailabilityTimeSlotEndOptions`): Always empty. The response does not surface resource lists for end options. If the customer hasn't already picked a resource earlier in the flow, call `GetAvailabilityTimeSlot` with the picked `localEndDate` to retrieve candidate resources before booking; if a resource is already chosen, pass it through to booking directly. - name: resourceTypeId | type: string | description: [Resource type GUID](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resource-types-v2/introduction.md). - name: resources | type: array | description: Details about resources available during the time slot. Behavior varies by method: List methods (List Availability Time Slots and List Multi Service Availability Time Slots): - Empty by default. - Up to 10 resources when specifying `includeResourceTypeIds` or `resourceIds` in the request. Get methods (Get Availability Time Slots and Get Multi Service Availability Time Slots): - All resources by default. - Filtered resources when specifying `includeResourceTypeIds` or `resourceIds` in the request. - name: _id | type: string | description: Resource GUID. - name: name | type: string | description: Resource name. - name: hasMoreAvailableResources | type: boolean | description: Whether there are more available resources for the slot than those listed in `resources`. - name: nestedTimeSlots | type: array | description: Nested time slots for multi-service bookings. Each nested slot represents 1 service in the sequence, ordered according to the service sequence specified in the request. Available only for multi-service bookings. Empty for single-service bookings. - name: serviceId | type: string | description: Service GUID of the nested time slot. - name: localStartDate | type: string | description: Local start date of the nested time slot in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601). For example, `2026-01-30T13:30:00`. - name: localEndDate | type: string | description: Local end date of the nested time slot in `YYYY-MM-DDThh:mm:ss` [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601). For example, `2026-01-30T13:30:00`. - name: availableResources | type: array | description: List of [resources](https://dev.wix.com/docs/api-reference/business-solutions/bookings/resources/resources-v2/introduction.md) available during the nested time slot. - name: scheduleId | type: string | description: The schedule GUID associated with this nested time slot. Same as the service's schedule GUID. - name: nonBookableReasons | type: NonBookableReasons | description: Information about why customers can't book the time slot. - name: noRemainingCapacity | type: boolean | description: Whether the slot is fully booked with no remaining capacity. - name: violatesBookingPolicy | type: boolean | description: Whether booking the slot violates any of the service's booking policies. - name: reservedForWaitingList | type: boolean | description: Whether the slot is reserved for the waitlist. A new customer can't book the reserved slot. - name: eventCancelled | type: boolean | description: Whether the related event is cancelled. - name: scheduleId | type: string | description: Schedule GUID associated with this time slot. Same as the service's schedule GUID. - name: allDay | type: boolean | description: Whether this time slot spans one or more full days. Populated only for class- and course-based services. Not populated for appointment-based services. When `true`, `localStartDate` is `00:00:00` of the first day and `localEndDate` is `00:00:00` of the day after the last day (exclusive). Midnight boundaries are interpreted in the event's `timeZone`. The time component should be ignored for display purposes. Default: `false` - name: timeZone | type: string | description: Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting `fromLocalDate` and `toLocalDate`. For example, `America/New_York` or `UTC`. Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/api-reference/business-management/site-properties/properties/get-site-properties.md). - name: cursorPagingMetadata | type: CursorPagingMetadata | description: Paging metadata for the next page of results. Contains a cursor if there are more than 1000 results. - name: cursors | type: Cursors | description: Offset that was requested. - name: next | type: string | description: Cursor pointing to next page in the list of results. - name: prev | type: string | description: Cursor pointing to previous page in the list of results. - name: hasNext | type: boolean | description: Indicates if there are more results after the current page. If `true`, another page of results can be retrieved. If `false`, this is the last page. Possible Errors: HTTP Code: 400 | Status Code: INVALID_ARGUMENT | Application Code: INVALID_SERVICES_SIZE | Description: The number of services is invalid. Provide between 2 and 8 services. HTTP Code: 400 | Status Code: INVALID_ARGUMENT | Application Code: MISSING_ARGUMENTS | Description: Required request parameters are missing. Verify all required fields are provided. HTTP Code: 403 | Status Code: PERMISSION_DENIED | Application Code: UNAUTHORIZED_OPERATION | Description: The [identity](https://dev.wix.com/docs/api-reference/articles/authentication/about-identities.md) used to call the method doesn't have the required permissions. HTTP Code: 404 | Status Code: NOT_FOUND | Application Code: MULTIPLE_IMPLEMENTERS_FOUND | Description: Multiple availability providers are installed. Only 1 provider can be active at a time. HTTP Code: 404 | Status Code: NOT_FOUND | Application Code: NO_IMPLEMENTERS_FOUND | Description: No availability provider is installed or configured for this operation. ``` ### Examples ### listMultiServiceAvailabilityTimeSlots ```javascript import { multiServiceAvailabilityTimeSlots } from '@wix/bookings'; async function listMultiServiceAvailabilityTimeSlots(options) { const response = await multiServiceAvailabilityTimeSlots.listMultiServiceAvailabilityTimeSlots(options); }; ``` ### listMultiServiceAvailabilityTimeSlots (with elevated permissions) ```javascript import { multiServiceAvailabilityTimeSlots } from '@wix/bookings'; import { auth } from '@wix/essentials'; async function myListMultiServiceAvailabilityTimeSlotsMethod(options) { const elevatedListMultiServiceAvailabilityTimeSlots = auth.elevate(multiServiceAvailabilityTimeSlots.listMultiServiceAvailabilityTimeSlots); const response = await elevatedListMultiServiceAvailabilityTimeSlots(options); } ``` ### listMultiServiceAvailabilityTimeSlots (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { multiServiceAvailabilityTimeSlots } from '@wix/bookings'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { multiServiceAvailabilityTimeSlots }, // Include the auth strategy and host as relevant }); async function listMultiServiceAvailabilityTimeSlots(options) { const response = await myWixClient.multiServiceAvailabilityTimeSlots.listMultiServiceAvailabilityTimeSlots(options); }; ``` ---