Reservations: Supported Sorting, Filtering, and Searching

This article covers field support for filtering, sorting, and searching for searchReservations() in the Reservations API.

Search Reservations

The following table shows field support for filters and sorting for the reservation object when using searchReservations():

FieldSupported FiltersSortable
source$eq, $ne, $in
status$eq, $ne, $in
details.reservationLocationId$eq, $ne, $in
reservee.contactId$eq, $ne, $in
details.tableIds$eq, $has_all, $has_some, $empty
details.startDate$eq, $ne, $lt, $lte, $gt, $gte, $inSortable
details.partySize$eq, $ne, $lt, $lte, $gt, $gte, $inSortable
createdDate$eq, $ne, $lt, $lte, $gt, $gte, $inSortable
updatedDate$eq, $ne, $lt, $lte, $gt, $gte, $inSortable

The following fields in the reservation object are searchable:

  • reservee.firstName
  • reservee.lastName
  • reservee.phone
  • reservee.email

Related content: searchReservations()

Was this helpful?
Yes
No