---
title: Lookup
slug: lookup
docTags: 
createdAt: 2024-06-26T04:14:10.831Z
---

# Introduction

The lookup method allows users to retrieve details of a specific reservation by passing in a reservation reference number. 

# Request

**Endpoint:**

/LookupReservation.do

| **Element Group**        | **Element Name**         | **Type**  | **Required** | **Element Description**                                                 |
| ------------------------ | ------------------------ | --------- | ------------ | ----------------------------------------------------------------------- |
| lookupReservationRequest | lookupReservationRequest | Group     | YES          |                                                                         |
| lookupReservationRequest | timestamp                | Attribute | YES          | The current timestamp. (YYYYMMDDThh🇲🇲ss)                              |
| lookupReservationRequest | version                  | Attribute | NO           | Optional, but must exist and be set to 2 in order to see the V2 output. |
| lookupReservationRequest | control                  | Group     | YES          |                                                                         |
| control                  | userName                 | Element   | YES          | Your username.                                                          |
| control                  | passWord                 | Element   | YES          | Your password.                                                          |
| lookupReservationRequest | referenceNo              | Element   | YES          | Bonotel reference #                                                     |

# Response

## Primary Reservation Data

| **Element Group**         | **Element Name**          | **Type**  | **Req.** | **Element Description**                                                                                                                                                    |
| ------------------------- | ------------------------- | --------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| lookupReservationResponse | lookupReservationResponse | Group     | YES      |                                                                                                                                                                            |
| lookupReservationResponse | status                    | Attribute | YES      | Status of the response. Valid values are<br />Y – Reservation lookup processed successfully.<br />N – Reservation lookup error.                                            |
| reservationDetails        | reservationDetails        | Group     | YES      |                                                                                                                                                                            |
| reservationDetails        | referenceNo               | Element   | YES      | Internal reference no sent by Bonotel at the time of booking.                                                                                                              |
| reservationDetails        | hotelConfirmation         | Element   | YES      | The hotel’s confirmation number                                                                                                                                            |
| reservationDetails        | tourOperatorName          | Element   | YES      | Tour operator name.                                                                                                                                                        |
| reservationDetails        | tourOperatorOrderNumber   | Element   | YES      | Reference number of the tour operator booking.                                                                                                                             |
| reservationDetails        | hotelCode                 | Group     | YES      | Internal hotel code of the booking.                                                                                                                                        |
| reservationDetails        | hotelName                 | Attribute | YES      | Name of the Hotel.                                                                                                                                                         |
| reservationDetails        | reservationSource         | Element   | YES      | Booking channel which booking has made.<br />Xml - Via XML interface<br />Call center - Via Bonotel  Call center<br />Web - Via Bonotel  website                           |
| reservationDetails        | reservationStatus         | Element   | YES      | Current status of the booking.<br />Normal - booking remains unchanged.<br />Modified - booking has been modified by Bonotel.<br />Cancelled - booking has been cancelled. |
| reservationDetails        | cancellationInfo          | Group     | YES      | Cancellation information                                                                                                                                                   |
| cancellationInfo          | cancellationNo            | Element   | YES      | Cancellation no                                                                                                                                                            |
| cancellationInfo          | cancellationFee           | Element   | YES      | Applied cancellation fee                                                                                                                                                   |
| reservationDetails        | confirmationType          | Element   | YES      | Status notifying whether this is "CON" – Confirm "REQ" - On Request.                                                                                                       |
| reservationDetails        | reservationDate           | Element   | YES      | The date of the booking.                                                                                                                                                   |
| reservationDetails        | checkIn                   | Element   | YES      | Check in date.                                                                                                                                                             |
| reservationDetails        | checkOut                  | Element   | YES      | Check out date.                                                                                                                                                            |
| reservationDetails        | noOfRooms                 | Element   | YES      | No of rooms booked.                                                                                                                                                        |
| reservationDetails        | noOfNights                | Element   | YES      | No of Nights booked.                                                                                                                                                       |
| reservationDetails        | totalNoOfAdults           | Attribute | YES      | Total number of adults for the booking.                                                                                                                                    |
| reservationDetails        | totalNoOfChildren         | Element   | YES      | Total number of children for the booking.                                                                                                                                  |
| reservationDetails        | total                     | Element   | YES      | The total value of this reservation.   (including taxes)                                                                                                                   |
| total                     | currency                  | Attribute | YES      | The currency of the total reservation.                                                                                                                                     |
| reservationDetails        | totalTax                  | Element   | YES      | The total tax associated with the reservation.                                                                                                                             |
| totalTax                  | currency                  | Element   | YES      | The currency of the Tax.                                                                                                                                                   |
| reservationDetails        | roomData                  | Group     | YES      | The room’s details, this should be repeated up to the no of rooms.                                                                                                         |

