BookRq
Represents a hotel booking request.
Properties
| Name | Type | Description |
|---|---|---|
| BookCriteria | BookCriteria | The booking criteria for the hotel reservation. |
| BookCriteria/CheckIn | String | The check-in date for the operation, represented as a string in ISO 8601 format (YYYY-MM-DD). |
| BookCriteria/CheckOut | String | The check-out date for the operation, represented as a string in ISO 8601 format (YYYY-MM-DD). |
| BookCriteria/CheckInAsDateTime | String | The check-in date parsed as a DateTime object. |
| BookCriteria/ CheckOutAsDateTime | String | The check-out date parsed as a DateTime object. |
| BookCriteria/TotalNights | Integer | The total number of nights for the stay, calculated as the difference between check-in and check-out dates. |
| BookCriteria/Language | String | The language code for the operation, represented as a 2-character ISO 639-1 code (e.g., "en", "es"). |
| BookCriteria/Currency | Currency | The preferred currency for the operation, defined as an optional Currency value. |
| BookCriteria/Nationality | String | The nationality code of the client, represented as a 2-character ISO 3166-1 alpha-2 country code (e.g., "US", "FR"). |
| BookCriteria/Accommodation | AccommodationRQ | Accommodation details for the Quote request, such as the hotel or rental being evaluated. |
| BookCriteria/Accommodation/ Type | AccommodationType | Specifies the type of accommodation being requested, such as Hotel or Rental. |
| BookCriteria/Accommodation/ Code | String | Represents a unique code identifying the accommodation in the request. |
| BookCriteria/BoardCode | String | Gets the board code for the booking. |
| BookCriteria/Occupancies | Array<BookOccupancy> | Gets the occupancies for the booking. |
| BookCriteria/Occupancies/ OccupancyId | Integer | The unique identifier for the occupancy. |
| BookCriteria/Occupancies/Paxes | Array<BookPaxInput> | The collection of passenger inputs (paxes) for the occupancy. |
| BookCriteria/Occupancies/Paxes/ Age | Integer | The age of the passenger. |
| BookCriteria/Occupancies/Paxes/ Name | String | The first name of the passenger. |
| BookCriteria/Occupancies/Paxes/ SurName | String | The surname (last name) of the passenger. |
| BookCriteria/Occupancies/Paxes/ PersonalTitleType | PersonalTitleType | The personal title type of the passenger. |
| BookCriteria/Market | String | Gets or sets the market for the booking. |
| BookCriteria/Rooms | Array<Room> | Gets the rooms for the booking. |
| BookCriteria/Rooms/ OccupancyRefId | Integer | Numeric ID linking this room to its occupancy data in the Occupancy. |
| BookCriteria/Rooms/Code | String | Unique code assigned to this room. |
| BookCriteria/Rooms/Description | String | Description of the room's features or characteristics. |
| BookCriteria/Rooms/RoomPrice | RoomPrice | Pricing information for the room, including total price and currency details. |
| BookCriteria/Rooms/RoomPrice/ Price | Price | The total price of the room. |
| BookCriteria/Rooms/RoomPrice/ Price/Currency | Currency | The currency of the price, represented in ISO 4217 format (e.g., USD, EUR). |
| BookCriteria/Rooms/RoomPrice/ Price/Binding | Boolean | Indicates whether the price is binding. |
| BookCriteria/Rooms/RoomPrice/ Price/Net | Double | The net price paid by the Buyer to the Seller. |
| BookCriteria/Rooms/RoomPrice/ Price/Gross | Double | The gross price, which includes the net price and the Buyer's commission. |
| BookCriteria/Rooms/RoomPrice/ Price/NetSpecified | Boolean | Indicates whether the net price is explicitly specified. |
| BookCriteria/Rooms/RoomPrice/ Price/MinimumSellingPrice | Double | The minimum selling price. |
| BookCriteria/Rooms/RoomPrice/ PriceBreakdown | Array<PriceBreakdown> | Breakdown of the room price over specific periods, such as daily rates. |
| BookCriteria/Rooms/RoomPrice/ PriceBreakdown/Price | Price | The price for each day of the room during the specified period. |
| BookCriteria/Rooms/RoomPrice/ PriceBreakdown/Price/Currency | Currency | The currency of the price, represented in ISO 4217 format (e.g., USD, EUR). |
| BookCriteria/Rooms/RoomPrice/ PriceBreakdown/Price/Binding | Boolean | Indicates whether the price is binding. |
| BookCriteria/Rooms/RoomPrice/ PriceBreakdown/Price/Net | Double | The net price paid by the Buyer to the Seller. |
| BookCriteria/Rooms/RoomPrice/ PriceBreakdown/Price/Gross | Double | The gross price, which includes the net price and the Buyer's commission. |
| BookCriteria/Rooms/RoomPrice/ PriceBreakdown/Price/ NetSpecified | Boolean | Indicates whether the net price is explicitly specified. |
| BookCriteria/Rooms/RoomPrice/ PriceBreakdown/Price/ MinimumSellingPrice | Double | The minimum selling price. |
| BookCriteria/Rooms/RoomPrice/ PriceBreakdown/Start | Integer | The starting day of the pricing period (inclusive). |
| BookCriteria/Rooms/RoomPrice/ PriceBreakdown/End | Integer | The ending day of the pricing period (inclusive). |
| BookCriteria/Rooms/Refundable | Boolean | Indicates if the room is refundable based on the cancellation policy. |
| BookCriteria/Rooms/ RefundableSpecified | Boolean | Indicates whether the refundable status has been explicitly specified. |
| BookCriteria/Rooms/ LegacyRoomId | String | Legacy identifier for internal tracking. Automatically generated using OccupancyRefId and Code. |
| BookCriteria/Rooms/Units | Integer | Number of units available for this room type. |
| BookCriteria/Rooms/RatePlan | RatePlan | Rate plan associated with this room. |
| BookCriteria/Rooms/RatePlan/ Code | String | The unique code for the rate plan. |
| BookCriteria/Rooms/RatePlan/ Name | String | The name of the rate plan. |
| BookCriteria/Rooms/Promotions | Array<Promotion> | Promotions or discounts applicable to this room. |
| BookCriteria/Rooms/Promotions/ Code | String | The unique code identifying the promotion. |
| BookCriteria/Rooms/Promotions/ Name | String | The name of the promotion. |
| BookCriteria/Rooms/Remarks | Array<Remark> | Additional remarks or notes about this room. |
| BookCriteria/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. |
| BookCriteria/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. |
| BookCriteria/Rooms/Surcharges | Array<Surcharge> | Additional surcharges applied to this room. |
| BookCriteria/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. |
| BookCriteria/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. |
| BookCriteria/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". |
| BookCriteria/Rooms/Surcharges/ Price | Price | Represents the price of this surcharge, including the amount and currency. See Price for details about the price structure. |
| BookCriteria/Rooms/Surcharges/ Price/Currency | Currency | The currency of the price, represented in ISO 4217 format (e.g., USD, EUR). |
| BookCriteria/Rooms/Surcharges/ Price/Binding | Boolean | Indicates whether the price is binding. |
| BookCriteria/Rooms/Surcharges/ Price/Net | Double | The net price paid by the Buyer to the Seller. |
| BookCriteria/Rooms/Surcharges/ Price/Gross | Double | The gross price, which includes the net price and the Buyer's commission. |
| BookCriteria/Rooms/Surcharges/ Price/NetSpecified | Boolean | Indicates whether the net price is explicitly specified. |
| BookCriteria/Rooms/Surcharges/ Price/MinimumSellingPrice | Double | The minimum selling price. |
| BookCriteria/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. |
| BookCriteria/Rooms/ CancelPolicy | CancelPolicy | Cancellation policy specific to this room. |
| BookCriteria/Rooms/ CancelPolicy/Refundable | Boolean | Indicates whether the booking is refundable. |
| BookCriteria/Rooms/ CancelPolicy/CancelPenalties | Array<CancelPenalty> | A collection of penalties that apply if the booking is canceled. |
| BookCriteria/Rooms/ CancelPolicy/CancelPenalties/ HoursBefore | Integer | Indicates the number of hours before the check-in date when the penalty becomes applicable. |
| BookCriteria/Rooms/ CancelPolicy/CancelPenalties/ PenaltyType | PenaltyType | Specifies the type of penalty enforced upon cancellation. |
| BookCriteria/Rooms/ CancelPolicy/CancelPenalties/ Currency | Currency | Specifies the currency in which the penalty value is expressed. |
| BookCriteria/Rooms/ CancelPolicy/CancelPenalties/ Value | Double | Indicates the value of the penalty. |
| BookCriteria/Rooms/ CancelPolicy/CancelPenalties/ Deadline | String | Specifies the absolute deadline for the penalty in UTC format. |
| BookCriteria/Rooms/ CancelPolicy/ CancelPolicyDescription | String | Provides additional details or a textual summary of the cancellation policy. |
| BookCriteria/Rooms/Beds | Array<Bed> | List of beds available in the room, including types and configurations. |
| BookCriteria/Rooms/Beds/Type | String | The type of the bed. |
| BookCriteria/Rooms/Beds/ Description | String | A description of the bed. |
| BookCriteria/Rooms/Beds/Count | Integer | The number of beds of this type in the room. |
| BookCriteria/Rooms/Beds/Shared | Boolean | Indicates whether the bed is shared. |
| BookCriteria/Rooms/Amenities | Array<Amenity> | Amenities included with this room, such as Wi-Fi or parking. |
| BookCriteria/Rooms/Amenities/ Code | String | A unique code that identifies the amenity. |
| BookCriteria/Rooms/Amenities/ Type | AmenityType | The type of the amenity, defined by AmenityType. |
| BookCriteria/Rooms/Amenities/ Value | String | The value associated with the amenity. |
| BookCriteria/Rooms/Amenities/ Texts | String | Additional textual information or description for the amenity. |
| BookCriteria/Rooms/ UnitsSpecified | Boolean | Indicates whether the number of units has been explicitly specified. |
| BookCriteria/Rooms/Features | Array<Feature> | Features or custom attributes of the room, used for specific integrations. |
| BookCriteria/Rooms/Features/ Code | String | The unique code identifying the feature of the room. |
| BookCriteria/PaymentType | PaymentType | Gets the payment type for the booking. |
| BookCriteria/Remarks | Array<Remark> | Gets the remarks for the booking. |
| BookCriteria/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. |
| BookCriteria/Remarks/Text | String | The text content of the remark, providing details or additional notes.This can include supplier-specific instructions, conditions, or general information. |
| BookCriteria/ClientReference | String | Gets the client reference for the booking. |
| BookCriteria/BookPrice | BookPrice | Gets the book price for the booking. |
| BookCriteria/BookPrice/Price | Price | The price of the booking. |
| BookCriteria/BookPrice/Price/ Currency | Currency | The currency of the price, represented in ISO 4217 format (e.g., USD, EUR). |
| BookCriteria/BookPrice/Price/ Binding | Boolean | Indicates whether the price is binding. |
| BookCriteria/BookPrice/Price/ Net | Double | The net price paid by the Buyer to the Seller. |
| BookCriteria/BookPrice/Price/ Gross | Double | The gross price, which includes the net price and the Buyer's commission. |
| BookCriteria/BookPrice/Price/ NetSpecified | Boolean | Indicates whether the net price is explicitly specified. |
| BookCriteria/BookPrice/Price/ MinimumSellingPrice | Double | The minimum selling price. |
| BookCriteria/BookPrice/ DeltaPrice | DeltaPrice | The delta price, representing any allowable price changes or adjustments. |
| BookCriteria/BookPrice/ DeltaPrice/Amount | Double | The fixed amount allowed for the delta price. |
| BookCriteria/BookPrice/ DeltaPrice/Percentage | Double | The percentage allowed for the delta price. |
| BookCriteria/Holder | Holder | Gets or sets the holder information for the booking. |
| BookCriteria/Holder/Name | String | The name of the holder. |
| BookCriteria/Holder/SurName | String | The surname of the holder. |
| BookCriteria/Holder/ PersonalTitleType | PersonalTitleType | The personal title type of the holder. |
| BookCriteria/Holder/ ContactInfo | ContactInfo | The contact information of the holder. |
| BookCriteria/Holder/ ContactInfo/Email | String | The email address of the passenger. |
| BookCriteria/Holder/ ContactInfo/Phone | String | The phone number of the passenger. |
| BookCriteria/PaymentCardInput | CreditCardInput | Gets the payment card input for the booking. |
| BookCriteria/PaymentCardInput/ Type | CreditCardType | The type of the credit card. |
| BookCriteria/PaymentCardInput/ Number | String | The credit card number. |
| BookCriteria/PaymentCardInput/ Cvc | String | The Card Verification Code (CVC) of the credit card. |
| BookCriteria/PaymentCardInput/ Expiration | CreditCardExpiration | The expiration date of the credit card. |
| BookCriteria/PaymentCardInput/ Expiration/Month | Integer | The expiration month of the credit card. |
| BookCriteria/PaymentCardInput/ Expiration/Year | Integer | The expiration year of the credit card (last two digits). |
| BookCriteria/PaymentCardInput/ Expiration/YearFull | Integer | Gets the full four-digit year of the credit card expiration. |
| BookCriteria/PaymentCardInput/ IsVcc | Boolean | Indicates whether the credit card is a Virtual Credit Card (VCC). |
| BookCriteria/PaymentCardInput/ Holder | Holder | The holder information of the credit card. |
| BookCriteria/PaymentCardInput/ Holder/Name | String | The name of the holder. |
| BookCriteria/PaymentCardInput/ Holder/SurName | String | The surname of the holder. |
| BookCriteria/PaymentCardInput/ Holder/PersonalTitleType | PersonalTitleType | The personal title type of the holder. |
| BookCriteria/PaymentCardInput/ Holder/ContactInfo | ContactInfo | The contact information of the holder. |
| BookCriteria/PaymentCardInput/ Holder/ContactInfo/Email | String | The email address of the passenger. |
| BookCriteria/PaymentCardInput/ Holder/ContactInfo/Phone | String | The phone number of the passenger. |
| BookCriteria/PaymentCardInput/ VirtualCreditCard | VirtualCreditCard | The virtual credit card information, if applicable. |
| BookCriteria/PaymentCardInput/ VirtualCreditCard/ VCCActivationDate | String | Gets or sets the activation date of the virtual credit card. |
| BookCriteria/PaymentCardInput/ VirtualCreditCard/ VCCDeactivationDate | String | Gets or sets the deactivation date of the virtual credit card. |
| BookCriteria/PaymentCardInput/ VirtualCreditCard/ VCCCurrentBalance | Double | Gets or sets the current balance of the virtual credit card. |
| BookCriteria/PaymentCardInput/ VirtualCreditCard/ VCCCurrencyCode | String | Gets or sets the currency code for the virtual credit card balance. |
| BookCriteria/PaymentCardInput/ ThreeDomainSecurity | ThreeDomainSecurity | The 3-D Secure authentication information for the credit card transaction. |
| BookCriteria/PaymentCardInput/ ThreeDomainSecurity/ ThreeDSVersion | String | Gets or sets the version of 3-D Secure protocol used. |
| BookCriteria/PaymentCardInput/ ThreeDomainSecurity/ DSTransactionID | String | Gets or sets the Directory Server Transaction ID. |
| BookCriteria/PaymentCardInput/ ThreeDomainSecurity/XID | String | Gets or sets the transaction identifier for 3-D Secure. |
| BookCriteria/PaymentCardInput/ ThreeDomainSecurity/ECI | String | Gets or sets the Electronic Commerce Indicator. |
| BookCriteria/PaymentCardInput/ ThreeDomainSecurity/CAVV | String | Gets or sets the Cardholder Authentication Verification Value. |
| BookCriteria/PaymentCardInput/ ThreeDomainSecurity/PARes | String | Gets or sets the Payer Authentication Response. |
| BookCriteria/PaymentCardInput/ ThreeDomainSecurity/ PAResStatus | PAResStatus | Gets or sets the status of the Payer Authentication Response. |
| BookCriteria/PaymentCardInput/ ThreeDomainSecurity/ CardEnrolledStatus | EnrolledStatus | Gets or sets the enrollment status of the card in 3-D Secure. |
| BookCriteria/PaymentCardInput/ ThreeDomainSecurity/ MerchantName | String | Gets or sets the name of the merchant. |
| BookCriteria/PaymentCardInput/ ThreeDomainSecurity/ SignatureStatus | SignatureStatus | Gets or sets the status of the signature in the 3-D Secure process. |
| BookCriteria/PaymentCardInput/ UrlPayment | UrlPayment | The URL payment information for the credit card transaction. |
| BookCriteria/PaymentCardInput/ UrlPayment/Url | String | Gets or sets the URL for the payment. |
| BookCriteria/Parameters | Array<Parameter> | Gets or sets the additional parameters for the booking. |
| BookCriteria/Parameters/Key | Integer | Identifies the parameter with a numeric key. |
| BookCriteria/Parameters/Value | String | Defines the value associated with the parameter. |
| BookCriteria/Parameters/ ParameterType | ParameterType | Specifies the type of the parameter (ParameterType), whether it is internal or supplier-related. |
| BookCriteria/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. |
| BookCriteria/Parameters/RoomId | Integer | Associates the parameter with a specific room, identified by its ID. |
| Settings | BookSettings | The settings for the hotel booking. |
| Settings/Supplier | String | Identifies the supplier associated with the hotel operation. This is a unique code generated by Travelgate within its system to represent the supplier. |
| Settings/Platform | String | Represents the platform on which the hotel operation is performed.Platforms are collections of suppliers, and the platform code is generated by Travelgate to define the operational context. |
| Settings/Client | String | Represents the client performing the hotel operation.This is a unique client code assigned by Travelgate to identify the client within its system. |
| Settings/Access | Access | Contains access information required for the operation, including API credentials, endpoints, and other connection details specific to the supplier's integration. |
| Settings/Access/Code | Integer | The unique code identifying the access configuration. |
| Settings/Access/User | String | The username used for authentication with the supplier. |
| Settings/Access/Password | String | The password used for authentication with the supplier. |
| Settings/Access/ApiKey | String | The API key used for authentication or authorization. |
| Settings/Access/Urls | Urls | The URLs associated with the access configuration. |
| Settings/Access/Urls/Book | String | The URL used for booking operations. |
| Settings/Access/Urls/Search | String | The URL used for Search operations. |
| Settings/Access/Urls/Quote | String | The URL used for Quote operations. |
| Settings/Access/Urls/Generic | String | A generic URL for additional operations. |
| Settings/Access/Parameters | AccessParameters | Additional parameters related to the connection. |
| Settings/BusinessRules | BusinessRules | Specifies the business rules to be applied during the operation. These rules define operational constraints and behavior, such as quota limits or prioritization criteria. |
| Settings/BusinessRules/ OptionsQuota | Integer | The maximum number of options returned for each board in the search query. |
| Settings/BusinessRules/ BusinessRuleType | BusinessRulesType | The business rule type that determines how Search results are prioritized or filtered. |
| Settings/Timeout | String | Defines the timeout period for the operation as a string value.This indicates the maximum amount of time to wait for a supplier's response before timing out.The value must be provided in timestamp format (e.g., "00:05:00" for 5 minutes). |
| Settings/TimeoutAsTimeSpan | String | Converts the timeout value from the string representation (Timeout) into a TimeSpan for use in time-based operations. |
| Settings/ IncludeProviderTransactions | Boolean | Indicates whether detailed traces of provider transactions should be included in the operation's response.If enabled, the ProviderAudit field in responses will contain the transaction logs (e.g., requests and responses exchanged with the supplier). |
| Settings/CommitRequired | Boolean | Indicates whether a commit is required for the booking. |