> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # Method name: listReservations(options: ListReservationsOptions) # Method package: wixTableReservationsV2 # Method menu location: wixTableReservationsV2 --> reservations --> listReservations # Method Link: https://dev.wix.com/docs/velo/apis/wix-table-reservations-v2/reservations/list-reservations.md # Method Description: Retrieves a list of up to 100 reservations. # Method Code Examples: *** Note: do not assume any prop names or enum values other than the ones in the example. ## List reservations with options (backend) ```javascript import { Permissions, webMethod } from 'wix-web-module'; import { reservations } from 'wix-table-reservations.v2'; import { elevate } from 'wix-auth'; /* Sample options value: * { * "startDateFrom" : new Date("2024-12-04T10:30:00Z"), * "startDateTo" : new Date("2024-12-04T17:30:00Z"), * "status" : "RESERVED" * } */ export const myListReservationsFunction = webMethod(Permissions.Anyone, async (options) => { const elevatedListReservations = elevate(reservations.listReservations); try { const retrievedReservations = await elevatedListReservations(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 * } * } */ ``` ## List reservations with options (dashboard page) ```javascript import { reservations } from 'wix-table-reservations.v2'; /* Sample options value: * { * "startDateFrom" : new Date("2024-12-04T10:30:00Z"), * "startDateTo" : new Date("2024-12-04T17:30:00Z"), * "status" : "RESERVED" * } */ reservations.listReservations(options) .then((retrievedReservations) => { const createdDate = retrievedReservations.reservations[0]._createdDate; const status = retrievedReservations.reservations[0].status; console.log('Success! Retrieved reservations:', retrievedReservations); 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 * } * } */ ``` ---