Retrieves a list of bookings, including additional extended information, given the provided paging, filtering, and sorting.
queryExtendedBookings()
doesn't use a query builder, instead it uses API query language.
Up to 100 extended bookings can be returned per request.
queryExtendedBookings()
runs with these defaults, which you can override:
createdDate
sorted in DESC
ordercursorPaging.limit
is 50
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 specify a filter only once per query. If you specify a filter more than once, only the first filter determines the extended bookings that are returned.
When filtering by date, you must use UTC time.
function queryExtendedBookings(
query: CommonQueryV2,
options: QueryExtendedBookingsOptions,
): Promise<QueryExtendedBookingsResponse>;
Information about filters, paging, and sorting.
Additional options for performing the query.
import { extendedBookings } from "@wix/bookings";
async function queryExtendedBookings(query, options) {
const response = await extendedBookings.queryExtendedBookings(query, options);
}
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.