Guest-stays API-endpoints

Apart from the survey API-endpoints, ReviewPro also offers the option to send guest data based on stay lists for clients using the Stay List functionality. With this functionality, ReviewPro receives updates on reservation-information from the moment the reservation enters the system of the property. This enables direct communication with the guest based on different statuses, which are defined within the ReviewPro-tool.

Using the Guest-stays API-endpoints is done in 3 simple steps, each with a different endpoint:

1. Lookup available staylists in an account
2. Lookup staylist fields mapping
3. Import reservations (sending the actual guest data)

1. Lookup available staylists in an account

With this endpoint (/v1/stayList) you retrieve the available staylists within the account. Usually, an account will only have one staylist, but it’s possible to there have been created and configured more within the ReviewPro-tool for various reasons. This endpoint will return the available staylists and their ID.

2. Lookup staylist fields mapping

With this endpoint (/v1/stayList/:stayListId/mapping/pms_api) you retrieve the fields that were mapped for a specific staylist. By entering the ID of the staylist as a parameter, the endpoint will respond with all the fields which were mapped (configured) within the ReviewPro-tool for this specific staylist. This way you will know which fields should be used to send the actual guest data to the staylist by API.

3. Import reservations (sending the actual guest data)

With this endpoint (/v1/stayList/:stayListId/mapping/pms_api/ingest) you will send the guest data regarding reservations to the staylist. Based on the ID of the staylist and the fields that have been mapped, the reservation information (and updates related to reservations) is sent through this API-endpoint to ReviewPro to be processed. Changes in the status on the reservation can trigger communication to the guest, based on configured communication rules within the ReviewPro-tool.

It's important to understand that there is a list of required fields that should always be included when sending guest data to a staylist:

• pmsId
• reservationId
• firstName
• lastName
• status
• checkin
• checkout
• email
• phone

Several reservations can be included in one call by simply comma separate them.

Searching for a stay within the staylist

There is also an API-endpoint available to search for a specific stored stay within the staylist, based on a unique attribute and the ID of the staylist. The unique attribute is configured together with the staylist within the ReviewPro-tool, but when retrieiving the staylist(s) from the account the configured unique attribute is returned as well. Please be aware that searching for a stay within the staylist can only be done using ALL fields which were configured as unique attributes for the staylist.