Hotel Item

When a breakdown of prices is required for a hotel item they will be contained within the HotelItem sub-element.

Response

HotelItem sub-element

For a response the API will return the following attributes and sub-elements allowed for a HotelItem sub-element:

Parameter

Description

PeriodOfStay

Specifies the period of stay.

HotelRooms

Specifies one or more HotelRoom elements – which are used to describe the room details and assign passenger details. See HotelRoom definition below.


PeriodOfStay sub-element

The following gives a list of sub-elements for a PeriodOfStay sub-element: 

Element

Description

CheckInDate

Specifies the date of check in.

CheckOutDate

Specifies the date of check out


HotelRoom sub-element

The following gives a list of attributes and sub-elements for a HotelRoom sub-element: 

Attribute

Description

Code

Specifies the GTA room code for the hotel.

Id

Specifies the category of room. This is an optional attribute dependant on the client’s Participation Level: -

Level 0: Not output

Level 1 and above: Output

ChildAge

This specifies the child age if the price breakdown is for a child.

NumberOfRooms

If more than one room for the room code exists, this specifies the number of rooms.

Element

Description

RoomPrice

The price information at room level. Contains the following attributes:

  • Gross.

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

  • Available – this shows as false when performing a HotelPriceBreakdownRequest and the room type is not available or cannot be priced for part of the Period of Stay requested.

PriceRanges

Specifies one or more PriceRange elements – which are used to describe the breakdown of price information for a particular date range. See PriceRange definition below.

Attribute

Description

DailyAverage

Will be returned as “true” when our third-party suppliers are not able to provide us with the price breakdown.  

Attribute

Description

Code

Specifies the GTA room code for the hotel.

ChildAge

This specifies the child age if the price breakdown is for a child.

NumberOfRooms

If more than one room for the room code exists, this specifies the number of rooms.

 

Element

Description

RoomPrice

The price information at room level. Contains the following attributes:

  • Gross.

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

  • Available – this shows as false when performing a HotelPriceBreakdownRequest and the room type is not available or cannot be priced for part of the Period of Stay requested.

PriceRanges

Specifies one or more PriceRange elements – which are used to describe the breakdown of price information for a particular date range. See PriceRange definition below.


PriceRange sub-element

The following gives a list of sub-elements for a PriceRange sub-element:

Element

Description

DateRange

The range of dates for which the price breakdown is applicable. Contains the following: -

  • FromDate – The start date for the range.
  • ToDate – The end date of the range

Price

The price information at night level. Contains the following attributes:

  • Nights – the number of consecutive nights the price is applicable.

 

Will also show: -

EITHER

  • Gross - the price applicable for each within the date range.

OR

  • Available=”false”

Only shows when performing a HotelPriceBreakdownRequest and the hotel is not available or cannot be priced for part of the Period of Stay requested.

Docs Navigation