About the Wix Bookings Reader V2 API
With the Wix Bookings Reader V2 API you can retrieve bookings for a site's
services.
The booking object holds information about the customer and the session or schedule they have booked.
For more information about the terminology, use cases and related APIs read introduction to the Wix Bookings V2 API.
You can then use the Wix Bookings V2 APIs to manage the booking life cycle and the Ecommerce APIs (coming soon) to handle the checkout and payment flow.
Before you begin
fields
andfieldsets
aren't supported in thequery
object.- Bookings for courses don't include a
sessionId
. To filter these bookings by session ID, you must passsessionId
on the root level of the request body, and can't use the filter that's part of thequery
object. - The
participantNotification
field holds only information about the last message sent to the customer. It also doesn't include details which type of message has been sent.
Supported Filters
Query Extended Bookings runs with these defaults:
- sorted by
id
inASC
order - cursorPaging.limit is
50
query.fields
and query.fieldsets
aren't supported for this endpoint.
The following table shows field support for filters for the booking object:
Field | Supported Filters |
---|---|
id | eq , ne , in |
bookedEntity.item.slot.sessionId | eq , ne , in |
bookedEntity.item.slot.serviceId | eq , ne , in |
bookedEntity.item.slot.scheduleId | eq , ne , in |
bookedEntity.item.slot.resource.id | eq , ne , in |
bookedEntity.item.slot.location.id | eq , ne , in |
bookedEntity.item.slot.location.locationType | eq , ne , in |
bookedEntity.item.schedule.scheduleId | eq , ne , in |
bookedEntity.item.schedule.serviceId | eq , ne , in |
bookedEntity.item.schedule.location.id | eq , ne , in |
bookedEntity.item.schedule.location.locationType | eq , ne , in |
bookedEntity.tags | hasSome , hasAll |
contactDetails.contactId | eq , ne , in |
status | eq , ne , in |
paymentStatus | eq , ne , in |
selectedPaymentOption | eq , ne , in |
createdDate | eq , ne , gt , gte , lt , lte , in , nin |
externalUserId | eq , ne , in |
createdBy.contactId | eq , ne , in |
createdBy.id.appId | eq , ne , in |
createdBy.id.wixUserId | eq , ne , in |
createdBy.id.memberId | eq , ne , in |
createdBy.id.anonymousVisitorId | eq , ne , in |
startDate | eq , ne , gt , gte , lt , lte , in , nin |
endDate | eq , ne , gt , gte , lt , lte , in , nin |
updatedDate | eq , ne , gt , gte , lt , lte , in , nin |
doubleBooked | eq , ne |
participantsInfo.type.totalParticipants.value | eq , ne , gt , gte , lt , lte , in , nin |
participantsInfo.type.participantsChoices.serviceChoices.choices.optionId | hasSome , hasAll |
participantsInfo.type.participantsChoices.serviceChoices.choices.choice.custom.value | hasSome , hasAll |
You can only specify a filter only once per query. If a filter is provided more than once, only the first occurrence affects the returned bookings.
When using filters for dates, you must use UTC time.
Bookings belonging to a schedule don't have a sessionId
. Therefore you
must use the sessionId
filter that isn't part of the query
object to
filter bookings for courses.
To learn about working with Query endpoints, see API Query Language, Sorting and Paging, and Field Projection.
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 bookings, given the provided paging, filtering, and sorting.
Up to 100 bookings can be returned per request.
Query Extended Bookings runs with these defaults, which you can override:
createdDate
sorted inDESC
ordercursorPaging.limit
is50
You can retrieve information about which actions the customer can perform
for the bookings. To do so, pass withBookingAllowedActions
as true
.
For field support see supported filters for more information.
You can only specify a filter only once per query. If a filter is provided more than once, only the first occurrence affects the returned bookings.
When using filters for dates, you must use UTC time.
To learn about working with Query endpoints, see API Query Language, Sorting and Paging, and Field Projection.