This article covers field support for filtering, sorting, and searching for searchReservations()
in the Reservations API.
The following table shows field support for filters and sorting
for the reservation object when using searchReservations()
:
Field | Supported Filters | Sortable |
---|---|---|
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 , $in | Sortable |
details.partySize | $eq , $ne , $lt , $lte , $gt , $gte , $in | Sortable |
createdDate | $eq , $ne , $lt , $lte , $gt , $gte , $in | Sortable |
updatedDate | $eq , $ne , $lt , $lte , $gt , $gte , $in | Sortable |
The following fields in the reservation object are searchable:
reservee.firstName
reservee.lastName
reservee.phone
reservee.email
Related content:
searchReservations()