queryAvailabilityExceptions( )


Developer Preview

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

Creates a query to retrieve a list of availability exceptions.

The queryAvailabilityExceptions() function builds a query to retrieve a list of availability exceptions and returns an AvailabilityExceptionsQueryBuilder object.

The returned object contains the query definition, which is used to run the query using the find() function.

You can refine the query by chaining AvailabilityExceptionsQueryBuilder functions onto the query. AvailabilityExceptionsQueryBuilder functions enable you to filter, sort, and control the results that queryAvailabilityExceptions() returns.

queryAvailabilityExceptions() runs with the following AvailabilityExceptionsQueryBuilder defaults, which you can override:

The following AvailabilityExceptionsQueryBuilder functions are supported for queryAvailabilityExceptions(). For a full description of the availability exception object, see the object returned for the items property in AvailabilityExceptionsQueryResult.

PROPERTYSUPPORTED FILTERS & SORTING
_ideq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
_createdDateeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
_updatedDateeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
startTimeeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
endTimeeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
availableeq(),ne(),exists(),in(),hasSome(),ascending(),descending()
nameeq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
affectedFulfillmentMethods.affectedMethodseq(),ne(),exists(),in(),hasSome(),ascending(),descending()
Authentication

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
Request
This method does not take any parameters
Was this helpful?
Yes
No