QuoteRq
Represents a request for a hotel quote.
Properties
| Name | Type | Description |
|---|---|---|
| QuoteCriteria | QuoteCriteria | Criteria for the quote request, such as dates, selected rooms, or other search-related parameters. |
| QuoteCriteria/CheckIn | String | The check-in date for the operation, represented as a string in ISO 8601 format (yyyy-MM-dd). |
| QuoteCriteria/CheckOut | String | The check-out date for the operation, represented as a string in ISO 8601 format (yyyy-MM-dd). |
| QuoteCriteria CheckInAsDateTime | String | The check-in date parsed as a DateTime object. |
| QuoteCriteria CheckOutAsDateTime | String | The check-out date parsed as a DateTime object. |
| QuoteCriteria/TotalNights | Integer | The total number of nights for the stay, calculated as the difference between check-in and check-out dates. |
| QuoteCriteria/Language | String | The language code for the operation, represented as a 2-character ISO 639-1 code (e.g., "en", "es"). |
| QuoteCriteria/Currency | Currency | The preferred currency for the operation, defined as an optional Currency value. |
| QuoteCriteria/Nationality | String | The nationality code of the client, represented as a 2-character ISO 3166-1 alpha-2 country code (e.g., "US", "FR"). |
| QuoteCriteria/Accommodation | AccommodationRQ | Accommodation details for the quote request, such as the hotel or rental being evaluated. |
| QuoteCriteria/Accommodation Type | AccommodationType | Specifies the type of accommodation being requested, such as Hotel or Rental. |
| QuoteCriteria/Accommodation Code | String | Represents a unique code identifying the accommodation in the request. |
| QuoteCriteria/BoardCode | String | Board code indicating the meal plan for the quote. |
| QuoteCriteria/Occupancies | Array<Occupancy> | Details about the occupancy for the quote request, including rooms, passengers, and their ages. |
| QuoteCriteria/Occupancies OccupancyId | Integer | The unique identifier for the occupancy. |
| QuoteCriteria/Occupancies Paxes | Array<PaxInput> | The collection of passenger inputs (paxes) for the occupancy. |
| QuoteCriteria/Occupancies Paxes/Age | Integer | Age of the passenger. This value is required and plays a critical role in determining eligibility for child or adult pricing as defined by the supplier. |
| QuoteCriteria/Market | String | The market code associated with the quote request. |
| QuoteCriteria/Rooms | Array<Room> | List of selected rooms for the quote request. |
| QuoteCriteria/Rooms OccupancyRefId | Integer | Numeric ID linking this room to its occupancy data in the Occupancy. |
| QuoteCriteria/Rooms/Code | String | Unique code assigned to this room. |
| QuoteCriteria/Rooms Description | String | Description of the room's features or characteristics. |
| QuoteCriteria/Rooms/RoomPrice | RoomPrice | Pricing information for the room, including total price and currency details. |
| QuoteCriteria/Rooms/RoomPrice Price | Price | The total price of the room. |
| QuoteCriteria/Rooms/RoomPrice Price/Currency | Currency | The currency of the price, represented in ISO 4217 format (e.g., USD, EUR). |
| QuoteCriteria/Rooms/RoomPrice Price/Binding | Boolean | Indicates whether the price is binding. |
| QuoteCriteria/Rooms/RoomPrice Price/Net | Double | The net price paid by the buyer to the seller. |
| QuoteCriteria/Rooms/RoomPrice Price/Gross | Double | The gross price, which includes the net price and the buyer's commission. |
| QuoteCriteria/Rooms/RoomPrice Price/NetSpecified | Boolean | Indicates whether the net price is explicitly specified. |
| QuoteCriteria/Rooms/RoomPrice Price/MinimumSellingPrice | Double | The minimum selling price. |
| QuoteCriteria/Rooms/RoomPrice PriceBreakdown | Array<PriceBreakdown> | Breakdown of the room price over specific periods, such as daily rates. |
| QuoteCriteria/Rooms/RoomPrice PriceBreakdown/Price | Price | The price for each day of the room during the specified period. |
| QuoteCriteria/Rooms/RoomPrice PriceBreakdown/Price/Currency | Currency | The currency of the price, represented in ISO 4217 format (e.g., USD, EUR). |
| QuoteCriteria/Rooms/RoomPrice PriceBreakdown/Price/Binding | Boolean | Indicates whether the price is binding. |
| QuoteCriteria/Rooms/RoomPrice PriceBreakdown/Price/Net | Double | The net price paid by the buyer to the seller. |
| QuoteCriteria/Rooms/RoomPrice PriceBreakdown/Price/Gross | Double | The gross price, which includes the net price and the buyer's commission. |
| QuoteCriteria/Rooms/RoomPrice PriceBreakdown/Price NetSpecified | Boolean | Indicates whether the net price is explicitly specified. |
| QuoteCriteria/Rooms/RoomPrice PriceBreakdown/Price MinimumSellingPrice | Double | The minimum selling price. |
| QuoteCriteria/Rooms/RoomPrice PriceBreakdown/Start | Integer | The starting day of the pricing period (inclusive). |
| QuoteCriteria/Rooms/RoomPrice PriceBreakdown/End | Integer | The ending day of the pricing period (inclusive). |
| QuoteCriteria/Rooms/Refundable | Boolean | Indicates if the room is refundable based on the cancellation policy. |
| QuoteCriteria/Rooms RefundableSpecified | Boolean | Indicates whether the refundable status has been explicitly specified. |
| QuoteCriteria/Rooms LegacyRoomId | String | Legacy identifier for internal tracking. Automatically generated using OccupancyRefId and Code. |
| QuoteCriteria/Rooms/Units | Integer | Number of units available for this room type. |
| QuoteCriteria/Rooms/RatePlan | RatePlan | Rate plan associated with this room. |
| QuoteCriteria/Rooms/RatePlan Code | String | The unique code for the rate plan. |
| QuoteCriteria/Rooms/RatePlan Name | String | The name of the rate plan. |
| QuoteCriteria/Rooms/Promotions | Array<Promotion> | Promotions or discounts applicable to this room. |
| QuoteCriteria/Rooms/Promotions Code | String | The unique code identifying the promotion. |
| QuoteCriteria/Rooms/Promotions Name | String | The name of the promotion. |
| QuoteCriteria/Rooms/Remarks | Array<Remark> | Additional remarks or notes about this room. |
| QuoteCriteria/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. |
| QuoteCriteria/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. |
| QuoteCriteria/Rooms/Surcharges | Array<Surcharge> | Additional surcharges applied to this room. |
| QuoteCriteria/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. |
| QuoteCriteria/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. |
| QuoteCriteria/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". |
| QuoteCriteria/Rooms/Surcharges Price | Price | Represents the price of this surcharge, including the amount and currency. See Price for details about the price structure. |
| QuoteCriteria/Rooms/Surcharges Price/Currency | Currency | The currency of the price, represented in ISO 4217 format (e.g., USD, EUR). |
| QuoteCriteria/Rooms/Surcharges Price/Binding | Boolean | Indicates whether the price is binding. |
| QuoteCriteria/Rooms/Surcharges Price/Net | Double | The net price paid by the buyer to the seller. |
| QuoteCriteria/Rooms/Surcharges Price/Gross | Double | The gross price, which includes the net price and the buyer's commission. |
| QuoteCriteria/Rooms/Surcharges Price/NetSpecified | Boolean | Indicates whether the net price is explicitly specified. |
| QuoteCriteria/Rooms/Surcharges Price/MinimumSellingPrice | Double | The minimum selling price. |
| QuoteCriteria/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. |
| QuoteCriteria/Rooms CancelPolicy | CancelPolicy | Cancellation policy specific to this room. |
| QuoteCriteria/Rooms CancelPolicy/Refundable | Boolean | Indicates whether the booking is refundable. |
| QuoteCriteria/Rooms CancelPolicy/CancelPenalties | Array<CancelPenalty> | A collection of penalties that apply if the booking is canceled. |
| QuoteCriteria/Rooms CancelPolicy/CancelPenalties HoursBefore | Integer | Indicates the number of hours before the check-in date when the penalty becomes applicable. |
| QuoteCriteria/Rooms CancelPolicy/CancelPenalties PenaltyType | PenaltyType | Specifies the type of penalty enforced upon cancellation. |
| QuoteCriteria/Rooms CancelPolicy/CancelPenalties Currency | Currency | Specifies the currency in which the penalty value is expressed. |
| QuoteCriteria/Rooms CancelPolicy/CancelPenalties Value | Double | Indicates the value of the penalty. |
| QuoteCriteria/Rooms CancelPolicy/CancelPenalties Deadline | String | Specifies the absolute deadline for the penalty in UTC format. |
| QuoteCriteria/Rooms CancelPolicy CancelPolicyDescription | String | Provides additional details or a textual summary of the cancellation policy. |
| QuoteCriteria/Rooms/Beds | Array<Bed> | List of beds available in the room, including types and configurations. |
| QuoteCriteria/Rooms/Beds/Type | String | The type of the bed. |
| QuoteCriteria/Rooms/Beds Description | String | A description of the bed. |
| QuoteCriteria/Rooms/Beds/Count | Integer | The number of beds of this type in the room. |
| QuoteCriteria/Rooms/Beds Shared | Boolean | Indicates whether the bed is shared. |
| QuoteCriteria/Rooms/Amenities | Array<Amenity> | Amenities included with this room, such as Wi-Fi or parking. |
| QuoteCriteria/Rooms/Amenities Code | String | A unique code that identifies the amenity. |
| QuoteCriteria/Rooms/Amenities Type | AmenityType | The type of the amenity, defined by AmenityType. |
| QuoteCriteria/Rooms/Amenities Value | String | The value associated with the amenity. |
| QuoteCriteria/Rooms/Amenities Texts | String | Additional textual information or description for the amenity. |
| QuoteCriteria/Rooms UnitsSpecified | Boolean | Indicates whether the number of units has been explicitly specified. |
| QuoteCriteria/Rooms/Features | Array<Feature> | Features or custom attributes of the room, used for specific integrations. |
| QuoteCriteria/Rooms/Features Code | String | The unique code identifying the feature of the room. |
| QuoteCriteria/PaymentType | PaymentType | Payment type selected for the quote request. |
| QuoteCriteria/Parameters | Array<Parameter> | Additional parameters required for the quote. |
| QuoteCriteria/Parameters/Key | Integer | Identifies the parameter with a numeric key. |
| QuoteCriteria/Parameters/Value | String | Defines the value associated with the parameter. |
| QuoteCriteria/Parameters ParameterType | ParameterType | Specifies the type of the parameter (ParameterType), whether it is internal or supplier-related. |
| QuoteCriteria/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. |
| QuoteCriteria/Parameters RoomId | Integer | Associates the parameter with a specific room, identified by its ID. |
| QuoteCriteria/FromBookCriteria | FromBookCriteria | Criteria used for creating a quote from a book request. |
| QuoteCriteria/FromBookCriteria BookPrice | BookPrice | Contains the price details associated with the booking. |
| QuoteCriteria/FromBookCriteria BookPrice/Price | Price | The price of the booking. |
| QuoteCriteria/FromBookCriteria BookPrice/Price/Currency | Currency | The currency of the price, represented in ISO 4217 format (e.g., USD, EUR). |
| QuoteCriteria/FromBookCriteria BookPrice/Price/Binding | Boolean | Indicates whether the price is binding. |
| QuoteCriteria/FromBookCriteria BookPrice/Price/Net | Double | The net price paid by the buyer to the seller. |
| QuoteCriteria/FromBookCriteria BookPrice/Price/Gross | Double | The gross price, which includes the net price and the buyer's commission. |
| QuoteCriteria/FromBookCriteria BookPrice/Price/NetSpecified | Boolean | Indicates whether the net price is explicitly specified. |
| QuoteCriteria/FromBookCriteria BookPrice/Price MinimumSellingPrice | Double | The minimum selling price. |
| QuoteCriteria/FromBookCriteria BookPrice/DeltaPrice | DeltaPrice | The delta price, representing any allowable price changes or adjustments. |
| QuoteCriteria/FromBookCriteria BookPrice/DeltaPrice/Amount | Double | The fixed amount allowed for the delta price. |
| QuoteCriteria/FromBookCriteria BookPrice/DeltaPrice Percentage | Double | The percentage allowed for the delta price. |
| QuoteCriteria/FromBookCriteria DateQuote | String | Represents the date when the quote is generated during the booking process. |
| QuoteCriteria/FromBookCriteria CancelPolicy | CancelPolicy | Specifies the cancellation policy associated with the booking. |
| QuoteCriteria/FromBookCriteria CancelPolicy/Refundable | Boolean | Indicates whether the booking is refundable. |
| QuoteCriteria/FromBookCriteria CancelPolicy/CancelPenalties | Array<CancelPenalty> | A collection of penalties that apply if the booking is canceled. |
| QuoteCriteria/FromBookCriteria CancelPolicy/CancelPenalties HoursBefore | Integer | Indicates the number of hours before the check-in date when the penalty becomes applicable. |
| QuoteCriteria/FromBookCriteria CancelPolicy/CancelPenalties PenaltyType | PenaltyType | Specifies the type of penalty enforced upon cancellation. |
| QuoteCriteria/FromBookCriteria CancelPolicy/CancelPenalties Currency | Currency | Specifies the currency in which the penalty value is expressed. |
| QuoteCriteria/FromBookCriteria CancelPolicy/CancelPenalties Value | Double | Indicates the value of the penalty. |
| QuoteCriteria/FromBookCriteria CancelPolicy/CancelPenalties Deadline | String | Specifies the absolute deadline for the penalty in UTC format. |
| QuoteCriteria/FromBookCriteria CancelPolicy CancelPolicyDescription | String | Provides additional details or a textual summary of the cancellation policy. |
| Settings | Settings | Access settings for connecting with the provider during the quote request. |
| 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 that can be returned for a search operation. |
| 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). |