Hotel Price Breakdown

The Hotel Price Breakdown provides the client with a price breakdown for a given hotel. The client must specify search parameters to identify the price breakdown required. All requests will need to be sent in a SYNCHRONOUS mode; any requests send in an ASYNCHRONOUS will return an error.

Example XML Hotel Price Breakdown request

The XML message below gives a sample of the expected elements needed by the API to execute a Hotel Price Breakdown Request.

<?xml version="1.0" encoding="UTF-8"?>
<Request>
  <Source>
<RequestorID Client="123456" EMailAddress="clientName@client.co.uk" Password="clientPassword" />
    <RequestorPreferences Language="en">
		  <RequestMode>SYNCHRONOUS</RequestMode> 
    </RequestorPreferences>
  </Source>
	<RequestDetails>
		<HotelPriceBreakdownRequest>
			<City>AMS</City>
			<Item>APP</Item>
			<PeriodOfStay>
				<CheckInDate>2005-05-29</CheckInDate>
				<Duration>10</Duration>
			</PeriodOfStay>
			<Rooms>
				<Room Code="TB" NumberOfCots="1">
					<ExtraBeds>
						<Age>14</Age>
					</ExtraBeds>
				</Room>
			</Rooms>
		</HotelPriceBreakdownRequest>
	</RequestDetails>
</Request>

Source parameters

Please refer to the API Architecture document.

Hotel Price Breakdown parameters

This request will be used to retrieve the hotel price breakdown for the given search criteria. The following sub-elements must be specified: 

Parameters

Description

City

Mandatory. Specifies the city for the Item.

Item

Mandatory. Specifies the item (hotel) for which the price breakdown is required.

PeriodOfStay

Mandatory. Defines the check-in day and either the check-out day or the duration of stay.

Rooms

Mandatory. A list of the requested hotel rooms, with information on the number of rooms, the number of cots and the ages of any extra children staying in.


Rooms parameter

The client can request a number of rooms through the <Rooms> element. The latter is made up of a list of <Room> sub-elements, one element for each different requested room type.

An example of a <Room> element, for one twin room with one cot and one extra bed (for child aged 10), is shown below:

			<Room Code="TB" NumberOfCots="1">
				<ExtraBeds>
					<Age>10</Age>
				</ExtraBeds>
			</Room>

The <Room> element can contain an Id attribute which is used to specify the room category. This is an optional attribute and is dependant on the client’s Participation Level: -

  • Participation Level – None

Must not be entered.

  • Participation Level – 1

Mandatory.

  • Participation Level – 2.

Mandatory.

<Room Code="DB" Id = "001:APP1:22681:S22237:33643:121162" NumberOfRooms="1" />

Example XML Hotel Price Breakdown response

The XML message below gives a sample of that given by the API in response to a Hotel Price Breakdown Request.

<?xml version="1.0" encoding="UTF-8"?>
<Response ResponseReference="34567">
	<ResponseDetails Language="en">
		<HotelPriceBreakdownResponse>
				<ItemCity Code="EDI"><![CDATA[Edinburgh]]></ItemCity>
				<Item Code="POI"><![CDATA[Point]]></Item>
				<ItemPrice 
                      Currency="GBP" 
                      Gross="1275.75.00"
                      Available="false"
                      IncludedOfferDiscount="141.75"
                      GrossWithoutDiscount="1417.50">
                 </ItemPrice>
                 <Offer Code="DSN"><![CDATA[Discount Night(s), Meals Not Included]]></Offer>
				<HotelItem>
					<PeriodOfStay>
						<CheckInDate>2005-05-29</CheckInDate>
						<CheckOutDate>2005-06-08</CheckOutDate>
					</PeriodOfStay>
					<HotelRooms>
						<HotelRoom Code="TB">
<RoomPrice Gross="927.50" Available="false" />
							<PriceRanges>
			<PriceRange>
			<DateRange>
				<FromDate>2005-05-29</FromDate>
				<ToDate>2005-05-31</ToDate>
			</DateRange>
	<Price Nights="3" Gross="122.50" />
			</PriceRange>
			<PriceRange>
			<DateRange>
				<FromDate>2005-06-01</FromDate>
				<ToDate>2005-06-01</ToDate>
			</DateRange>
	<Price Nights="1" Gross="140.00" />
			</PriceRange>
	<PriceRange>
	<DateRange>
		<FromDate>2005-06-02</FromDate>
		<ToDate>2005-06-04</ToDate>
	</DateRange>
	<Price Nights="3" Available="false" />
			</PriceRange>
			<PriceRange>
			<DateRange>
				<FromDate>2005-06-05</FromDate>
				<ToDate>2005-06-07</ToDate>
			</DateRange>
	<Price Nights="3" Gross="140.00" />
			</PriceRange>
						</PriceRanges>
					</HotelRoom>
					<HotelRoom Code="CH" ChildAge="14">
  <RoomPrice Gross="490.00" Available="false" />
							<PriceRanges>
			<PriceRange>
			<DateRange>
				<FromDate>2005-05-29</FromDate>
				<ToDate>2005-06-01</ToDate>
			</DateRange>
	<Price Nights="4" Gross="70.00" />
			</PriceRange>
							</PriceRanges>
	<PriceRange>
	<DateRange>
		<FromDate>2005-06-02</FromDate>
		<ToDate>2005-06-04</ToDate>
	</DateRange>
	<Price Nights="3" Available="false" />
			<PriceRange>
			<PriceRange>
			<DateRange>
				<FromDate>2005-06-05</FromDate>
				<ToDate>2005-06-07</ToDate>
			</DateRange>
	<Price Nights="3" Gross="70.00" />
			</PriceRange>
</PriceRange>
</PriceRanges>
						</HotelRoom>
						<HotelRoom Code="CT">
		<RoomPrice Gross=".00" />
						<PriceRanges>
			<PriceRange>
			<DateRange>
			<FromDate>2005-05-29</FromDate>
				<ToDate>2005-06-07</ToDate>
			</DateRange>
	<Price Nights="10" Gross=".00" />
			</PriceRange>
							</PriceRanges>
						</HotelRoom>
					</HotelRooms>
				</HotelItem>
		</BookingItemPriceBreakdownResponse>
	</ResponseDetails>
</Response>

Hotel Price Breakdown response parameters

The API will return the following Booking level sub-elements:

Element

Description

ItemCity

The city name, the Code attribute specifies the GTA city code for the item.

Item

The item name, the Code attribute specifies the GTA code for the item.

 

ItemPrice

The total price of the stay.

 

Attribute

Description

 

Currency

The ISO currency code of the currency in which the Gross, GrossWithoutDiscount price and the IncludedOfferDiscount are returned in.

 

Gross

The gross price of the booking item.

 

NOTE: If the Available=”false” attribute is shown this price shows the total for the days for which the corresponding rooms can be priced.

Available – this shows as false when performing a HotelPriceBreakdownRequest and the hotel cannot be priced for all or part of the Period of Stay requested.

 

GrossWithoutDiscount

The gross price without the discount being deducted.

 

IncludedOfferDiscount

The discount that is being applied to the gross price.

 

Offer

The offer name.

 

Attribute

Description

 

Code

The unique offer code held by GTA


The booking Item requested. A booking item can be one of the following: 

HotelItem

Hotel item details. See Hotel Item section.


All other booking items only show the price details at item level. 

Docs Navigation