POST

Query Extended Bookings

Note: This query method uses the new Wix API Query Language syntax. If you're still using the old query syntax with chained query builder methods, see Migrate from SDK Query Builders to Wix API Query Language for guidance. The old query builder methods continue to work.

Retrieves up to 100 bookings, given the specified paging, filtering, and sorting.

Query Extended Bookings runs with these defaults, which you can override:

id sorted in ASC order
cursorPaging.limit is 50

To retrieve course bookings, filter by booking.bookedEntity.schedule.scheduleId, using the course service's schedule.id, or by booking.bookedEntity.schedule.serviceId, using the course service's id. Use $in to retrieve the bookings of several courses in one call. A filter on a top-level scheduleId field fails with INVALID_FILTER, because bookings have no such field. In the response, the booking fields are nested under booking, for example extendedBookings[].booking.startDate.

You can retrieve information about which actions the customer can perform for the bookings. To do so, pass withBookingAllowedActions as true.

When using filters for dates, you must use UTC time.

See Supported Filters for a list of supported filters and sorting options.

To learn about working with Query endpoints, see API Query Language, Sorting and Paging, and Field Projection.

Property	Filters	Sort
`booking._id`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`	Sort: `ASC`, `DESC`
`booking._createdDate`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`	Sort: `ASC`, `DESC`
`booking._updatedDate`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`	Sort: `ASC`, `DESC`
`booking.startDate`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`	Sort: `ASC`, `DESC`
`booking.endDate`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`	Sort: `ASC`, `DESC`
`booking.bookedEntity.slot.sessionId`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`	None
`booking.bookedEntity.slot.eventId`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`	None
`booking.bookedEntity.slot.serviceId`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`	None
`booking.bookedEntity.slot.scheduleId`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`	None
`booking.bookedEntity.slot.resource._id`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`	None
`booking.bookedEntity.slot.location._id`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`	None
`booking.bookedEntity.slot.location.locationType`	`$eq`, `$ne`, `$in`, `$exists`	None
`booking.bookedEntity.schedule.scheduleId`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`	None
`booking.bookedEntity.schedule.serviceId`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`	None
`booking.bookedEntity.schedule.location._id`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`	None
`booking.bookedEntity.schedule.location.locationType`	`$eq`, `$ne`, `$in`, `$exists`	None
`booking.bookedEntity.tags`	`$hasSome`, `$hasAll`, `$exists`, `$isEmpty`	None
`booking.contactDetails.contactId`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`	None
`booking.contactDetails.email`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`	None
`booking.status`	`$eq`, `$ne`, `$in`, `$exists`	None
`booking.paymentStatus`	`$eq`, `$ne`, `$in`, `$exists`	None
`booking.selectedPaymentOption`	`$eq`, `$ne`, `$in`, `$exists`	None
`booking.externalUserId`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`	None
`booking.createdBy.contactId`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`	None
`booking.createdBy.appId`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`	None
`booking.createdBy.wixUserId`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`	None
`booking.createdBy.memberId`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`	None
`booking.createdBy.anonymousVisitorId`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`	None
`booking.doubleBooked`	`$eq`, `$ne`, `$in`, `$exists`	None
`booking.totalParticipants`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`	None
`booking.participantsChoices.serviceChoices.choices.optionId`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`	None
`booking.participantsChoices.serviceChoices.choices.custom`	`$eq`, `$ne`, `$in`, `$exists`, `$gt`, `$gte`, `$lt`, `$lte`, `$startsWith`	None

Permission Scopes

Learn more about app permissions.

Method Declaration

Copy

Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?