Skip to main content

BookCriteria

Represents the criteria for booking a hotel accommodation. Inherits from Criteria.

Properties

NameTypeDescription
CheckInStringThe check-in date for the operation, represented as a string in ISO 8601 format (YYYY-MM-DD).
CheckOutStringThe check-out date for the operation, represented as a string in ISO 8601 format (YYYY-MM-DD).
CheckInAsDateTimeStringThe check-in date parsed as a DateTime object.
CheckOutAsDateTimeStringThe check-out date parsed as a DateTime object.
TotalNightsIntegerThe total number of nights for the stay, calculated as the difference between check-in and check-out dates.
LanguageStringThe language code for the operation, represented as a 2-character ISO 639-1 code (e.g., "en", "es").
CurrencyCurrencyThe preferred currency for the operation, defined as an optional Currency value.
NationalityStringThe nationality code of the client, represented as a 2-character ISO 3166-1 alpha-2 country code (e.g., "US", "FR").
AccommodationAccommodationRQAccommodation details for the Quote request, such as the hotel or rental being evaluated.
Accommodation/TypeAccommodationTypeSpecifies the type of accommodation being requested, such as Hotel or Rental.
Accommodation/CodeStringRepresents a unique code identifying the accommodation in the request.
BoardCodeStringGets the board code for the booking.
OccupanciesArray<BookOccupancy>Gets the occupancies for 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.
MarketStringGets or sets the market for the booking.
RoomsArray<Room>Gets the rooms for 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, 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.
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.
PaymentTypePaymentTypeGets the payment type for the booking.
RemarksArray<Remark>Gets the remarks for the booking.
Remarks/RemarkTypeRemarkTypeThe 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.
Remarks/TextStringThe text content of the remark, providing details or additional notes.This can include supplier-specific instructions, conditions, or general information.
ClientReferenceStringGets the client reference for the booking.
BookPriceBookPriceGets the book price for the booking.
BookPrice/PricePriceThe price of the booking.
BookPrice/Price/CurrencyCurrencyThe currency of the price, represented in ISO 4217 format (e.g., USD, EUR).
BookPrice/Price/BindingBooleanIndicates whether the price is binding.
BookPrice/Price/NetDoubleThe net price paid by the Buyer to the Seller.
BookPrice/Price/GrossDoubleThe gross price, which includes the net price and the Buyer's commission.
BookPrice/Price/NetSpecifiedBooleanIndicates whether the net price is explicitly specified.
BookPrice/Price/
MinimumSellingPrice
DoubleThe minimum selling price.
BookPrice/DeltaPriceDeltaPriceThe delta price, representing any allowable price changes or adjustments.
BookPrice/DeltaPrice/AmountDoubleThe fixed amount allowed for the delta price.
BookPrice/DeltaPrice/
Percentage
DoubleThe percentage allowed for the delta price.
HolderHolderGets or sets the holder information for the booking.
Holder/NameStringThe name of the holder.
Holder/SurNameStringThe surname of the holder.
Holder/PersonalTitleTypePersonalTitleTypeThe personal title type of the holder.
Holder/ContactInfoContactInfoThe contact information of the holder.
Holder/ContactInfo/EmailStringThe email address of the passenger.
Holder/ContactInfo/PhoneStringThe phone number of the passenger.
PaymentCardInputCreditCardInputGets the payment card input for the booking.
PaymentCardInput/TypeCreditCardTypeThe type of the credit card.
PaymentCardInput/NumberStringThe credit card number.
PaymentCardInput/CvcStringThe Card Verification Code (CVC) of the credit card.
PaymentCardInput/ExpirationCreditCardExpirationThe expiration date of the credit card.
PaymentCardInput/Expiration/
Month
IntegerThe expiration month of the credit card.
PaymentCardInput/Expiration/
Year
IntegerThe expiration year of the credit card (last two digits).
PaymentCardInput/Expiration/
YearFull
IntegerGets the full four-digit year of the credit card expiration.
PaymentCardInput/IsVccBooleanIndicates whether the credit card is a Virtual Credit Card (VCC).
PaymentCardInput/HolderHolderThe holder information of the credit card.
PaymentCardInput/Holder/NameStringThe name of the holder.
PaymentCardInput/Holder/
SurName
StringThe surname of the holder.
PaymentCardInput/Holder/
PersonalTitleType
PersonalTitleTypeThe personal title type of the holder.
PaymentCardInput/Holder/
ContactInfo
ContactInfoThe contact information of the holder.
PaymentCardInput/Holder/
ContactInfo/Email
StringThe email address of the passenger.
PaymentCardInput/Holder/
ContactInfo/Phone
StringThe phone number of the passenger.
PaymentCardInput/
VirtualCreditCard
VirtualCreditCardThe virtual credit card information, if applicable.
PaymentCardInput/
VirtualCreditCard/
VCCActivationDate
StringGets or sets the activation date of the virtual credit card.
PaymentCardInput/
VirtualCreditCard/
VCCDeactivationDate
StringGets or sets the deactivation date of the virtual credit card.
PaymentCardInput/
VirtualCreditCard/
VCCCurrentBalance
DoubleGets or sets the current balance of the virtual credit card.
PaymentCardInput/
VirtualCreditCard/
VCCCurrencyCode
StringGets or sets the currency code for the virtual credit card balance.
PaymentCardInput/
ThreeDomainSecurity
ThreeDomainSecurityThe 3-D Secure authentication information for the credit card transaction.
PaymentCardInput/
ThreeDomainSecurity/
ThreeDSVersion
StringGets or sets the version of 3-D Secure protocol used.
PaymentCardInput/
ThreeDomainSecurity/
DSTransactionID
StringGets or sets the Directory Server Transaction ID.
PaymentCardInput/
ThreeDomainSecurity/XID
StringGets or sets the transaction identifier for 3-D Secure.
PaymentCardInput/
ThreeDomainSecurity/ECI
StringGets or sets the Electronic Commerce Indicator.
PaymentCardInput/
ThreeDomainSecurity/CAVV
StringGets or sets the Cardholder Authentication Verification Value.
PaymentCardInput/
ThreeDomainSecurity/PARes
StringGets or sets the Payer Authentication Response.
PaymentCardInput/
ThreeDomainSecurity/
PAResStatus
PAResStatusGets or sets the status of the Payer Authentication Response.
PaymentCardInput/
ThreeDomainSecurity/
CardEnrolledStatus
EnrolledStatusGets or sets the enrollment status of the card in 3-D Secure.
PaymentCardInput/
ThreeDomainSecurity/
MerchantName
StringGets or sets the name of the merchant.
PaymentCardInput/
ThreeDomainSecurity/
SignatureStatus
SignatureStatusGets or sets the status of the signature in the 3-D Secure process.
PaymentCardInput/UrlPaymentUrlPaymentThe URL payment information for the credit card transaction.
PaymentCardInput/UrlPayment/
Url
StringGets or sets the URL for the payment.
ParametersArray<Parameter>Gets or sets the additional parameters for the booking.
Parameters/KeyIntegerIdentifies the parameter with a numeric key.
Parameters/ValueStringDefines the value associated with the parameter.
Parameters/ParameterTypeParameterTypeSpecifies the type of the parameter (ParameterType), whether it is internal or supplier-related.
Parameters/ImmutableBooleanIndicates 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.
Parameters/RoomIdIntegerAssociates the parameter with a specific room, identified by its ID.