BookCriteria
Represents the criteria for booking a hotel accommodation. Inherits from Criteria.
Properties
| Name | Type | Description |
|---|---|---|
| CheckIn | String | The check-in date for the operation, represented as a string in ISO 8601 format (yyyy-MM-dd). |
| CheckOut | String | The check-out date for the operation, represented as a string in ISO 8601 format (yyyy-MM-dd). |
| CheckInAsDateTime | String | The check-in date parsed as a DateTime object. |
| CheckOutAsDateTime | String | The check-out date parsed as a DateTime object. |
| TotalNights | Integer | The total number of nights for the stay, calculated as the difference between check-in and check-out dates. |
| Language | String | The language code for the operation, represented as a 2-character ISO 639-1 code (e.g., "en", "es"). |
| Currency | Currency | The preferred currency for the operation, defined as an optional Currency value. |
| Nationality | String | The nationality code of the client, represented as a 2-character ISO 3166-1 alpha-2 country code (e.g., "US", "FR"). |
| Accommodation | AccommodationRQ | Accommodation details for the quote request, such as the hotel or rental being evaluated. |
| Accommodation/Type | AccommodationType | Specifies the type of accommodation being requested, such as Hotel or Rental. |
| Accommodation/Code | String | Represents a unique code identifying the accommodation in the request. |
| BoardCode | String | Gets the board code for the booking. |
| Occupancies | Array<BookOccupancy> | Gets the occupancies for the booking. |
| Occupancies/OccupancyId | Integer | The unique identifier for the occupancy. |
| Occupancies/Paxes | Array<BookPaxInput> | The collection of passenger inputs (paxes) for the occupancy. |
| Occupancies/Paxes/Age | Integer | The age of the passenger. |
| Occupancies/Paxes/Name | String | The first name of the passenger. |
| Occupancies/Paxes/SurName | String | The surname (last name) of the passenger. |
| Occupancies/Paxes PersonalTitleType | PersonalTitleType | The personal title type of the passenger. |
| Market | String | Gets or sets the market for the booking. |
| Rooms | Array<Room> | Gets the rooms for the booking. |
| Rooms/OccupancyRefId | Integer | Numeric ID linking this room to its occupancy data in the Occupancy. |
| Rooms/Code | String | Unique code assigned to this room. |
| Rooms/Description | String | Description of the room's features or characteristics. |
| Rooms/RoomPrice | RoomPrice | Pricing information for the room, including total price and currency details. |
| Rooms/RoomPrice/Price | Price | The total price of the room. |
| Rooms/RoomPrice/Price/Currency | Currency | The currency of the price, represented in ISO 4217 format (e.g., USD, EUR). |
| Rooms/RoomPrice/Price/Binding | Boolean | Indicates whether the price is binding. |
| Rooms/RoomPrice/Price/Net | Double | The net price paid by the buyer to the seller. |
| Rooms/RoomPrice/Price/Gross | Double | The gross price, which includes the net price and the buyer's commission. |
| Rooms/RoomPrice/Price NetSpecified | Boolean | Indicates whether the net price is explicitly specified. |
| Rooms/RoomPrice/Price MinimumSellingPrice | Double | The minimum selling price. |
| Rooms/RoomPrice/PriceBreakdown | Array<PriceBreakdown> | Breakdown of the room price over specific periods, such as daily rates. |
| Rooms/RoomPrice/PriceBreakdown Price | Price | The price for each day of the room during the specified period. |
| Rooms/RoomPrice/PriceBreakdown Price/Currency | Currency | The currency of the price, represented in ISO 4217 format (e.g., USD, EUR). |
| Rooms/RoomPrice/PriceBreakdown Price/Binding | Boolean | Indicates whether the price is binding. |
| Rooms/RoomPrice/PriceBreakdown Price/Net | Double | The net price paid by the buyer to the seller. |
| Rooms/RoomPrice/PriceBreakdown Price/Gross | Double | The gross price, which includes the net price and the buyer's commission. |
| Rooms/RoomPrice/PriceBreakdown Price/NetSpecified | Boolean | Indicates whether the net price is explicitly specified. |
| Rooms/RoomPrice/PriceBreakdown Price/MinimumSellingPrice | Double | The minimum selling price. |
| Rooms/RoomPrice/PriceBreakdown Start | Integer | The starting day of the pricing period (inclusive). |
| Rooms/RoomPrice/PriceBreakdown End | Integer | The ending day of the pricing period (inclusive). |
| Rooms/Refundable | Boolean | Indicates if the room is refundable based on the cancellation policy. |
| Rooms/RefundableSpecified | Boolean | Indicates whether the refundable status has been explicitly specified. |
| Rooms/LegacyRoomId | String | Legacy identifier for internal tracking. Automatically generated using OccupancyRefId and Code. |
| Rooms/Units | Integer | Number of units available for this room type. |
| Rooms/RatePlan | RatePlan | Rate plan associated with this room. |
| Rooms/RatePlan/Code | String | The unique code for the rate plan. |
| Rooms/RatePlan/Name | String | The name of the rate plan. |
| Rooms/Promotions | Array<Promotion> | Promotions or discounts applicable to this room. |
| Rooms/Promotions/Code | String | The unique code identifying the promotion. |
| Rooms/Promotions/Name | String | The name of the promotion. |
| Rooms/Remarks | Array<Remark> | Additional remarks or notes about this room. |
| Rooms/Remarks/RemarkType | RemarkType | The 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/Text | String | The text content of the remark, providing details or additional notes.This can include supplier-specific instructions, conditions, or general information. |
| Rooms/Surcharges | Array<Surcharge> | Additional surcharges applied to this room. |
| 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. |
| 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. |
| 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". |
| Rooms/Surcharges/Price | Price | Represents the price of this surcharge, including the amount and currency. See Price for details about the price structure. |
| Rooms/Surcharges/Price Currency | Currency | The currency of the price, represented in ISO 4217 format (e.g., USD, EUR). |
| Rooms/Surcharges/Price/Binding | Boolean | Indicates whether the price is binding. |
| Rooms/Surcharges/Price/Net | Double | The net price paid by the buyer to the seller. |
| Rooms/Surcharges/Price/Gross | Double | The gross price, which includes the net price and the buyer's commission. |
| Rooms/Surcharges/Price NetSpecified | Boolean | Indicates whether the net price is explicitly specified. |
| Rooms/Surcharges/Price MinimumSellingPrice | Double | The minimum selling price. |
| 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. |
| Rooms/CancelPolicy | CancelPolicy | Cancellation policy specific to this room. |
| Rooms/CancelPolicy/Refundable | Boolean | Indicates 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 | Integer | Indicates the number of hours before the check-in date when the penalty becomes applicable. |
| Rooms/CancelPolicy CancelPenalties/PenaltyType | PenaltyType | Specifies the type of penalty enforced upon cancellation. |
| Rooms/CancelPolicy CancelPenalties/Currency | Currency | Specifies the currency in which the penalty value is expressed. |
| Rooms/CancelPolicy CancelPenalties/Value | Double | Indicates the value of the penalty. |
| Rooms/CancelPolicy CancelPenalties/Deadline | String | Specifies the absolute deadline for the penalty in UTC format. |
| Rooms/CancelPolicy CancelPolicyDescription | String | Provides additional details or a textual summary of the cancellation policy. |
| Rooms/Beds | Array<Bed> | List of beds available in the room, including types and configurations. |
| Rooms/Beds/Type | String | The type of the bed. |
| Rooms/Beds/Description | String | A description of the bed. |
| Rooms/Beds/Count | Integer | The number of beds of this type in the room. |
| Rooms/Beds/Shared | Boolean | Indicates whether the bed is shared. |
| Rooms/Amenities | Array<Amenity> | Amenities included with this room, such as Wi-Fi or parking. |
| Rooms/Amenities/Code | String | A unique code that identifies the amenity. |
| Rooms/Amenities/Type | AmenityType | The type of the amenity, defined by AmenityType. |
| Rooms/Amenities/Value | String | The value associated with the amenity. |
| Rooms/Amenities/Texts | String | Additional textual information or description for the amenity. |
| Rooms/UnitsSpecified | Boolean | Indicates whether the number of units has been explicitly specified. |
| Rooms/Features | Array<Feature> | Features or custom attributes of the room, used for specific integrations. |
| Rooms/Features/Code | String | The unique code identifying the feature of the room. |
| PaymentType | PaymentType | Gets the payment type for the booking. |
| Remarks | Array<Remark> | Gets the remarks for the booking. |
| Remarks/RemarkType | RemarkType | The 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. |
| Remarks/Text | String | The text content of the remark, providing details or additional notes.This can include supplier-specific instructions, conditions, or general information. |
| ClientReference | String | Gets the client reference for the booking. |
| BookPrice | BookPrice | Gets the book price for the booking. |
| BookPrice/Price | Price | The price of the booking. |
| BookPrice/Price/Currency | Currency | The currency of the price, represented in ISO 4217 format (e.g., USD, EUR). |
| BookPrice/Price/Binding | Boolean | Indicates whether the price is binding. |
| BookPrice/Price/Net | Double | The net price paid by the buyer to the seller. |
| BookPrice/Price/Gross | Double | The gross price, which includes the net price and the buyer's commission. |
| BookPrice/Price/NetSpecified | Boolean | Indicates whether the net price is explicitly specified. |
| BookPrice/Price MinimumSellingPrice | Double | The minimum selling price. |
| BookPrice/DeltaPrice | DeltaPrice | The delta price, representing any allowable price changes or adjustments. |
| BookPrice/DeltaPrice/Amount | Double | The fixed amount allowed for the delta price. |
| BookPrice/DeltaPrice Percentage | Double | The percentage allowed for the delta price. |
| Holder | Holder | Gets or sets the holder information for the booking. |
| Holder/Name | String | The name of the holder. |
| Holder/SurName | String | The surname of the holder. |
| Holder/PersonalTitleType | PersonalTitleType | The personal title type of the holder. |
| Holder/ContactInfo | ContactInfo | The contact information of the holder. |
| Holder/ContactInfo/Email | String | The email address of the passenger. |
| Holder/ContactInfo/Phone | String | The phone number of the passenger. |
| PaymentCardInput | CreditCardInput | Gets the payment card input for the booking. |
| PaymentCardInput/Type | CreditCardType | The type of the credit card. |
| PaymentCardInput/Number | String | The credit card number. |
| PaymentCardInput/Cvc | String | The Card Verification Code (CVC) of the credit card. |
| PaymentCardInput/Expiration | CreditCardExpiration | The expiration date of the credit card. |
| PaymentCardInput/Expiration Month | Integer | The expiration month of the credit card. |
| PaymentCardInput/Expiration Year | Integer | The expiration year of the credit card (last two digits). |
| PaymentCardInput/Expiration YearFull | Integer | Gets the full four-digit year of the credit card expiration. |
| PaymentCardInput/IsVcc | Boolean | Indicates whether the credit card is a Virtual Credit Card (VCC). |
| PaymentCardInput/Holder | Holder | The holder information of the credit card. |
| PaymentCardInput/Holder/Name | String | The name of the holder. |
| PaymentCardInput/Holder SurName | String | The surname of the holder. |
| PaymentCardInput/Holder PersonalTitleType | PersonalTitleType | The personal title type of the holder. |
| PaymentCardInput/Holder ContactInfo | ContactInfo | The contact information of the holder. |
| PaymentCardInput/Holder ContactInfo/Email | String | The email address of the passenger. |
| PaymentCardInput/Holder ContactInfo/Phone | String | The phone number of the passenger. |
| PaymentCardInput VirtualCreditCard | VirtualCreditCard | The virtual credit card information, if applicable. |
| PaymentCardInput VirtualCreditCard VCCActivationDate | String | Gets or sets the activation date of the virtual credit card. |
| PaymentCardInput VirtualCreditCard VCCDeactivationDate | String | Gets or sets the deactivation date of the virtual credit card. |
| PaymentCardInput VirtualCreditCard VCCCurrentBalance | Double | Gets or sets the current balance of the virtual credit card. |
| PaymentCardInput VirtualCreditCard VCCCurrencyCode | String | Gets or sets the currency code for the virtual credit card balance. |
| PaymentCardInput ThreeDomainSecurity | ThreeDomainSecurity | The 3-D Secure authentication information for the credit card transaction. |
| PaymentCardInput ThreeDomainSecurity ThreeDSVersion | String | Gets or sets the version of 3-D Secure protocol used. |
| PaymentCardInput ThreeDomainSecurity DSTransactionID | String | Gets or sets the Directory Server Transaction ID. |
| PaymentCardInput ThreeDomainSecurity/XID | String | Gets or sets the transaction identifier for 3-D Secure. |
| PaymentCardInput ThreeDomainSecurity/ECI | String | Gets or sets the Electronic Commerce Indicator. |
| PaymentCardInput ThreeDomainSecurity/CAVV | String | Gets or sets the Cardholder Authentication Verification Value. |
| PaymentCardInput ThreeDomainSecurity/PARes | String | Gets or sets the Payer Authentication Response. |
| PaymentCardInput ThreeDomainSecurity PAResStatus | PAResStatus | Gets or sets the status of the Payer Authentication Response. |
| PaymentCardInput ThreeDomainSecurity CardEnrolledStatus | EnrolledStatus | Gets or sets the enrollment status of the card in 3-D Secure. |
| PaymentCardInput ThreeDomainSecurity MerchantName | String | Gets or sets the name of the merchant. |
| PaymentCardInput ThreeDomainSecurity SignatureStatus | SignatureStatus | Gets or sets the status of the signature in the 3-D Secure process. |
| PaymentCardInput/UrlPayment | UrlPayment | The URL payment information for the credit card transaction. |
| PaymentCardInput/UrlPayment Url | String | Gets or sets the URL for the payment. |
| Parameters | Array<Parameter> | Gets or sets the additional parameters for the booking. |
| Parameters/Key | Integer | Identifies the parameter with a numeric key. |
| Parameters/Value | String | Defines the value associated with the parameter. |
| Parameters/ParameterType | ParameterType | Specifies the type of the parameter (ParameterType), whether it is internal or supplier-related. |
| 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. |
| Parameters/RoomId | Integer | Associates the parameter with a specific room, identified by its ID. |