listReservations( )


Developer Preview

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

Retrieves a list of up to 100 reservations.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Reservations (Full)
Manage Reservations (Medium)
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
function listReservations(
  options: ListReservationsOptions,
): Promise<ListReservationsResponse>;
Method Parameters
optionsListReservationsOptions

Options for listing the reservations.

Returns
Return Type:Promise<ListReservationsResponse>
JavaScript
import { reservations } from "@wix/table-reservations"; /* Sample options value: * { * "startDateFrom" : new Date("2024-12-04T10:30:00Z"), * "startDateTo" : new Date("2024-12-04T17:30:00Z"), * "status" : "RESERVED" * } */ export async function myListReservationsFunction(options) { try { const retrievedReservations = await reservations.listReservations(options); const createdDate = retrievedReservations.reservations[0]._createdDate; const status = retrievedReservations.reservations[0].status; return retrievedReservations; } catch (error) { console.error(error); // Handle the error } } /* Promise resolves to: * { * "reservations": [ * { * "status": "RESERVED", * "source": "ONLINE", * "details": { * "reservationLocationId": "fab8cc1f-31cf-462f-b5bb-392594624bf2", * "tableIds": [ * "1ed802ae-708f-4da6-9177-54c3df5d3dd5" * ], * "startDate": "2024-12-04T12:30:00.000Z", * "endDate": "2024-12-04T14:00:00.000Z", * "partySize": 2 * }, * "revision": "1", * "migrationNotes": [], * "tablesWithReservationConflicts": [], * "_id": "1e3db995-5614-4748-8903-cbe7c74c5753", * "_createdDate": "2024-01-22T07:25:51.008Z", * "_updatedDate": "2024-01-22T07:25:51.008Z" * }, * { * "status": "RESERVED", * "source": "ONLINE", * "details": { * "reservationLocationId": "fab8cc1f-31cf-462f-b5bb-392594624bf2", * "tableIds": [ * "1ed802ae-708f-4da6-9177-54c3df5d3dd5" * ], * "startDate": "2024-12-04T14:30:00.000Z", * "endDate": "2024-12-04T16:00:00.000Z", * "partySize": 2 * }, * "revision": "1", * "migrationNotes": [], * "tablesWithReservationConflicts": [], * "_id": "3e09e2fb-0cc8-476e-9874-f134b3add055", * "_createdDate": "2024-01-22T07:33:10.651Z", * "_updatedDate": "2024-01-22T07:33:10.651Z" * }, * { * "status": "RESERVED", * "source": "ONLINE", * "details": { * "reservationLocationId": "fab8cc1f-31cf-462f-b5bb-392594624bf2", * "tableIds": [ * "1ed802ae-708f-4da6-9177-54c3df5d3dd5" * ], * "startDate": "2024-12-04T10:30:00.000Z", * "endDate": "2024-12-04T12:00:00.000Z", * "partySize": 2 * }, * "revision": "1", * "migrationNotes": [], * "tablesWithReservationConflicts": [], * "_id": "98100e83-76cc-4791-87c6-4c6dd4fe9e22", * "_createdDate": "2024-01-22T07:32:31.548Z", * "_updatedDate": "2024-01-22T07:32:31.548Z" * } * ], * "pagingMetadata": { * "count": 3, * "cursors": {}, * "hasNext": false * } * } */
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?