Booking Item Price Breakdown

The Booking Item Price Breakdown provides the client with a price breakdown of individual booking items

Example XML Booking Item Price Breakdown request

The XML message below gives a sample of the expected elements needed by the API to execute a Booking Item 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>
		<BookingItemPriceBreakdownRequest>
			<BookingReference>BOOK1002</BookingReference>
			<ItemReference>1</ItemReference>
		</BookingItemPriceBreakdownRequest>
	</RequestDetails>
</Request>

Source parameters

Please refer to the API Architecture document.

Booking Item Price Breakdown parameters

This request will be used to retrieve a bookings item for price breakdown. The following sub-elements must be specified: 

Element

Description

BookingReference

Mandatory. This will contain a reference to identify booking(s).

 

Attribute

Description

 

ReferenceSource

Values allowed (if not specified will default to “client”): -

  • “client” - the unique client reference. If found this would return a single booking.
  • “api” - the unique GTA reference. If found this would return a single booking.

ItemReference

Mandatory. The breakdown will be given for the booking item with the specified item reference.


Example XML Booking Item Price Breakdown response

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

<?xml version="1.0" encoding="UTF-8"?>
<Response ResponseReference="34567">
	<ResponseDetails Language="en">
		<BookingItemPriceBreakdownResponse>
			<BookingReferences>
				<BookingReference ReferenceSource="client">BOOK1002</BookingReference>
				<BookingReference ReferenceSource="api">56789</BookingReference>
			</BookingReferences>
				<BookingItem ItemType="hotel">
					<ItemReference>1</ItemReference>
					<ItemCity Code="EDI"><![CDATA[Edinburgh]]></ItemCity>
					<Item Code="POI"><![CDATA[Point]]></Item>
					<ItemPrice 
                         Currency="GBP" 
                         Gross="1855.00"
                         IncludedOfferDiscount="192.50"
                         GrossWithoutDiscount="2047.50">
                     </ItemPrice>
                     <Offer Code="FNT"><![CDATA[Free Night(s)]]></Offer>
					<HotelItem>
						<PeriodOfStay>
							<CheckInDate>2005-05-29</CheckInDate>
							<CheckOutDate>2005-06-08</CheckOutDate>
						</PeriodOfStay>
						<HotelRooms>
							<HotelRoom Code="TB">
	<RoomPrice Gross="1347.50" />
								<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-07</ToDate>
					</DateRange>
			<Price Nights="7" Gross="140.00" />
					</PriceRange>
								</PriceRanges>
							</HotelRoom>
							<HotelRoom Code="CH" ChildAge="14">
	<RoomPrice Gross="700.00" />
								<PriceRanges>
					<PriceRange>
					<DateRange>
						<FromDate>2005-05-29</FromDate>
						<ToDate>2005-06-07</ToDate>
					</DateRange>
			<Price Nights="10" Gross="70.00" />
					</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>
				</BookingItem>
		</BookingItemPriceBreakdownResponse>
	</ResponseDetails>
</Response>

Booking Item Price Breakdown response parameters

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

Element

Description

BookingReferences

This will contain a list of references that uniquely identify the booking.

BookingItem

The item requiring price breakdown.

 

Attribute

Description

 

ItemType

Identifies the type of item (i.e. Hotel, Sightseeing etc.).


BookingItem sub-element

<ItemReference>1</ItemReference>
<ItemCity Code="LON"> <![CDATA[London]]></ItemCity>
<Item Code="EMP"><![CDATA[5 Emperors Gate]]></Item>
<ItemPrice Currency="GBP" Gross="191.00" />

 

Element

Description

ItemReference

This will contain the reference that uniquely identifies the booking item.

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.

 

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.

ApartmentItem

Apartment item details. See Apartment Item section.

SightseeingItem

Sightseeing item details. See Sightseeing Item section.

Docs Navigation