Skip to main content

HotelDetail

Represents detailed information about a hotel booking.

Properties

NameTypeDescription
BookingDateStringThe date when the booking was created.
CheckInStringThe check-in date for the booking.
CheckOutStringThe check-out date for the booking.
CheckInAsDateTimeStringThe check-in date as a DateTime object.
CheckOutAsDateTimeStringThe check-out date as a DateTime object.
HotelCodeStringThe unique code identifying the hotel.
HotelNameStringThe name of the hotel associated with the booking.
BoardCodeStringThe board code for the booking.
OccupanciesArray<BookOccupancy>The collection of occupancies associated with the booking.
Occupancies/OccupancyIdIntegerThe unique identifier for the occupancy.
Occupancies/PaxesArray<BookPaxInput>The collection of passenger inputs (paxes) for the occupancy.
Occupancies/Paxes/AgeIntegerThe age of the passenger.
Occupancies/Paxes/NameStringThe first name of the passenger.
Occupancies/Paxes/SurNameStringThe surname (last name) of the passenger.
Occupancies/Paxes
PersonalTitleType
PersonalTitleTypeThe personal title type of the passenger.
RoomsArray<Room>The collection of rooms included in the booking.
Rooms/OccupancyRefIdIntegerNumeric ID linking this room to its occupancy data in the Occupancy.
Rooms/CodeStringUnique code assigned to this room.
Rooms/DescriptionStringDescription of the room's features or characteristics.
Rooms/RoomPriceRoomPricePricing information for the room, including total price and currency details.
Rooms/RoomPrice/PricePriceThe total price of the room.
Rooms/RoomPrice/Price/CurrencyCurrencyThe currency of the price, represented in ISO 4217 format (e.g., USD, EUR).
Rooms/RoomPrice/Price/BindingBooleanIndicates whether the price is binding.
Rooms/RoomPrice/Price/NetDoubleThe net price paid by the buyer to the seller.
Rooms/RoomPrice/Price/GrossDoubleThe gross price, which includes the net price and the buyer's commission.
Rooms/RoomPrice/Price
NetSpecified
BooleanIndicates whether the net price is explicitly specified.
Rooms/RoomPrice/Price
MinimumSellingPrice
DoubleThe minimum selling price.
Rooms/RoomPrice/PriceBreakdownArray<PriceBreakdown>Breakdown of the room price over specific periods, such as daily rates.
Rooms/RoomPrice/PriceBreakdown
Price
PriceThe price for each day of the room during the specified period.
Rooms/RoomPrice/PriceBreakdown
Price/Currency
CurrencyThe currency of the price, represented in ISO 4217 format (e.g., USD, EUR).
Rooms/RoomPrice/PriceBreakdown
Price/Binding
BooleanIndicates whether the price is binding.
Rooms/RoomPrice/PriceBreakdown
Price/Net
DoubleThe net price paid by the buyer to the seller.
Rooms/RoomPrice/PriceBreakdown
Price/Gross
DoubleThe gross price, which includes the net price and the buyer's commission.
Rooms/RoomPrice/PriceBreakdown
Price/NetSpecified
BooleanIndicates whether the net price is explicitly specified.
Rooms/RoomPrice/PriceBreakdown
Price/MinimumSellingPrice
DoubleThe minimum selling price.
Rooms/RoomPrice/PriceBreakdown
Start
IntegerThe starting day of the pricing period (inclusive).
Rooms/RoomPrice/PriceBreakdown
End
IntegerThe ending day of the pricing period (inclusive).
Rooms/RefundableBooleanIndicates if the room is refundable based on the cancellation policy.
Rooms/RefundableSpecifiedBooleanIndicates whether the refundable status has been explicitly specified.
Rooms/LegacyRoomIdStringLegacy identifier for internal tracking. Automatically generated using OccupancyRefId and Code.
Rooms/UnitsIntegerNumber of units available for this room type.
Rooms/RatePlanRatePlanRate plan associated with this room.
Rooms/RatePlan/CodeStringThe unique code for the rate plan.
Rooms/RatePlan/NameStringThe name of the rate plan.
Rooms/PromotionsArray<Promotion>Promotions or discounts applicable to this room.
Rooms/Promotions/CodeStringThe unique code identifying the promotion.
Rooms/Promotions/NameStringThe name of the promotion.
Rooms/RemarksArray<Remark>Additional remarks or notes about this room.
Rooms/Remarks/RemarkTypeRemarkTypeThe type of the remark, categorized by RemarkType.This specifies the nature or purpose of the remark: Related to the hotel as a whole. Specific to the room being booked. Related to services provided by the accommodation. General remarks not tied to a specific entity.
Rooms/Remarks/TextStringThe text content of the remark, providing details or additional notes.This can include supplier-specific instructions, conditions, or general information.
Rooms/SurchargesArray<Surcharge>Additional surcharges applied to this room.
Rooms/Surcharges/ChargeTypeChargeTypeSpecifies whether the surcharge is included in the room rate or must be paid separately at the property. See ChargeType for possible values.
Rooms/Surcharges/MandatoryBooleanIndicates 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.
Rooms/Surcharges/DescriptionStringProvides a description of the surcharge, giving context about the type of cost it represents.Examples: "Tourist Tax", "Resort Fee", or "Additional Bed Fee".
Rooms/Surcharges/PricePriceRepresents the price of this surcharge, including the amount and currency. See Price for details about the price structure.
Rooms/Surcharges/Price
Currency
CurrencyThe currency of the price, represented in ISO 4217 format (e.g., USD, EUR).
Rooms/Surcharges/Price/BindingBooleanIndicates whether the price is binding.
Rooms/Surcharges/Price/NetDoubleThe net price paid by the buyer to the seller.
Rooms/Surcharges/Price/GrossDoubleThe gross price, which includes the net price and the buyer's commission.
Rooms/Surcharges/Price
NetSpecified
BooleanIndicates whether the net price is explicitly specified.
Rooms/Surcharges/Price
MinimumSellingPrice
DoubleThe minimum selling price.
Rooms/Surcharges/CodeStringAn 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.
Rooms/CancelPolicyCancelPolicyCancellation policy specific to this room.
Rooms/CancelPolicy/RefundableBooleanIndicates whether the booking is refundable.
Rooms/CancelPolicy
CancelPenalties
Array<CancelPenalty>A collection of penalties that apply if the booking is canceled.
Rooms/CancelPolicy
CancelPenalties/HoursBefore
IntegerIndicates the number of hours before the check-in date when the penalty becomes applicable.
Rooms/CancelPolicy
CancelPenalties/PenaltyType
PenaltyTypeSpecifies the type of penalty enforced upon cancellation.
Rooms/CancelPolicy
CancelPenalties/Currency
CurrencySpecifies the currency in which the penalty value is expressed.
Rooms/CancelPolicy
CancelPenalties/Value
DoubleIndicates the value of the penalty.
Rooms/CancelPolicy
CancelPenalties/Deadline
StringSpecifies the absolute deadline for the penalty in UTC format.
Rooms/CancelPolicy
CancelPolicyDescription
StringProvides additional details or a textual summary of the cancellation policy.
Rooms/BedsArray<Bed>List of beds available in the room, including types and configurations.
Rooms/Beds/TypeStringThe type of the bed.
Rooms/Beds/DescriptionStringA description of the bed.
Rooms/Beds/CountIntegerThe number of beds of this type in the room.
Rooms/Beds/SharedBooleanIndicates whether the bed is shared.
Rooms/AmenitiesArray<Amenity>Amenities included with this room, such as Wi-Fi or parking.
Rooms/Amenities/CodeStringA unique code that identifies the amenity.
Rooms/Amenities/TypeAmenityTypeThe type of the amenity, defined by AmenityType.
Rooms/Amenities/ValueStringThe value associated with the amenity.
Rooms/Amenities/TextsStringAdditional textual information or description for the amenity.
Rooms/UnitsSpecifiedBooleanIndicates whether the number of units has been explicitly specified.
Rooms/FeaturesArray<Feature>Features or custom attributes of the room, used for specific integrations.
Rooms/Features/CodeStringThe unique code identifying the feature of the room.