queryExtendedBookings( )

Developer Preview

Retrieves a list of bookings, including additional extended information, given the provided paging, filtering, and sorting.

Description

Up to 100 extended bookings can be returned per request.

queryExtendedBookings() runs with these defaults, which you can override:

createdDate sorted in DESC order
cursorPaging.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.

Note: This function is restricted and only runs if you elevate permissions using the wix-auth.elevate() function.

Syntax

function queryExtendedBookings(query: CommonQueryV2, options: QueryExtendedBookingsOptions): Promise<QueryExtendedBookingsResponse>

queryExtendedBookings Parameters

NAME

TYPE

DESCRIPTION

query

CommonQueryV2

Information about filters, paging, and sorting.

options

Optional

QueryExtendedBookingsOptions

Additional options for performing the query.

Returns

Return Type:

Promise<

QueryExtendedBookingsResponse

NAME

TYPE

DESCRIPTION

extendedBookings

Array<

ExtendedBooking

Retrieved bookings and additional information, such as information about about the attendance or actions the customer can perform.

pagingMetadata

PagingMetadataV2

Paging metadata.

Was this helpful?

queryExtendedBookings example

Copy Code

1import { extendedBookings } from 'wix-bookings.v2';
2  
3 async function queryExtendedBookings(query, options) {
4   try {
5     const result = await extendedBookings.queryExtendedBookings(query, options);
6
7     return result;
8   } catch (error) {
9     console.error(error);
10     // Handle the error
11   }
12 }
13