Hotel
Represents a hotel accommodation in Search responses.
Properties
| Name | Type | Description |
|---|---|---|
| AccommodationType | AccommodationType | Gets or initializes the type of accommodation. |
| AccommodationCode | String | Gets the unique code identifying the accommodation. |
| AccommodationName | String | Gets or initializes the name of the accommodation. |
| Boards | Array<Board> | Gets the list of boards available for the hotel. |
| Boards/BoardCode | String | The unique code identifying the board. |
| Boards/Name | String | The name of the board. |
| Boards/Options | Array<Option> | The collection of options associated with this board. |
| Boards/Options/FormId | String | Internal field for FormTest. Not serialized. DO NOT USE! |
| Boards/Options/Status | Status | Indicates the availability status of the option. |
| Boards/Options/Price | Price | The price details associated with the option, including net, gross and minimum selling price. |
| Boards/Options/Price/Currency | Currency | The currency of the price, represented in ISO 4217 format (e.g., USD, EUR). |
| Boards/Options/Price/Binding | Boolean | Indicates whether the price is binding. |
| Boards/Options/Price/Net | Double | The net price paid by the Buyer to the Seller. |
| Boards/Options/Price/Gross | Double | The gross price, which includes the net price and the Buyer's commission. |
| Boards/Options/Price/ NetSpecified | Boolean | Indicates whether the net price is explicitly specified. |
| Boards/Options/Price/ MinimumSellingPrice | Double | The minimum selling price. |
| Boards/Options/PaymentTypes | Array<PaymentType> | Specifies the accepted payment types for the option. |
| Boards/Options/Rooms | Array<Room> | The list of rooms included with the option, including type, description, and price. |
| Boards/Options/Rooms/ OccupancyRefId | Integer | Numeric ID linking this room to its occupancy data in the Occupancy. |
| Boards/Options/Rooms/Code | String | Unique code assigned to this room. |
| Boards/Options/Rooms/ Description | String | Description of the room's features or characteristics. |
| Boards/Options/Rooms/RoomPrice | RoomPrice | Pricing information for the room, including total price and currency details. |
| Boards/Options/Rooms/RoomPrice/ Price | Price | The total price of the room. |
| Boards/Options/Rooms/RoomPrice/ Price/Currency | Currency | The currency of the price, represented in ISO 4217 format (e.g., USD, EUR). |
| Boards/Options/Rooms/RoomPrice/ Price/Binding | Boolean | Indicates whether the price is binding. |
| Boards/Options/Rooms/RoomPrice/ Price/Net | Double | The net price paid by the Buyer to the Seller. |
| Boards/Options/Rooms/RoomPrice/ Price/Gross | Double | The gross price, which includes the net price and the Buyer's commission. |
| Boards/Options/Rooms/RoomPrice/ Price/NetSpecified | Boolean | Indicates whether the net price is explicitly specified. |
| Boards/Options/Rooms/RoomPrice/ Price/MinimumSellingPrice | Double | The minimum selling price. |
| Boards/Options/Rooms/RoomPrice/ PriceBreakdown | Array<PriceBreakdown> | Breakdown of the room price over specific periods, such as daily rates. |
| Boards/Options/Rooms/RoomPrice/ PriceBreakdown/Price | Price | The price for each day of the room during the specified period. |
| Boards/Options/Rooms/RoomPrice/ PriceBreakdown/Price/Currency | Currency | The currency of the price, represented in ISO 4217 format (e.g., USD, EUR). |
| Boards/Options/Rooms/RoomPrice/ PriceBreakdown/Price/Binding | Boolean | Indicates whether the price is binding. |
| Boards/Options/Rooms/RoomPrice/ PriceBreakdown/Price/Net | Double | The net price paid by the Buyer to the Seller. |
| Boards/Options/Rooms/RoomPrice/ PriceBreakdown/Price/Gross | Double | The gross price, which includes the net price and the Buyer's commission. |
| Boards/Options/Rooms/RoomPrice/ PriceBreakdown/Price/ NetSpecified | Boolean | Indicates whether the net price is explicitly specified. |
| Boards/Options/Rooms/RoomPrice/ PriceBreakdown/Price/ MinimumSellingPrice | Double | The minimum selling price. |
| Boards/Options/Rooms/RoomPrice/ PriceBreakdown/Start | Integer | The starting day of the pricing period (inclusive). |
| Boards/Options/Rooms/RoomPrice/ PriceBreakdown/End | Integer | The ending day of the pricing period (inclusive). |
| Boards/Options/Rooms/ Refundable | Boolean | Indicates if the room is refundable based on the cancellation policy. |
| Boards/Options/Rooms/ RefundableSpecified | Boolean | Indicates whether the refundable status has been explicitly specified. |
| Boards/Options/Rooms/ LegacyRoomId | String | Legacy identifier for internal tracking. Automatically generated using OccupancyRefId and Code. |
| Boards/Options/Rooms/Units | Integer | Number of units available for this room type. |
| Boards/Options/Rooms/RatePlan | RatePlan | Rate plan associated with this room. |
| Boards/Options/Rooms/RatePlan/ Code | String | The unique code for the rate plan. |
| Boards/Options/Rooms/RatePlan/ Name | String | The name of the rate plan. |
| Boards/Options/Rooms/ Promotions | Array<Promotion> | Promotions or discounts applicable to this room. |
| Boards/Options/Rooms/ Promotions/Code | String | The unique code identifying the promotion. |
| Boards/Options/Rooms/ Promotions/Name | String | The name of the promotion. |
| Boards/Options/Rooms/Remarks | Array<Remark> | Additional remarks or notes about this room. |
| Boards/Options/Rooms/Remarks/ RemarkType | RemarkType | The type of the remark, categorized by RemarkType, specifies its nature or purpose. It may refer to the hotel as a whole, a specific room being booked, services provided by the accommodation, or general remarks not tied to any particular entity. |
| Boards/Options/Rooms/Remarks/ Text | String | The text content of the remark, providing details or additional notes.This can include supplier-specific instructions, conditions, or general information. |
| Boards/Options/Rooms/ Surcharges | Array<Surcharge> | Additional surcharges applied to this room. |
| Boards/Options/Rooms/ Surcharges/ChargeType | ChargeType | Specifies whether the surcharge is included in the room rate or must be paid separately at the property. See ChargeType for possible values. |
| Boards/Options/Rooms/ Surcharges/Mandatory | Boolean | Indicates whether this surcharge is mandatory. Mandatory surcharges, such as government taxes, must always be paid, while optional surcharges may depend on the guest's preferences. |
| Boards/Options/Rooms/ Surcharges/Description | String | Provides a description of the surcharge, giving context about the type of cost it represents.Examples: "Tourist Tax", "Resort Fee", or "Additional Bed Fee". |
| Boards/Options/Rooms/ Surcharges/Price | Price | Represents the price of this surcharge, including the amount and currency. See Price for details about the price structure. |
| Boards/Options/Rooms/ Surcharges/Price/Currency | Currency | The currency of the price, represented in ISO 4217 format (e.g., USD, EUR). |
| Boards/Options/Rooms/ Surcharges/Price/Binding | Boolean | Indicates whether the price is binding. |
| Boards/Options/Rooms/ Surcharges/Price/Net | Double | The net price paid by the Buyer to the Seller. |
| Boards/Options/Rooms/ Surcharges/Price/Gross | Double | The gross price, which includes the net price and the Buyer's commission. |
| Boards/Options/Rooms/ Surcharges/Price/NetSpecified | Boolean | Indicates whether the net price is explicitly specified. |
| Boards/Options/Rooms/ Surcharges/Price/ MinimumSellingPrice | Double | The minimum selling price. |
| Boards/Options/Rooms/ Surcharges/Code | String | An optional code that uniquely identifies this surcharge for internal or external reference. This can be useful for tracking specific fees or integrating with supplier systems. |
| Boards/Options/Rooms/ CancelPolicy | CancelPolicy | Cancellation policy specific to this room. |
| Boards/Options/Rooms/ CancelPolicy/Refundable | Boolean | Indicates whether the booking is refundable. |
| Boards/Options/Rooms/ CancelPolicy/CancelPenalties | Array<CancelPenalty> | A collection of penalties that apply if the booking is canceled. |
| Boards/Options/Rooms/ CancelPolicy/CancelPenalties/ HoursBefore | Integer | Indicates the number of hours before the check-in date when the penalty becomes applicable. |
| Boards/Options/Rooms/ CancelPolicy/CancelPenalties/ PenaltyType | PenaltyType | Specifies the type of penalty enforced upon cancellation. |
| Boards/Options/Rooms/ CancelPolicy/CancelPenalties/ Currency | Currency | Specifies the currency in which the penalty value is expressed. |
| Boards/Options/Rooms/ CancelPolicy/CancelPenalties/ Value | Double | Indicates the value of the penalty. |
| Boards/Options/Rooms/ CancelPolicy/CancelPenalties/ Deadline | String | Specifies the absolute deadline for the penalty in UTC format. |
| Boards/Options/Rooms/ CancelPolicy/ CancelPolicyDescription | String | Provides additional details or a textual summary of the cancellation policy. |
| Boards/Options/Rooms/Beds | Array<Bed> | List of beds available in the room, including types and configurations. |
| Boards/Options/Rooms/Beds/Type | String | The type of the bed. |
| Boards/Options/Rooms/Beds/ Description | String | A description of the bed. |
| Boards/Options/Rooms/Beds/ Count | Integer | The number of beds of this type in the room. |
| Boards/Options/Rooms/Beds/ Shared | Boolean | Indicates whether the bed is shared. |
| Boards/Options/Rooms/Amenities | Array<Amenity> | Amenities included with this room, such as Wi-Fi or parking. |
| Boards/Options/Rooms/Amenities/ Code | String | A unique code that identifies the amenity. |
| Boards/Options/Rooms/Amenities/ Type | AmenityType | The type of the amenity, defined by AmenityType. |
| Boards/Options/Rooms/Amenities/ Value | String | The value associated with the amenity. |
| Boards/Options/Rooms/Amenities/ Texts | String | Additional textual information or description for the amenity. |
| Boards/Options/Rooms/ UnitsSpecified | Boolean | Indicates whether the number of units has been explicitly specified. |
| Boards/Options/Rooms/Features | Array<Feature> | Features or custom attributes of the room, used for specific integrations. |
| Boards/Options/Rooms/Features/ Code | String | The unique code identifying the feature of the room. |
| Boards/Options/Parameters | Array<Parameter> | Parameters for transferring data between operations, such as from Search to Quote or Quote to Book. |
| Boards/Options/Parameters/Key | Integer | Identifies the parameter with a numeric key. |
| Boards/Options/Parameters/ Value | String | Defines the value associated with the parameter. |
| Boards/Options/Parameters/ ParameterType | ParameterType | Specifies the type of the parameter (ParameterType), whether it is internal or supplier-related. |
| Boards/Options/Parameters/ Immutable | Boolean | Indicates whether the parameter remains constant throughout operations (e.g., from Search to Quote and Book). In second searches or quotes, an immutable parameter is used to identify and match the same option. |
| Boards/Options/Parameters/ RoomId | Integer | Associates the parameter with a specific room, identified by its ID. |
| Boards/Options/CancelPolicy | OptionCancelPolicy | The cancellation policy associated with the option, detailing penalties and conditions. |
| Boards/Options/CancelPolicy/ Refundable | Boolean | Indicates whether the booking is refundable. |
| Boards/Options/CancelPolicy/ CancelPenalties | Array<CancelPenalty> | A collection of penalties that apply if the booking is canceled. |
| Boards/Options/CancelPolicy/ CancelPenalties/HoursBefore | Integer | Indicates the number of hours before the check-in date when the penalty becomes applicable. |
| Boards/Options/CancelPolicy/ CancelPenalties/PenaltyType | PenaltyType | Specifies the type of penalty enforced upon cancellation. |
| Boards/Options/CancelPolicy/ CancelPenalties/Currency | Currency | Specifies the currency in which the penalty value is expressed. |
| Boards/Options/CancelPolicy/ CancelPenalties/Value | Double | Indicates the value of the penalty. |
| Boards/Options/CancelPolicy/ CancelPenalties/Deadline | String | Specifies the absolute deadline for the penalty in UTC format. |
| Boards/Options/CancelPolicy/ CancelPolicyDescription | String | Provides additional details or a textual summary of the cancellation policy. |
| Boards/Options/CancelPolicy/ RoomCancelPolicyDescriptions | Array<RoomCancelPolicyDescriptions> | Gets or sets the list of room-specific cancellation policy descriptions. |
| Boards/Options/CancelPolicy/ RoomCancelPolicyDescriptions/ OccupancyRefId | Integer | Identifies the specific occupancy within the booking for which this cancellation policy applies. |
| Boards/Options/CancelPolicy/ RoomCancelPolicyDescriptions/ Description | String | Textual information detailing the cancellation policy applicable to the room associated with the OccupancyRefId. |
| Boards/Options/Promotions | Array<Promotion> | The promotions applied to the option, such as discounts or special offers. |
| Boards/Options/Promotions/Code | String | The unique code identifying the promotion. |
| Boards/Options/Promotions/Name | String | The name of the promotion. |
| Boards/Options/RateRules | Array<RateRule2> | The rate rules for the option, specifying sales restrictions such as "Senior Discount" or "Resident Rate." |
| Boards/Options/RateRules/ RateRuleType | RateRule | Selling restrictions applied to the room. These define specific conditions or eligibility requirements that must be met to sell the room. Possible restrictions include: |
| Boards/Options/RateRules/Code | String | Represents a unique identifier for the rate rule, typically defined by the supplier.This code is used to reference and distinguish the rule from others. |
| Boards/Options/RateRules/Name | String | Provides a human-readable name or label for the rate rule.This name is typically used in user interfaces or reports to describe the rule. |
| Boards/Options/RateRules/ Restrictions | Array<Restriction> | Defines a collection of additional restrictions that further specify the conditions of the rate rule.Restrictions can include age limits, regional requirements, or special eligibility conditions. |
| Boards/Options/RateRules/ Restrictions/Code | String | A unique identifier for the restriction. |
| Boards/Options/RateRules/ Restrictions/Name | String | A descriptive name for the restriction. |
| Boards/Options/RateRules/ Restrictions/RestrictionType | RestrictionType | The type of the restriction, categorizing its purpose or application. |
| Boards/Options/Remarks | Array<Remark> | Additional remarks associated with the option, such as special conditions or information. |
| Boards/Options/Remarks/ RemarkType | RemarkType | The type of the remark, categorized by RemarkType, specifies its nature or purpose. It may refer to the hotel as a whole, a specific room being booked, services provided by the accommodation, or general remarks not tied to any particular entity. |
| Boards/Options/Remarks/Text | String | The text content of the remark, providing details or additional notes.This can include supplier-specific instructions, conditions, or general information. |
| Boards/Options/Surcharges | Array<Surcharge> | Surcharges applied to the option, such as mandatory fees or taxes. |
| Boards/Options/Surcharges/ ChargeType | ChargeType | Specifies whether the surcharge is included in the room rate or must be paid separately at the property. See ChargeType for possible values. |
| Boards/Options/Surcharges/ Mandatory | Boolean | Indicates whether this surcharge is mandatory. Mandatory surcharges, such as government taxes, must always be paid, while optional surcharges may depend on the guest's preferences. |
| Boards/Options/Surcharges/ Description | String | Provides a description of the surcharge, giving context about the type of cost it represents.Examples: "Tourist Tax", "Resort Fee", or "Additional Bed Fee". |
| Boards/Options/Surcharges/ Price | Price | Represents the price of this surcharge, including the amount and currency. See Price for details about the price structure. |
| Boards/Options/Surcharges/ Price/Currency | Currency | The currency of the price, represented in ISO 4217 format (e.g., USD, EUR). |
| Boards/Options/Surcharges/ Price/Binding | Boolean | Indicates whether the price is binding. |
| Boards/Options/Surcharges/ Price/Net | Double | The net price paid by the Buyer to the Seller. |
| Boards/Options/Surcharges/ Price/Gross | Double | The gross price, which includes the net price and the Buyer's commission. |
| Boards/Options/Surcharges/ Price/NetSpecified | Boolean | Indicates whether the net price is explicitly specified. |
| Boards/Options/Surcharges/ Price/MinimumSellingPrice | Double | The minimum selling price. |
| Boards/Options/Surcharges/Code | String | An optional code that uniquely identifies this surcharge for internal or external reference. This can be useful for tracking specific fees or integrating with supplier systems. |
| Boards/Options/Amenities | Array<Amenity> | Amenities included with the option, such as "Free Wi-Fi" or "Parking." |
| Boards/Options/Amenities/Code | String | A unique code that identifies the amenity. |
| Boards/Options/Amenities/Type | AmenityType | The type of the amenity, defined by AmenityType. |
| Boards/Options/Amenities/Value | String | The value associated with the amenity. |
| Boards/Options/Amenities/Texts | String | Additional textual information or description for the amenity. |
| Boards/Options/Supplements | Array<Supplement> | Supplements available with the option, such as activity passes. |
| Boards/Options/Supplements/ Code | String | The unique code identifying the supplement. |
| Boards/Options/Supplements/ Name | String | The descriptive name of the supplement. |
| Boards/Options/Supplements/ Description | String | An optional textual description providing additional details about the supplement. |
| Boards/Options/Supplements/ Mandatory | Boolean | Indicates whether the supplement is mandatory for the booking. |
| Boards/Options/Supplements/ Price | Price | The Price associated with the supplement, including details such as currency and net price. |
| Boards/Options/Supplements/ Price/Currency | Currency | The currency of the price, represented in ISO 4217 format (e.g., USD, EUR). |
| Boards/Options/Supplements/ Price/Binding | Boolean | Indicates whether the price is binding. |
| Boards/Options/Supplements/ Price/Net | Double | The net price paid by the Buyer to the Seller. |
| Boards/Options/Supplements/ Price/Gross | Double | The gross price, which includes the net price and the Buyer's commission. |
| Boards/Options/Supplements/ Price/NetSpecified | Boolean | Indicates whether the net price is explicitly specified. |
| Boards/Options/Supplements/ Price/MinimumSellingPrice | Double | The minimum selling price. |
| Boards/Options/Supplements/ SupplementType | SupplementType | The specific SupplementType of the supplement (e.g., board, additional service). |
| Boards/Options/Supplements/ ChargeType | ChargeType | Defines how the supplement is charged using ChargeType (e.g., per person, per stay). |
| Boards/Options/Supplements/ DurationType | DurationType | Specifies whether the supplement applies to a specific duration (Open or Range). |
| Boards/Options/Supplements/ Quantity | Integer | The quantity of the supplement included in the booking. |
| Boards/Options/Supplements/ StartDate | String | The start date for the supplement (if applicable). |
| Boards/Options/Supplements/ StartDateAsDateTime | String | The start date as a DateTime object for easier manipulation. |
| Boards/Options/Supplements/ EndDate | String | The end date for the supplement (if applicable). |
| Boards/Options/Supplements/ EndDateAsDateTime | String | The end date as a DateTime object for easier manipulation. |
| Boards/Options/Supplements/ Resort | Resort | The associated Resort where the supplement applies. |
| Boards/Options/Supplements/ Resort/Code | String | Unique code that identifies the resort in the system. |
| Boards/Options/Supplements/ Resort/Name | String | Name of the resort. |
| Boards/Options/Supplements/ Resort/Description | String | Optional description providing additional details about the resort. |
| Boards/Options/Supplements/ Unit | UnitTimeType | Specifies the unit of time for the supplement (e.g., per day, per stay) using UnitTimeType. |
| Boards/Options/AddOns | Object | Internal field for passing additional information across layers. |
| Location | Location | Gets the geographical location of the hotel. |
| Location/Code | String | The unique code identifying the location. |
| Location/Country | String | The ISO 3166-1 alpha-2 country code where the location is situated. |
| Location/Longitude | Double | The longitude coordinate of the location, expressed in decimal degrees. |
| Location/Latitude | Double | The latitude coordinate of the location, expressed in decimal degrees. |