QuoteRs
Represents the response for a hotel quote request. This class provides details about the quoted price, status, rooms, and other relevant information for a hotel quote operation.
Properties
Name | Type | Description |
---|---|---|
AuditData | ProviderAudit | Contains the audit data detailing the requests and responses exchanged with the supplier.This field is populated internally by the connector framework. |
AuditData/Request | Array<ProviderAuditRq> | Collection of audit entries for provider requests.Each entry contains details about a specific request made to the provider. |
AuditData/Request/SendAt | String | The timestamp indicating when the request was sent. |
AuditData/Request/Data | String | The payload data included in the request. |
AuditData/Request/Url | String | The URL of the provider endpoint to which the request is sent. |
AuditData/Request/Headers | Object | A collection of headers included in the request. |
AuditData/Request/HttpMethod | HttpMethod | The HTTP method used to send the request. |
AuditData/Request/HttpMethod Method | String | No description available. |
AuditData/Response | Array<ProviderAuditRs> | Collection of audit entries for provider responses.Each entry contains details about a specific response received from the provider. |
AuditData/Response/ReceivedAt | String | The timestamp indicating when the response was received. |
AuditData/Response/Data | String | The payload data contained in the provider's response. |
AuditData/Response/Headers | Object | A collection of headers included in the provider's response. |
AuditData/Response/StatusCode | Integer | The HTTP status code returned by the provider. |
AdviseMessages | Array<AdviseMessage> | Collection of advice messages, including errors or warnings encountered during the quote process. |
AdviseMessages/Code | AdviseMessageCode | Gets the code that represents the message type. |
AdviseMessages/Level | AdviseMessageLevel | Gets the severity level of the message (e.g., Error, Warning, or Info). |
AdviseMessages/Description | String | Gets the message description providing additional context. |
AdviseMessages/CorrelationId | String | Gets a unique identifier for correlating the message with specific operations. |
AdviseMessages/External | External | Gets additional external details associated with the message. |
AdviseMessages/External/Code | String | The supplier's internal code for identifying the nature of the response or error. |
AdviseMessages/External Message | String | A descriptive message returned by the supplier. |
AdviseMessages/External HttpStatusCode | Integer | The HTTP status code of the supplier's response. |
Price | Price | Contains the price details for the quoted option. |
Price/Currency | Currency | The currency of the price, represented in ISO 4217 format (e.g., USD, EUR). |
Price/Binding | Boolean | Indicates whether the price is binding. |
Price/Net | Double | The net price paid by the buyer to the seller. |
Price/Gross | Double | The gross price, which includes the net price and the buyer's commission. |
Price/NetSpecified | Boolean | Indicates whether the net price is explicitly specified. |
Price/MinimumSellingPrice | Double | The minimum selling price. |
Status | Status | Indicates the status of the quote. |
PaymentType | PaymentType | Payment types available for the Option. |
Rooms | Array<Room> | List of rooms included in the quoted option. |
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. |
CancelPolicy | CancelPolicy | Cancellation policy applicable to the quoted option. |
CancelPolicy/Refundable | Boolean | Indicates whether the booking is refundable. |
CancelPolicy/CancelPenalties | Array<CancelPenalty> | A collection of penalties that apply if the booking is canceled. |
CancelPolicy/CancelPenalties HoursBefore | Integer | Indicates the number of hours before the check-in date when the penalty becomes applicable. |
CancelPolicy/CancelPenalties PenaltyType | PenaltyType | Specifies the type of penalty enforced upon cancellation. |
CancelPolicy/CancelPenalties Currency | Currency | Specifies the currency in which the penalty value is expressed. |
CancelPolicy/CancelPenalties Value | Double | Indicates the value of the penalty. |
CancelPolicy/CancelPenalties Deadline | String | Specifies the absolute deadline for the penalty in UTC format. |
CancelPolicy CancelPolicyDescription | String | Provides additional details or a textual summary of the cancellation policy. |
Surcharges | Array<Surcharge> | Collection of surcharges applied to the quoted option. |
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. |
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. |
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". |
Surcharges/Price | Price | Represents the price of this surcharge, including the amount and currency. See Price for details about the price structure. |
Surcharges/Price/Currency | Currency | The currency of the price, represented in ISO 4217 format (e.g., USD, EUR). |
Surcharges/Price/Binding | Boolean | Indicates whether the price is binding. |
Surcharges/Price/Net | Double | The net price paid by the buyer to the seller. |
Surcharges/Price/Gross | Double | The gross price, which includes the net price and the buyer's commission. |
Surcharges/Price/NetSpecified | Boolean | Indicates whether the net price is explicitly specified. |
Surcharges/Price MinimumSellingPrice | Double | The minimum selling price. |
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. |
Remarks | Array<Remark> | Additional remarks associated with the quote. |
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. |
PaymentInfo | PaymentInfo | Payment information for the quoted option, such as accepted credit card types. |
PaymentInfo AcceptedCreditCards | Array<CreditCardType> | A collection of accepted credit card types.This is required when the payment type requires a credit card. |
Parameters | Array<Parameter> | Parameters associated with the quoted option for transferring data between operations. |
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. |
AddOns | Object | Additional information provided by the supplier for the quoted option. |