listMultiServiceAvailabilityTimeSlots( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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 (SDK | REST).

Booking policy filtering

Use bookingPolicyViolations to filter slots based on booking restrictions defined in your booking policies (SDK | REST).

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.
Method Declaration
Copy
Method Parameters
optionsListMultiServiceAvailabilityTimeSlotsOptions
Returns
Return Type:Promise<ListMultiServiceAvailabilityTimeSlotsResponse>
Errors
400Invalid Argument

There are 2 errors with this status code.

403Permission Denied

There is 1 error with this status code.

404Not Found

There are 2 errors with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?