Reservation Detail

POST

/api/v1/generic-api-service/royal/hotel/book/detail

The reservation detail endpoint is used to display the details of the reservation.

Request

{
  "reservationId": "ETSR341226703",
  "clientReferenceId": "testtest14"
}

Response

{
    "hotelName": "Yozgat Center Hotel",
    "hotelAddress": "Yozgat City Center, Yozgat",
    "hotelPhone": "(+90) 5328459202,
    "price": 1000.00,
    "currency": "TRY",
    "voucher": "ETSR341226703",
    "bookingUuid": "575e9de2-5d09-4b3c-8db6-7ed4affcc36f",
    "bookingNumber": "111953206",
    "clientReferenceId": "testtest14",
    "checkIn": "2023-06-19",
    "checkOut": "2023-06-20",
    "contactName": "Etscore Test",
    "contactPhone": "(+90) 5555555555",
    "paymentInfos": [
        {
            "taxFee": 0.00,
            "otherFees": 0.00,
            "hotelPrice": 1000,
            "currency": "TRY",
            "paymentDate": "2022-03-17",
            "paymentMethod": "Deposit",
            "paymentStatus": True
        }
    ],
    "additionalInfo": "I prefer to stay in a room with the air conditioner.",
    "cancellationPolicies": [
        {
            "amount": 0.0,
            "currency": "EUR",
            "toDate": "2023-09-05T12:00:00",
            "fromDate": "2023-07-13T12:10:47.956938"
        },
        {
            "amount": 500.0,
            "currency": "EUR",
            "toDate": "2023-09-10T12:00:00",
            "fromDate": "2023-09-05T12:00:00"
        },
        {
            "amount": 1000.0,
            "currency": "EUR",
            "toDate": "2023-09-15T12:00:00",
            "fromDate": "2023-09-10T12:00:00"
        }
    ],
    "reservationDetails": [
        {
            "date": "2022-05-01",
            "status": "RESERVATION",
            "roomPrice": 1000,
            "refundPrice": 1000.00,
            "roomCode": "28030"
        }
    ],
    "guests": [
        {
            "name": "Etscore",
            "surname": "Test",
            "birthDate": "1990-09-13",
            "guidId": "c25aa31e-c8d2-4d3c-9a49-21d9b43c5453"
        }
    ],
    "room": [
        {
            "pax": {
                "adult": 2,
                "child": 0,
                "childAges": null
            },
            "roomCode": "39816",
            "roomName": "Standart Room RO",
            "mealType": "RO",
            "nightlyPrices": [
                {
                    "date": "2023-09-22",
                    "amount": 233.27,
                    "currency": "EUR"
                }
            ],
            "confirmationCode": "ETSR20300751539816"
        }
    ]
}

Request Details

Name	Type	Required	Description
reservationId	string	No	Reservation id whose details will be displayed.
clientReferenceId	string	No	[ 1 .. 20 ] characters. Internal booking reference.

Response Details

Name	Type	Required	Description
hotelName	string	Yes	Name of the hotel booked.
hotelAddress	string	Yes	Address of the hotel booked.
hotelPhone	string	Yes	Phone number of the hotel booked.
price	int	Yes	Reservation price
currency	string	Yes	Currency in which the reservation is completed.
voucher	string	Yes	Voucher number that will be created in our system when the reservation is completed successfully.
bookingUuid	string	Yes	It is a unique id that will be generated by us for each reservation.
bookingNumber	string	Yes	Booking number that will be created in our system when the reservation is completed successfully
clientReferenceId	string	No	[ 1 .. 20 ] characters. Internal booking reference.
checkIn	string	Yes	Checkin date
checkOut	string	Yes	Checkout date
contactName	string	Yes	Contact person for reservation.
contactPhone	string	Yes	Phone number of the contact person for the reservation
paymentInfos	string	Yes	Payment information of reservation
paymentInfos/taxFee	string	Yes	Tax fee included in the reservation
paymentInfos/otherFees	string	Yes	Other fees included in the reservation
paymentInfos/hotelPrice	string	Yes	Hotel price of the reservation
paymentInfos/currency	string	Yes	Currency in which the payment is made.
paymentInfos/paymentDate	string	Yes	Payment date
paymentInfos/paymentMethod	string	Yes	Payment completion method
paymentInfos/paymentStatus	string	Yes	Payment status
additionalInfo	string	No	Additional information in the reservation, if any.
cancellationPolicies	string	Yes	Object to return information for cancellation policies.
cancellationPolicies/amount	decimal	No	Penalty amount to be paid
cancellationPolicies/currency	string	No	Penalty amount currency to be paid
cancellationPolicies/toDate	string	No
cancellationPolicies/fromDate	string	No
reservationDetails	string	Yes	Detailed information about the reservation
reservationDetails/date	string	Yes	Reservation date
reservationDetails/status	string	Yes	Reservation status
reservationDetails/roomPrice	string	Yes	Room price
reservationDetails/refundPrice	string	Yes	Refunded fee if reservation is cancelled.
reservationDetails/roomCode	string	Yes	Room code of the reservation
guests	string	Yes	This object must provide information about the guests staying in the reservation.
guests/name	string	Yes	Guest's name
guests/surname	string	Yes	Guest's surname
guests/birthDate	string	Yes	Guest's birthDate. It should be sent in the format 'YYYY-MM-DD'.
guests/guidId	string	Yes	Unique id that will be generated by us for each guest
room	Object-Array	Yes	It is the information of the room that was reserved. Currently, only 1 room can be reserved per 1 reservation. When the multi-room feature is provided, it will be seen in the document.
room/pax	Object-Array	Yes	The number of people about the reserved room should be included in this object.
room/pax/adult	int	Yes	The number of adults that will be accommodated.
room/pax/child	int	No	The number of children that will be accommodated.
room/pax/childAges	int-Array	No	If there are children in the reservation, ages of the children must be in this parameter
room/roomCode	string	Yes	Room code in Etstur structure.
room/roomName	string	Yes	Room name in Etstur structure.
room/mealType	string	Yes	Meal type in Etstur structure.
room/description	string	No	Room description in Etstur structure.
room/confirmationCode	string	Yes	Parameter to use when canceling a Refundable reservation.
room/nightlyPrices	object-Array	Yes	An object that allows the room's nightly prices to be displayed separately. and Price must be big decimal type.
room/nightlyPrices/date	string	Yes	Date of the day, date format must be YYYY-MM-DD
room/nightlyPrices/amount	decimal	Yes	Price amount of the day
room/nightlyPrices/currency	string	Yes	Information in which currency the reservation amount is in is returned with the 'currency' parameter.
room/roomType	string	Yes	Room type in Etstur structure.