Please find the below API details to connect to Hopr. I'll share the credentials to access the API tomorrow. Meanwhile, please let me know if you have any questions with the below payload.
{
"hotelGroupId": "string",
"hotelGroupKey": "string",
"hotelId": "string",
"forceFullResync": true,
"reservations": [
{
"reservationId": "string",
"guestId": "string",
"rcRoomName": "string",
"pmsRoomName": "string",
"parentRoomName": "string",
"name": "string",
"checkIn": "2024-05-06T15:25:35.977Z",
"actualCheckIn": "2024-05-06T15:25:35.977Z",
"checkOut": "2024-05-06T15:25:35.977Z",
"actualCheckOut": "2024-05-06T15:25:35.977Z",
"status": "string",
"adults": 0,
"children": 0,
"infants": 0,
"pmsNote": "string",
"vip": "string",
"otherProperties": [
{
"key": "string",
"value": "string"
} ],
"groupName": "string",
"externalId": "string",
"address": "string",
"city": "string",
"email": "string",
"postalCode": "string",
"phone": "string",
"rateCode": "string",
"membership": "string",
"products": [
{
"id": "string",
"name": "string",
"dates": [
"string"
] } ] } ],
"removedReservations": [
{
"reservationId": "string",
"guestId": "string"
} ],
"roomMoves": [
{
"reservationId": "string",
"guestId": "string",
"fromRoomName": "string",
"fromBedName": "string",
"toRoomName": "string",
"toBedName": "string"
} ],
"reservationEvents": [
{
"reservationId": "string",
"guestId": "string",
"rccReservationEventTypeKey": "string",
"at": "2024-05-06T15:25:35.977Z"
} ] }Field Details (* marked are required fields)
- forceFullResync (boolean): Indicates whether a full synchronization is required.
- reservations (array) *: Array of reservation objects.
- reservationId (string) *: Unique identifier for the reservation.
- guestId (string) *: Unique identifier for the guest.
- rcRoomName (string) *: Room name in the Hopr system.
- pmsRoomName (string) *: Room name in the property management system.
- parentRoomName (string): Parent room name.
- name (string): Guest name.
- checkIn (string) *: Check-in date and time in ISO 8601 format.
- actualCheckIn (string): Actual check-in date and time in ISO 8601 format.
- checkOut (string) *: Check-out date and time in ISO 8601 format.
- actualCheckOut (string): Actual check-out date and time in ISO 8601 format.
- status (string) *: Reservation status. (Arrival, Arrived, Current, Departure, Departed)
- adults (integer): Number of adults.
- children (integer): Number of children.
- infants (integer): Number of infants.
- pmsNote (string): Notes in the property management system.
- vip (string): VIP status.
- otherProperties (array): Dictionary of additional properties.
- key (string): Property key.
- value (string): Property value.
- groupName (string): Group name.
- externalId (string): External identifier.
- address (string): Guest address.
- city (string): Guest city.
- email (string): Guest email.
- postalCode (string): Guest postal code.
- phone (string): Guest phone number.
- rateCode (string): Rate code.
- membership (string): Membership status.
- products (array): Array of products.
- id (string) *: Product ID.
- name (string) *: Product name.
- dates (array): Array of dates associated with the product.
- removedReservations (array): Array of removed reservation objects.
- reservationId (string) *: Unique identifier for the removed reservation.
- guestId (string) *: Unique identifier for the guest associated with the removed reservation.
- roomMoves (array): Array of room move done for an existing reservation.
- reservationId (string) *: Unique identifier for the reservation associated with the room move.
- guestId (string) *: Unique identifier for the guest associated with the room move.
- fromRoomName (string) *: Previous room name.
- fromBedName (string): Previous bed name.
- toRoomName (string) *: New room name.
- toBedName (string): New bed name.
- reservationEvents (array): Ignore this array
- reservationId (string): Unique identifier for the reservation associated with the event.
- guestId (string): Unique identifier for the guest associated with the event.
- rccReservationEventTypeKey (string): Key representing the type of reservation event.
- at (string): Event timestamp in ISO 8601 format.
Use this to fetch all reservations of the hotel.
{
"from": "2024-05-06T15:52:51.252Z",
"to": "2024-05-06T15:52:51.252Z"
}Fields- from (string) *: From date and time in ISO 8601 format.
- to (string): To date and time in ISO 8601 format.
this is the swagger url but note the host endpoint is https://hoprinterface.
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article