SearchRs
Represents the response for a hotel search operation. Contains the list of available options that match the client's search criteria. Additionally, it includes error or warning messages (AdviseMessages) and trace data (AuditData), which logs the transactions sent to and received from the supplier.
Properties
| Name | Type | Description |
|---|---|---|
| AuditData | ProviderAudit | Contains the requests and responses exchanged with the supplier.This field is populated internally by the connector framework. Integrators do not need to handle this field manually. |
| 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, which may include errors or warnings generated during the search 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. |
| Accommodations | Array | List of accommodations, meal plans, and options returned by the search.These represent the available (hotel-mealPlans-options) that meet the client's criteria. |
| Accommodations AccommodationType | AccommodationType | Gets or initializes the type of accommodation. |
| Accommodations AccommodationCode | String | Gets the unique code identifying the accommodation. |
| Accommodations AccommodationName | String | Gets or initializes the name of the accommodation. |
| Accommodations/Boards | Array<Board> | Gets the list of meal plan options (Board) available for the hotel. |
| Accommodations/Boards BoardCode | String | The unique code identifying the meal plan option. |
| Accommodations/Boards/Name | String | The name of the meal plan option. |
| Accommodations/Boards/Options | Array<Option> | The collection of options associated with this meal plan. |
| Accommodations/Boards/Options FormId | String | Internal field for form test. Not serialized. DO NOT USE! |
| Accommodations/Boards/Options Status | Status | Indicates the availability status of the option. |
| Accommodations/Boards/Options Price | Price | The price details associated with the option, including net, gross and minimum selling price. |
| Accommodations/Boards/Options Price/Currency | Currency | The currency of the price, represented in ISO 4217 format (e.g., USD, EUR). |
| Accommodations/Boards/Options Price/Binding | Boolean | Indicates whether the price is binding. |
| Accommodations/Boards/Options Price/Net | Double | The net price paid by the buyer to the seller. |
| Accommodations/Boards/Options Price/Gross | Double | The gross price, which includes the net price and the buyer's commission. |
| Accommodations/Boards/Options Price/NetSpecified | Boolean | Indicates whether the net price is explicitly specified. |
| Accommodations/Boards/Options Price/MinimumSellingPrice | Double | The minimum selling price. |
| Accommodations/Boards/Options PaymentTypes | Array<PaymentType> | Specifies the accepted payment types for the option. |
| Accommodations/Boards/Options Rooms | Array<Room> | The list of rooms included with the option, including type, description, and price. |
| Accommodations/Boards/Options Rooms/OccupancyRefId | Integer | Numeric ID linking this room to its occupancy data in the Occupancy. |
| Accommodations/Boards/Options Rooms/Code | String | Unique code assigned to this room. |
| Accommodations/Boards/Options Rooms/Description | String | Description of the room's features or characteristics. |
| Accommodations/Boards/Options Rooms/RoomPrice | RoomPrice | Pricing information for the room, including total price and currency details. |
| Accommodations/Boards/Options Rooms/RoomPrice/Price | Price | The total price of the room. |
| Accommodations/Boards/Options Rooms/RoomPrice/Price/Currency | Currency | The currency of the price, represented in ISO 4217 format (e.g., USD, EUR). |
| Accommodations/Boards/Options Rooms/RoomPrice/Price/Binding | Boolean | Indicates whether the price is binding. |
| Accommodations/Boards/Options Rooms/RoomPrice/Price/Net | Double | The net price paid by the buyer to the seller. |
| Accommodations/Boards/Options Rooms/RoomPrice/Price/Gross | Double | The gross price, which includes the net price and the buyer's commission. |
| Accommodations/Boards/Options Rooms/RoomPrice/Price NetSpecified | Boolean | Indicates whether the net price is explicitly specified. |
| Accommodations/Boards/Options Rooms/RoomPrice/Price MinimumSellingPrice | Double | The minimum selling price. |
| Accommodations/Boards/Options Rooms/RoomPrice/PriceBreakdown | Array<PriceBreakdown> | Breakdown of the room price over specific periods, such as daily rates. |
| Accommodations/Boards/Options Rooms/RoomPrice/PriceBreakdown Price | Price | The price for each day of the room during the specified period. |
| Accommodations/Boards/Options Rooms/RoomPrice/PriceBreakdown Price/Currency | Currency | The currency of the price, represented in ISO 4217 format (e.g., USD, EUR). |
| Accommodations/Boards/Options Rooms/RoomPrice/PriceBreakdown Price/Binding | Boolean | Indicates whether the price is binding. |
| Accommodations/Boards/Options Rooms/RoomPrice/PriceBreakdown Price/Net | Double | The net price paid by the buyer to the seller. |
| Accommodations/Boards/Options Rooms/RoomPrice/PriceBreakdown Price/Gross | Double | The gross price, which includes the net price and the buyer's commission. |
| Accommodations/Boards/Options Rooms/RoomPrice/PriceBreakdown Price/NetSpecified | Boolean | Indicates whether the net price is explicitly specified. |
| Accommodations/Boards/Options Rooms/RoomPrice/PriceBreakdown Price/MinimumSellingPrice | Double | The minimum selling price. |
| Accommodations/Boards/Options Rooms/RoomPrice/PriceBreakdown Start | Integer | The starting day of the pricing period (inclusive). |
| Accommodations/Boards/Options Rooms/RoomPrice/PriceBreakdown End | Integer | The ending day of the pricing period (inclusive). |
| Accommodations/Boards/Options Rooms/Refundable | Boolean | Indicates if the room is refundable based on the cancellation policy. |
| Accommodations/Boards/Options Rooms/RefundableSpecified | Boolean | Indicates whether the refundable status has been explicitly specified. |
| Accommodations/Boards/Options Rooms/LegacyRoomId | String | Legacy identifier for internal tracking. Automatically generated using OccupancyRefId and Code. |
| Accommodations/Boards/Options Rooms/Units | Integer | Number of units available for this room type. |
| Accommodations/Boards/Options Rooms/RatePlan | RatePlan | Rate plan associated with this room. |
| Accommodations/Boards/Options Rooms/RatePlan/Code | String | The unique code for the rate plan. |
| Accommodations/Boards/Options Rooms/RatePlan/Name | String | The name of the rate plan. |
| Accommodations/Boards/Options Rooms/Promotions | Array<Promotion> | Promotions or discounts applicable to this room. |
| Accommodations/Boards/Options Rooms/Promotions/Code | String | The unique code identifying the promotion. |
| Accommodations/Boards/Options Rooms/Promotions/Name | String | The name of the promotion. |
| Accommodations/Boards/Options Rooms/Remarks | Array<Remark> | Additional remarks or notes about this room. |
| Accommodations/Boards/Options 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. |
| Accommodations/Boards/Options 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. |
| Accommodations/Boards/Options Rooms/Surcharges | Array<Surcharge> | Additional surcharges applied to this room. |
| Accommodations/Boards/Options 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. |
| Accommodations/Boards/Options 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. |
| Accommodations/Boards/Options 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". |
| Accommodations/Boards/Options Rooms/Surcharges/Price | Price | Represents the price of this surcharge, including the amount and currency. See Price for details about the price structure. |
| Accommodations/Boards/Options Rooms/Surcharges/Price Currency | Currency | The currency of the price, represented in ISO 4217 format (e.g., USD, EUR). |
| Accommodations/Boards/Options Rooms/Surcharges/Price/Binding | Boolean | Indicates whether the price is binding. |
| Accommodations/Boards/Options Rooms/Surcharges/Price/Net | Double | The net price paid by the buyer to the seller. |
| Accommodations/Boards/Options Rooms/Surcharges/Price/Gross | Double | The gross price, which includes the net price and the buyer's commission. |
| Accommodations/Boards/Options Rooms/Surcharges/Price NetSpecified | Boolean | Indicates whether the net price is explicitly specified. |
| Accommodations/Boards/Options Rooms/Surcharges/Price MinimumSellingPrice | Double | The minimum selling price. |
| Accommodations/Boards/Options 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. |
| Accommodations/Boards/Options Rooms/CancelPolicy | CancelPolicy | Cancellation policy specific to this room. |
| Accommodations/Boards/Options Rooms/CancelPolicy/Refundable | Boolean | Indicates whether the booking is refundable. |
| Accommodations/Boards/Options Rooms/CancelPolicy CancelPenalties | Array<CancelPenalty> | A collection of penalties that apply if the booking is canceled. |
| Accommodations/Boards/Options Rooms/CancelPolicy CancelPenalties/HoursBefore | Integer | Indicates the number of hours before the check-in date when the penalty becomes applicable. |
| Accommodations/Boards/Options Rooms/CancelPolicy CancelPenalties/PenaltyType | PenaltyType | Specifies the type of penalty enforced upon cancellation. |
| Accommodations/Boards/Options Rooms/CancelPolicy CancelPenalties/Currency | Currency | Specifies the currency in which the penalty value is expressed. |
| Accommodations/Boards/Options Rooms/CancelPolicy CancelPenalties/Value | Double | Indicates the value of the penalty. |
| Accommodations/Boards/Options Rooms/CancelPolicy CancelPenalties/Deadline | String | Specifies the absolute deadline for the penalty in UTC format. |
| Accommodations/Boards/Options Rooms/CancelPolicy CancelPolicyDescription | String | Provides additional details or a textual summary of the cancellation policy. |
| Accommodations/Boards/Options Rooms/Beds | Array<Bed> | List of beds available in the room, including types and configurations. |
| Accommodations/Boards/Options Rooms/Beds/Type | String | The type of the bed. |
| Accommodations/Boards/Options Rooms/Beds/Description | String | A description of the bed. |
| Accommodations/Boards/Options Rooms/Beds/Count | Integer | The number of beds of this type in the room. |
| Accommodations/Boards/Options Rooms/Beds/Shared | Boolean | Indicates whether the bed is shared. |
| Accommodations/Boards/Options Rooms/Amenities | Array<Amenity> | Amenities included with this room, such as Wi-Fi or parking. |
| Accommodations/Boards/Options Rooms/Amenities/Code | String | A unique code that identifies the amenity. |
| Accommodations/Boards/Options Rooms/Amenities/Type | AmenityType | The type of the amenity, defined by AmenityType. |
| Accommodations/Boards/Options Rooms/Amenities/Value | String | The value associated with the amenity. |
| Accommodations/Boards/Options Rooms/Amenities/Texts | String | Additional textual information or description for the amenity. |
| Accommodations/Boards/Options Rooms/UnitsSpecified | Boolean | Indicates whether the number of units has been explicitly specified. |
| Accommodations/Boards/Options Rooms/Features | Array<Feature> | Features or custom attributes of the room, used for specific integrations. |
| Accommodations/Boards/Options Rooms/Features/Code | String | The unique code identifying the feature of the room. |
| Accommodations/Boards/Options Parameters | Array<Parameter> | Parameters for transferring data between operations, such as from Search to Quote or Quote to Book. |
| Accommodations/Boards/Options Parameters/Key | Integer | Identifies the parameter with a numeric key. |
| Accommodations/Boards/Options Parameters/Value | String | Defines the value associated with the parameter. |
| Accommodations/Boards/Options Parameters/ParameterType | ParameterType | Specifies the type of the parameter (ParameterType), whether it is internal or supplier-related. |
| Accommodations/Boards/Options 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. |
| Accommodations/Boards/Options Parameters/RoomId | Integer | Associates the parameter with a specific room, identified by its ID. |
| Accommodations/Boards/Options CancelPolicy | OptionCancelPolicy | The cancellation policy associated with the option, detailing penalties and conditions. |
| Accommodations/Boards/Options CancelPolicy/Refundable | Boolean | Indicates whether the booking is refundable. |
| Accommodations/Boards/Options CancelPolicy/CancelPenalties | Array<CancelPenalty> | A collection of penalties that apply if the booking is canceled. |
| Accommodations/Boards/Options CancelPolicy/CancelPenalties HoursBefore | Integer | Indicates the number of hours before the check-in date when the penalty becomes applicable. |
| Accommodations/Boards/Options CancelPolicy/CancelPenalties PenaltyType | PenaltyType | Specifies the type of penalty enforced upon cancellation. |
| Accommodations/Boards/Options CancelPolicy/CancelPenalties Currency | Currency | Specifies the currency in which the penalty value is expressed. |
| Accommodations/Boards/Options CancelPolicy/CancelPenalties Value | Double | Indicates the value of the penalty. |
| Accommodations/Boards/Options CancelPolicy/CancelPenalties Deadline | String | Specifies the absolute deadline for the penalty in UTC format. |
| Accommodations/Boards/Options CancelPolicy CancelPolicyDescription | String | Provides additional details or a textual summary of the cancellation policy. |
| Accommodations/Boards/Options CancelPolicy RoomCancelPolicyDescriptions | Array<RoomCancelPolicyDescriptions> | Gets or sets the list of room-specific cancellation policy descriptions. |
| Accommodations/Boards/Options CancelPolicy RoomCancelPolicyDescriptions OccupancyRefId | Integer | Identifies the specific occupancy within the booking for which this cancellation policy applies. |
| Accommodations/Boards/Options CancelPolicy RoomCancelPolicyDescriptions Description | String | Textual information detailing the cancellation policy applicable to the room associated with the OccupancyRefId. |
| Accommodations/Boards/Options Promotions | Array<Promotion> | The promotions applied to the option, such as discounts or special offers. |
| Accommodations/Boards/Options Promotions/Code | String | The unique code identifying the promotion. |
| Accommodations/Boards/Options Promotions/Name | String | The name of the promotion. |
| Accommodations/Boards/Options RateRules | Array<RateRule2> | The rate rules for the option, specifying sales restrictions such as "Senior Discount" or "Resident Rate." |
| Accommodations/Boards/Options RateRules/RateRuleType | RateRule | Selling restrictions applied to the room. These define specific conditions or eligibility requirements that must be met to sell the room. Possible restrictions include: |
| Accommodations/Boards/Options RateRules/Code | String | Represents a unique identifier for the rate rule, typically defined by the supplier.This code is used to reference and distinguish the rule from others. |
| Accommodations/Boards/Options RateRules/Name | String | Provides a human-readable name or label for the rate rule.This name is typically used in user interfaces or reports to describe the rule. |
| Accommodations/Boards/Options RateRules/Restrictions | Array<Restriction> | Defines a collection of additional restrictions that further specify the conditions of the rate rule.Restrictions can include age limits, regional requirements, or special eligibility conditions. |
| Accommodations/Boards/Options RateRules/Restrictions/Code | String | A unique identifier for the restriction. |
| Accommodations/Boards/Options RateRules/Restrictions/Name | String | A descriptive name for the restriction. |
| Accommodations/Boards/Options RateRules/Restrictions RestrictionType | RestrictionType | The type of the restriction, categorizing its purpose or application. |
| Accommodations/Boards/Options Remarks | Array<Remark> | Additional remarks associated with the option, such as special conditions or information. |
| Accommodations/Boards/Options 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. |
| Accommodations/Boards/Options Remarks/Text | String | The text content of the remark, providing details or additional notes.This can include supplier-specific instructions, conditions, or general information. |
| Accommodations/Boards/Options Surcharges | Array<Surcharge> | Surcharges applied to the option, such as mandatory fees or taxes. |
| Accommodations/Boards/Options 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. |
| Accommodations/Boards/Options 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. |
| Accommodations/Boards/Options 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". |
| Accommodations/Boards/Options Surcharges/Price | Price | Represents the price of this surcharge, including the amount and currency. See Price for details about the price structure. |
| Accommodations/Boards/Options Surcharges/Price/Currency | Currency | The currency of the price, represented in ISO 4217 format (e.g., USD, EUR). |
| Accommodations/Boards/Options Surcharges/Price/Binding | Boolean | Indicates whether the price is binding. |
| Accommodations/Boards/Options Surcharges/Price/Net | Double | The net price paid by the buyer to the seller. |
| Accommodations/Boards/Options Surcharges/Price/Gross | Double | The gross price, which includes the net price and the buyer's commission. |
| Accommodations/Boards/Options Surcharges/Price/NetSpecified | Boolean | Indicates whether the net price is explicitly specified. |
| Accommodations/Boards/Options Surcharges/Price MinimumSellingPrice | Double | The minimum selling price. |
| Accommodations/Boards/Options 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. |
| Accommodations/Boards/Options Amenities | Array<Amenity> | Amenities included with the option, such as "Free Wi-Fi" or "Parking." |
| Accommodations/Boards/Options Amenities/Code | String | A unique code that identifies the amenity. |
| Accommodations/Boards/Options Amenities/Type | AmenityType | The type of the amenity, defined by AmenityType. |
| Accommodations/Boards/Options Amenities/Value | String | The value associated with the amenity. |
| Accommodations/Boards/Options Amenities/Texts | String | Additional textual information or description for the amenity. |
| Accommodations/Boards/Options Supplements | Array<Supplement> | Supplements available with the option, such as activity passes. |
| Accommodations/Boards/Options Supplements/Code | String | The unique code identifying the supplement. |
| Accommodations/Boards/Options Supplements/Name | String | The descriptive name of the supplement. |
| Accommodations/Boards/Options Supplements/Description | String | An optional textual description providing additional details about the supplement. |
| Accommodations/Boards/Options Supplements/Mandatory | Boolean | Indicates whether the supplement is mandatory for the booking. |
| Accommodations/Boards/Options Supplements/Price | Price | The Price associated with the supplement, including details such as currency and net price. |
| Accommodations/Boards/Options Supplements/Price/Currency | Currency | The currency of the price, represented in ISO 4217 format (e.g., USD, EUR). |
| Accommodations/Boards/Options Supplements/Price/Binding | Boolean | Indicates whether the price is binding. |
| Accommodations/Boards/Options Supplements/Price/Net | Double | The net price paid by the buyer to the seller. |
| Accommodations/Boards/Options Supplements/Price/Gross | Double | The gross price, which includes the net price and the buyer's commission. |
| Accommodations/Boards/Options Supplements/Price/NetSpecified | Boolean | Indicates whether the net price is explicitly specified. |
| Accommodations/Boards/Options Supplements/Price MinimumSellingPrice | Double | The minimum selling price. |
| Accommodations/Boards/Options Supplements/SupplementType | SupplementType | The specific SupplementType of the supplement (e.g., meal plan, additional service). |
| Accommodations/Boards/Options Supplements/ChargeType | ChargeType | Defines how the supplement is charged using ChargeType (e.g., per person, per stay). |
| Accommodations/Boards/Options Supplements/DurationType | DurationType | Specifies whether the supplement applies to a specific duration (Open or Range). |
| Accommodations/Boards/Options Supplements/Quantity | Integer | The quantity of the supplement included in the booking. |
| Accommodations/Boards/Options Supplements/StartDate | String | The start date for the supplement (if applicable). |
| Accommodations/Boards/Options Supplements StartDateAsDateTime | String | The start date as a DateTime object for easier manipulation. |
| Accommodations/Boards/Options Supplements/EndDate | String | The end date for the supplement (if applicable). |
| Accommodations/Boards/Options Supplements/EndDateAsDateTime | String | The end date as a DateTime object for easier manipulation. |
| Accommodations/Boards/Options Supplements/Resort | Resort | The associated Resort where the supplement applies. |
| Accommodations/Boards/Options Supplements/Resort/Code | String | Unique code that identifies the resort in the system. |
| Accommodations/Boards/Options Supplements/Resort/Name | String | Name of the resort. |
| Accommodations/Boards/Options Supplements/Resort/Description | String | Optional description providing additional details about the resort. |
| Accommodations/Boards/Options Supplements/Unit | UnitTimeType | Specifies the unit of time for the supplement (e.g., per day, per stay) using UnitTimeType. |
| Accommodations/Boards/Options AddOns | Object | Internal field for passing additional information across layers. |
| Accommodations/Location | Location | Gets the geographical location of the hotel. |
| Accommodations/Location/Code | String | The unique code identifying the location. |
| Accommodations/Location Country | String | The ISO 3166-1 alpha-2 country code where the location is situated. |
| Accommodations/Location Longitude | Double | The longitude coordinate of the location, expressed in decimal degrees. |
| Accommodations/Location Latitude | Double | The latitude coordinate of the location, expressed in decimal degrees. |
| GlobalOptionParameters | Array<Parameter> | Global parameters that the client must send in subsequent operations (e.g., in a quote request). These parameters apply to all options returned in the response. |
| GlobalOptionParameters/Key | Integer | Identifies the parameter with a numeric key. |
| GlobalOptionParameters/Value | String | Defines the value associated with the parameter. |
| GlobalOptionParameters ParameterType | ParameterType | Specifies the type of the parameter (ParameterType), whether it is internal or supplier-related. |
| GlobalOptionParameters 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. |
| GlobalOptionParameters/RoomId | Integer | Associates the parameter with a specific room, identified by its ID. |
| DiscardedItems | Integer | Discarded items in the search response, can be rooms or options depending on the connector. |