## Room Data

| Element Group      | Element Name | Type    | Req. | Element Description                                                                                                                       |
| ------------------ | ------------ | ------- | ---- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| roomData           | roomNo       | Element | YES  | The room no.  of the booking.                                                                                                             |
| roomData           | roomResNo    | Element | YES  | The room ID assigned by Bonotel.                                                                                                          |
| roomData           | roomCode     | Element | YES  | The room code assigned by Bonotel.                                                                                                        |
| roomData           | roomType     | Element | YES  | The room type name of the booked room.                                                                                                    |
| roomData           | roomTypeCode | Element | YES  | The room type code of the booked room.                                                                                                    |
| roomData           | bedType      | Element | YES  | The bed type name of the booked room.                                                                                                     |
| roomData           | bedTypeCode  | Element | YES  | The bed type code of the booked room.                                                                                                     |
| roomData           | ratePlan     | Element | YES  | The rate plan name of the booked room.                                                                                                    |
| roomData           | ratePlanCode | Element | YES  | The rate plan code of the booked room.                                                                                                    |
| roomData           | noOfAdults   | Element | YES  | No of adults of the booked room.                                                                                                          |
| roomData           | noOfChildren | Element | NO   | No of children of the booked room.                                                                                                        |
| roomData           | occupancy    | Group   | YES  | Occupancy details are wrapped with in this group.                                                                                         |
| occupancy          | guest        | Group   | YES  | Occupancy group of the booked room. Note that the no of adults and children should be represented by this occupancy.                      |
| guest              | title        | Element | YES  | Title of the guest, applicable only for Adults.<br />List of titles: \["Dr.", "Prof.", "Mstr.", "Mr.", "Miss.", "Ms.", "Mrs.", "Mr/Mrs."] |
| guest              | firstName    | Element | YES  | First name of the guest.                                                                                                                  |
| guest              | lastName     | Element | YES  | Last name of the guest.                                                                                                                   |
| reservationDetails | comment      | Group   | YES  |                                                                                                                                           |
| comment            | customer     | Element | NO   | Any comments from the customer.                                                                                                           |

# Code Example

## Request

/LookupReservation.do

```xml
<?xml version="1.0" encoding="utf-8" ?>
<lookupReservationRequest timestamp="20150325T14:01:29 " version="2">
	<control>
		<userName>{{Username}}</userName>
		<passWord>{{Password}}</passWord>
	</control>
	<referenceNo>123456789X</referenceNo>
</lookupReservationRequest>
```

## Response

