Skip to main content

QuoteCriteria

Represents the criteria for a hotel Quote request. 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.
BoardCodeStringBoard code indicating the meal plan for the Quote.
OccupanciesArray<Occupancy>Details about the occupancy for the Quote request, including rooms, passengers, and their ages.
Occupancies/OccupancyIdIntegerThe unique identifier for the occupancy.
Occupancies/PaxesArray<PaxInput>The collection of passenger inputs (paxes) for the occupancy.
Occupancies/Paxes/AgeIntegerAge 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.
MarketStringThe market code associated with the Quote request.
RoomsArray<Room>List of selected rooms for the Quote request.
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.
PaymentTypePaymentTypePayment type selected for the Quote request.
ParametersArray<Parameter>Additional parameters required for the Quote.
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.
FromBookCriteriaFromBookCriteriaCriteria used for creating a Quote from a book request.
FromBookCriteria/BookPriceBookPriceContains the price details associated with the booking.
FromBookCriteria/BookPrice/
Price
PriceThe price of the booking.
FromBookCriteria/BookPrice/
Price/Currency
CurrencyThe currency of the price, represented in ISO 4217 format (e.g., USD, EUR).
FromBookCriteria/BookPrice/
Price/Binding
BooleanIndicates whether the price is binding.
FromBookCriteria/BookPrice/
Price/Net
DoubleThe net price paid by the Buyer to the Seller.
FromBookCriteria/BookPrice/
Price/Gross
DoubleThe gross price, which includes the net price and the Buyer's commission.
FromBookCriteria/BookPrice/
Price/NetSpecified
BooleanIndicates whether the net price is explicitly specified.
FromBookCriteria/BookPrice/
Price/MinimumSellingPrice
DoubleThe minimum selling price.
FromBookCriteria/BookPrice/
DeltaPrice
DeltaPriceThe delta price, representing any allowable price changes or adjustments.
FromBookCriteria/BookPrice/
DeltaPrice/Amount
DoubleThe fixed amount allowed for the delta price.
FromBookCriteria/BookPrice/
DeltaPrice/Percentage
DoubleThe percentage allowed for the delta price.
FromBookCriteria/DateQuoteStringRepresents the date when the Quote is generated during the booking process.
FromBookCriteria/CancelPolicyCancelPolicySpecifies the cancellation policy associated with the booking.
FromBookCriteria/CancelPolicy/
Refundable
BooleanIndicates whether the booking is refundable.
FromBookCriteria/CancelPolicy/
CancelPenalties
Array<CancelPenalty>A collection of penalties that apply if the booking is canceled.
FromBookCriteria/CancelPolicy/
CancelPenalties/HoursBefore
IntegerIndicates the number of hours before the check-in date when the penalty becomes applicable.
FromBookCriteria/CancelPolicy/
CancelPenalties/PenaltyType
PenaltyTypeSpecifies the type of penalty enforced upon cancellation.
FromBookCriteria/CancelPolicy/
CancelPenalties/Currency
CurrencySpecifies the currency in which the penalty value is expressed.
FromBookCriteria/CancelPolicy/
CancelPenalties/Value
DoubleIndicates the value of the penalty.
FromBookCriteria/CancelPolicy/
CancelPenalties/Deadline
StringSpecifies the absolute deadline for the penalty in UTC format.
FromBookCriteria/CancelPolicy/
CancelPolicyDescription
StringProvides additional details or a textual summary of the cancellation policy.