Room List Search

Object containing relevant information relating to an available room.

Example object:

{
  name: "Oasis"
  code: "oasis"
  currency: "NZD"
  highestPrice: 720
  lowestPrice: 669
  rates: [{
            code: "Bar",
            name: "Flexible Rates",
            price: {
                    averagePrice: 669,
                    currency: "NZD",
                    totalPrice: 704 
                    }
          }]
}

name

Hotel specified name for a specific room.

Type: string

code

A short code used to indentify the room easily.

Type: string

currency

The currency selected for this room type.

Type: string

highestPrice

The highest price listed for different rates for the selected room.

Type: number

lowestPrice

The lowest price listed for different rates for the selected room.

Type: number

rates

An array of rate objects, detailing the specifics of all available rates for the selected room.

Type: array

rates.code

A short code used to indentify the room rate easily.

Type: string

rates.name

Hotel specified name for a specific room rate.

Type: string

rates.price

An object containing details of the prices for this specific room rate.

Type: object

rates.price.averagePrice

The average price for this room rate.

Type: number

rates.price.currency

The currency selected for this room rate.

Type: string

rates.price.totalPrice

The total price for this room rate.

Type: number