```xml
<?xml version="1.0" encoding="utf-8" ?>
<lookupReservationResponse status="Y" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<reservationDetails>
		<referenceNo>354324117X</referenceNo>
		<hotelConfirmation>6c3ee91a-54c0-4499-a8cb-df54dbcb14c8</hotelConfirmation>
		<tourOperatorName>My Travel Company</tourOperatorName>
		<tourOperatorOrderNumber>654321</tourOperatorOrderNumber>
		<hotelCode>1343</hotelCode>
		<hotelName>ARIA Resort and Casino</hotelName>
		<reservationSource>Xml</reservationSource>
		<reservationStatus>Normal</reservationStatus>
		<cancellationInfo>
			<cancellationNo/>
			<cancellationFee/>
			<cancellationTimeStamp/>
		</cancellationInfo>
		<confirmationType>CON</confirmationType>
		<reservationTimeStamp>2017-01-19T03:53:43+00:00</reservationTimeStamp>
		<modificaitonTimeStamp/>
		<checkIn>22-Apr-2017</checkIn>
		<checkOut>24-Apr-2017</checkOut>
		<noOfRooms>2</noOfRooms>
		<noOfNights>2</noOfNights>
		<totalNoOfAdults>1</totalNoOfAdults>
		<totalNoOfChildren>1</totalNoOfChildren>
		<total currency="USD">1274.88</total>
		<totalTax currency="USD">0.00</totalTax>
		<roomData>
			<roomNo>1</roomNo>
			<roomResNo>57467147</roomResNo>
			<roomCode>5943</roomCode>
			<roomType>Deluxe King</roomType>
			<roomTypeCode>74</roomTypeCode>
			<bedType>Double</bedType>
			<bedTypeCode>10</bedTypeCode>
			<ratePlan>Room Only</ratePlan>
			<ratePlanCode>1</ratePlanCode>
			<noOfAdults>1</noOfAdults>
			<noOfChildren>1</noOfChildren>
			<childAges>
				<childAge>4</childAge>
			</childAges>
			<occupancy>
				<guest>
					<title>Mr</title>
					<firstName>testFirst1n</firstName>
					<lastName>testLast1n</lastName>
				</guest>
				<guest>
					<title>Mr.</title>
					<firstName>testFirst2n</firstName>
					<lastName>testLast2n</lastName>
				</guest>
			</occupancy>
			<roomBookingPolicy>
				<policyFrom>2008-04-01</policyFrom>
				<policyTo>2018-12-29</policyTo>
				<amendmentType>Cancel</amendmentType>
				<policyBasedOn>percentage</policyBasedOn>
				<policyBasedOnValue>100</policyBasedOnValue>
				<cancellationType>Normal</cancellationType>
				<stayDateRequirement>N</stayDateRequirement>
				<arrivalRange>Less Than</arrivalRange>
				<arrivalRangeValue>4</arrivalRangeValue>
				<policyFee>$1175.52</policyFee>
				<noShowBasedOn>percentage</noShowBasedOn>
				<noShowBasedOnValue>100</noShowBasedOnValue>
				<noShowPolicyFee>$1175.52</noShowPolicyFee>
			</roomBookingPolicy>
			<hotelFees>
				<hotelFee>
					<feeType>Resort</feeType>
					<feeMethod>Exclusive</feeMethod>
					<requiredFee>Yes</requiredFee>
					<feeAssign>Per Room</feeAssign>
					<feeFrequency>Per Night</feeFrequency>
					<feeBasedOn>VAL</feeBasedOn>
					<feeBasedOnValue>39.0</feeBasedOnValue>
					<salesTax>13.38</salesTax>
					<conditions/>
					<feeTotal>309.53</feeTotal>
				</hotelFee>
			</hotelFees>
		</roomData>
		<comment>
			<customer>ground floor, non-smoking</customer>
		</comment>
	</reservationDetails>
</lookupReservationResponse>
```

# Response Codes

| **Code** | **Description**                                             |
| -------- | ----------------------------------------------------------- |
| L1       | Unspecified error. Please contact customer support.         |
| L2       | User ID not supplied or not valid.                          |
| L3       | No XML input detected.                                      |
| L4       | Erroneous or Incomplete Data in Lookup Reservation Request. |
| L5       | Reservation number not provided.                            |
| L6       | Request IP Address not found for the user.                  |
| L7       | Request IP Address not matched for the user.                |
| L8       | Reservation was not found.                                  |
| L9       | Reservation does not belong to this user.                   |