Search
Overview
The Search operation is the entry point in the booking workflow, enabling clients to retrieve available options based on their specific requirements. It allows buyers to query for availability, pricing, and other relevant details about accommodations offered by the supplier.
The Search operation is used to:
- Fetch available options that match specific criteria provided by the client.
- Provide detailed information about available rooms, prices, and policies.
- Act as a foundation for subsequent operations like
QuoteandBook.
Cancellation Policies in Search
Cancellation policies in the availability (Search) step are important because they allow buyers to know—right from the start—whether an option is refundable and under what conditions.
However, not all suppliers are required to provide cancellation policy details during the Search response. Some suppliers only include this information in the Quote step.
note
The cancellation policies shown in Search may differ from those shown in Quote. This can happen because some suppliers do not return cancellation policies during the search phase, or because conditions may change between the two calls. The valid and final cancellation policy will always be the one received in the Quote response. This behavior is expected and should be taken into account.
In such cases, the refundable field may appear as null in the Search response, indicating that the supplier will only provide cancellation information during the Quote phase.
To avoid confusion or incorrect assumptions, it is essential to check the supplier's metadata to understand what level of cancellation detail is provided at each stage of the booking flow.
tip
If refundable is null in the Search response, make sure to handle cancellation logic in the Quote step, where detailed policy data is guaranteed.
For a complete reference on how cancellation policies should be handled in the Quote phase, see:
Request
The Request is structured to accommodate various parameters that clients can specify to refine their Search.
Overview
Clients can define their Search criteria to narrow down the available options. Common Search parameters include:
- Hotel Codes: Specific properties to search within.
- Occupations: Number of guests, their ages, and nationalities.
- Markets: Specific geographic or demographic markets targeted by the client.
- Check-in and Check-out Dates: The desired date range for the stay.
Sample
- C#
- FormTest Sample JSON
var request = new SearchRequest
{
SearchCriteria = new SearchCriteria
{
Destinations = new Destinations
{
Accommodations = new List<Accommodation>
{
new Accommodation { Type = "Hotel", Code = "PAR001" }
}
},
Occupancies = new List<Occupancy>
{
new Occupancy
{
OccupancyId = 1,
Paxes = new List<Pax>
{
new Pax { Age = 35 }
}
}
},
Markets = new List<string> { "EU" },
CheckIn = "2025-06-10",
CheckOut = "2025-06-15",
CheckInAsDateTime = DateTime.Parse("2025-06-10", CultureInfo.InvariantCulture, DateTimeStyles.AssumeUniversal),
CheckOutAsDateTime = DateTime.Parse("2025-06-15", CultureInfo.InvariantCulture, DateTimeStyles.AssumeUniversal),
TotalNights = 5,
Language = "EN",
Currency = "EUR",
Nationality = "FR"
},
Settings = new Settings
{
Supplier = "HOTELTEST",
Platform = "HOTELTEST",
Client = "TravelAgency123",
Access = new Access
{
Code = 1001,
User = "agency_user",
Password = "secure_password",
ApiKey = "API_KEY_123456789",
Urls = new Urls
{
Book = "https://api.hotelsupplier.com/book",
Search = "https://api.hotelsupplier.com/search",
Quote = "https://api.hotelsupplier.com/quote",
Generic = "https://api.hotelsupplier.com/generic"
},
Parameters = new Dictionary<string, string>
{
{ "maxResults", "50" },
{ "cacheEnabled", "true" },
{ "requestTimeout", "5000" },
{ "preferredSupplier", "SupplierX" }
}
},
BusinessRules = new BusinessRules
{
OptionsQuota = 10,
BusinessRuleType = "CheaperAmount"
},
Timeout = "00:00:10",
TimeoutAsTimeSpan = TimeSpan.Parse("00:00:10"),
IncludeProviderTransactions = true
},
Filters = new Filters
{
Status = new StatusFilter
{
Includes = new List<string> { "OK" },
Excludes = new List<string> { "RQ" }
},
RateRuleFilter = new RateRuleFilter
{
Includes = new List<string> { "Older60" },
Excludes = new List<string> { "Older55" },
IncludeEmptyRateRulesOptions = false
}
}
};
{
"searchCriteria":
{
"destinations":
{
"accommodations":
[
{
"type": "Hotel",
"code": "PAR001"
}
]
},
"occupancies":
[
{
"occupancyId": 1,
"paxes":
[
{
"age": 35
}
]
}
],
"markets":
[
"EU"
],
"checkIn": "2025-06-10",
"checkOut": "2025-06-15",
"checkInAsDateTime": "2025-06-10T00:00:00",
"checkOutAsDateTime": "2025-06-15T00:00:00",
"totalNights": 5,
"language": "EN",
"currency": "EUR",
"nationality": "FR"
},
"settings":
{
"supplier": "HOTELTEST",
"platform": "HOTELTEST",
"client": "TravelAgency123",
"access":
{
"code": 1001,
"user": "agency_user",
"password": "secure_password",
"apiKey": "API_KEY_123456789",
"urls":
{
"book": "https://api.hotelsupplier.com/book",
"search": "https://api.hotelsupplier.com/search",
"quote": "https://api.hotelsupplier.com/quote",
"generic": "https://api.hotelsupplier.com/generic"
},
"parameters":
{
"maxResults": "50",
"cacheEnabled": "true",
"requestTimeout": "5000",
"preferredSupplier": "SupplierX"
}
},
"businessRules":
{
"optionsQuota": 10,
"businessRuleType": "CheaperAmount"
},
"timeout": "00:00:10",
"timeoutAsTimeSpan": "00:00:10",
"includeProviderTransactions": true
},
"filters":
{
"status":
{
"includes":
[
"OK"
],
"excludes":
[
"RQ"
]
},
"rateRuleFilter":
{
"excludes":
[
"Older55"
],
"includes":
[
"Older60"
],
"includeEmptyRateRulesOptions": false
}
}
}
Details
The object SearchRq represents the structure of the Search request as expected by the supplier.
| Name | Relation | Type | Description |
|---|---|---|---|
| SearchCriteria | 1 | SearchCriteria | Gets the Search criteria for the hotel Search. |
| SearchCriteria/CheckIn | 1 | String | The check-in date for the operation, represented as a string in ISO 8601 format (YYYY-MM-DD). |
| SearchCriteria/CheckOut | 1 | String | The check-out date for the operation, represented as a string in ISO 8601 format (YYYY-MM-DD). |
| SearchCriteria/ CheckInAsDateTime | 0 . . 1 | String | The check-in date parsed as a DateTime object, expressed in UTC 0 |
| SearchCriteria/ CheckOutAsDateTime | 0 . . 1 | String | The check-out date parsed as a DateTime object, expressed in UTC 0 |
| SearchCriteria/TotalNights | 0 . . 1 | Integer | The total number of nights for the stay, calculated as the difference between check-in and check-out dates. |
| SearchCriteria/Language | 1 | String | The language code for the operation, represented as a 2-character ISO 639-1 code (e.g., "en", "es"). |
| SearchCriteria/Currency | 0 . . 1 | Currency | The preferred currency for the operation, defined as an optional Currency value. |
| SearchCriteria/Nationality | 0 . . 1 | String | The nationality code of the client, represented as a 2-character ISO 3166-1 alpha-2 country code (e.g., "US", "FR"). |
| SearchCriteria/Destinations | 1 | Destinations | Gets the destinations for the search. These can be specific hotels or locations. |
| SearchCriteria/Destinations/ Accommodations | 0 . . N | Array<AccommodationRQ> | Collection of accommodations for the Search request. |
| SearchCriteria/Destinations/ Accommodations/Type | 1 | AccommodationType | Specifies the type of accommodation being requested, such as Hotel or Rental. |
| SearchCriteria/Destinations/ Accommodations/Code | 1 | String | Represents a unique code identifying the accommodation in the request. |
| SearchCriteria/Destinations/ Locations | 0 . . N | Array<Location> | Collection of locations for the Search request. |
| SearchCriteria/Destinations/ Locations/Code | 1 | String | The unique code identifying the location. |
| SearchCriteria/Destinations/ Locations/Country | 0 . . 1 | String | The ISO 3166-1 alpha-2 country code where the location is situated. |
| SearchCriteria/Destinations/ Locations/Longitude | 0 . . 1 | Double | The longitude coordinate of the location, expressed in decimal degrees. |
| SearchCriteria/Destinations/ Locations/Latitude | 0 . . 1 | Double | The latitude coordinate of the location, expressed in decimal degrees. |
| SearchCriteria/Occupancies | 1 . . N | Array<Occupancy> | Gets the occupancy details for the Search.Indicates the number of rooms, passengers, and their respective ages. |
| SearchCriteria/Occupancies/ OccupancyId | 1 | Integer | The unique identifier for the occupancy. |
| SearchCriteria/Occupancies/ Paxes | 1 . . N | Array<PaxInput> | The collection of passenger inputs (paxes) for the occupancy. |
| SearchCriteria/Occupancies/ Paxes/Age | 1 | 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. |
| SearchCriteria/Markets | 0 . . N | Array | Gets the markets associated with the Search.Represents ISO 3166-1 alpha-2 country codes. |
| Settings | 1 | SearchSettings | Gets the Search settings for the hotel Search. |
| Settings/Supplier | 1 | 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 | 1 | 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 | 1 | 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 | 1 | 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 | 1 | Integer | The unique code identifying the access configuration. |
| Settings/Access/User | 0 . . 1 | String | The username used for authentication with the supplier. |
| Settings/Access/Password | 0 . . 1 | String | The password used for authentication with the supplier. |
| Settings/Access/ApiKey | 0 . . 1 | String | The API key used for authentication or authorization. |
| Settings/Access/Urls | 1 | Urls | The URLs associated with the access configuration. |
| Settings/Access/Urls/Book | 0 . . 1 | String | The URL used for booking operations. |
| Settings/Access/Urls/Search | 0 . . 1 | String | The URL used for Search operations. |
| Settings/Access/Urls/Quote | 0 . . 1 | String | The URL used for Quote operations. |
| Settings/Access/Urls/Generic | 0 . . 1 | String | A generic URL for additional operations. |
| Settings/Access/Parameters | 0 . . 1 | AccessParameters | Additional parameters related to the connection. |
| Settings/BusinessRules | 0 . . 1 | 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 | 0 . . 1 | Integer | The maximum number of options returned for each board in the Search query. |
| Settings/BusinessRules/ BusinessRuleType | 0 . . 1 | BusinessRulesType | The business rule type that determines how Search results are prioritized or filtered. |
| Settings/Timeout | 1 | 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 TimeSpan format (e.g., ""00:00:10"" for 10 seconds). |
| Settings/TimeoutAsTimeSpan | 0 . . 1 | String | Converts the timeout value from the string representation (Timeout) into a TimeSpan for use in time-based operations. |
| Settings/ IncludeProviderTransactions | 1 | 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). |
| Filters | 1 | Filters | Gets the filters to be applied to the hotel Search results. |
| Filters/Status | 0 . . 1 | StatusFilter | Filter for hotel statuses to include or exclude specific booking statuses in the Search results. |
| Filters/Status/Includes | 0 . . N | Array<Status> | The statuses to include in the response. |
| Filters/Status/Excludes | 0 . . N | Array<Status> | The statuses to exclude from the response. |
| Filters/RateRuleFilter | 0 . . 1 | RateRuleFilter | Filter for rate rules to include or exclude specific rate restrictions in the Search results. |
| Filters/RateRuleFilter/ Excludes | 0 . . N | Array<RateRule> | The collection of rate rules that should be excluded from the Search results. |
| Filters/RateRuleFilter/ Includes | 0 . . N | Array<RateRule> | The collection of rate rules that should be included in the Search results. |
| Filters/RateRuleFilter/ IncludeEmptyRateRulesOptions | 0 . . 1 | Boolean | Specifies whether options without rate rules should be included in the results when Includes is null. |
Response
The Response is structured to provide detailed information about the available options that match the Search criteria.
Overview
The Search operation returns a list of available options matching the criteria. Each option includes:
- Price Details: Comprehensive breakdowns of pricing, including base prices, taxes, and fees.
- Room Information: Descriptions of the rooms, including amenities, room types, and occupancy limits.
- Cancellation Policies: Policies related to cancellations, including deadlines and penalties.
- Remarks: Supplier-specific notes or disclaimers.
- Rate Rules: Conditions and restrictions associated with specific rates, such as minimum stay requirements.
Sample
- C#
- FormTest Sample JSON
var searchResponse = new SearchRs
{
AdviseMessages = new List<AdviseMessage>
{
new AdviseMessage
{
Code = "SupplierNoResultsFound",
Level = "Warning",
Description = "No results found for the selected supplier.",
CorrelationId = Guid.Parse("b9d1ab45-f18d-4d88-b7bd-185a40498a1b"),
External = new External
{
Code = "SUPPLIER_NOT_FOUND",
Message = "The requested supplier could not be found.",
HttpStatusCode = 404
}
}
},
Accommodations = new List<Accommodation>
{
new Accommodation
{
Boards = new List<Board>
{
new Board
{
BoardCode = "BB",
Name = "Bed & Breakfast",
Options = new List<Option>
{
new Option
{
FormId = "BB12345",
Status = "OK",
Price = new Price
{
Currency = "EUR",
Binding = true,
Net = 120m, // 'm' suffix for decimal literal
Gross = 130m,
NetSpecified = true,
MinimumSellingPrice = 125m
},
PaymentTypes = new List<string>
{
"CardBookingPay"
},
Rooms = new List<Room>
{
new Room
{
OccupancyRefId = 1,
Code = "DBL",
Description = "Double Room with Sea View",
RoomPrice = new RoomPrice
{
Price = new Price
{
Currency = "EUR",
Binding = true,
Net = 120m,
Gross = 130m,
NetSpecified = true,
MinimumSellingPrice = 125m
},
PriceBreakdown = new List<PriceBreakdown>
{
new PriceBreakdown
{
Price = new Price
{
Currency = "EUR",
Binding = true,
Net = 60m,
Gross = 65m,
NetSpecified = true,
MinimumSellingPrice = 62.5m
},
Start = 0,
End = 1
}
}
},
Refundable = true,
RefundableSpecified = true,
LegacyRoomId = "DBL_SEA_01",
Units = 5,
RatePlan = new RatePlan
{
Code = "STANDARD",
Name = "Standard Rate"
},
Promotions = new List<Promotion>
{
new Promotion
{
Code = "EARLYBIRD",
Name = "Early Bird Discount"
}
},
Remarks = new List<Remark>
{
new Remark
{
RemarkType = "Room",
Text = "Non-smoking room with complimentary Wi-Fi."
}
},
Surcharges = new List<Surcharge>
{
new Surcharge
{
ChargeType = "Excluded",
Mandatory = true,
Description = "City Tax per person per night",
Price = new Price
{
Currency = "EUR",
Binding = true,
Net = 5m,
Gross = 5m,
NetSpecified = true,
MinimumSellingPrice = 5m
},
Code = "CITY_TAX"
}
},
CancelPolicy = new CancelPolicy
{
Refundable = false,
CancelPenalties = new List<CancelPenalty>
{
new CancelPenalty
{
HoursBefore = 48,
PenaltyType = "Percentage",
Currency = "EUR",
Value = 50m,
Deadline = DateTime.Parse("2025-05-30T23:59:59Z")
}
},
CancelPolicyDescription = "50% charge if canceled within 48 hours before check-in."
},
Beds = new List<Bed>
{
new Bed
{
Type = "Queen",
Description = "1 Queen-size Bed",
Count = 1,
Shared = false
}
},
Amenities = new List<Amenity>
{
new Amenity
{
Code = "WIFI",
Type = "Room",
Value = "Free Wi-Fi",
Texts = "High-speed internet available in the room."
}
},
UnitsSpecified = true,
Features = new List<Feature>
{
new Feature
{
Code = "BALCONY",
Name = "Private Balcony"
}
}
}
},
Parameters = new List<Parameter>
{
new Parameter
{
Key = 101,
Value = "HotelSupplierX",
ParameterType = "Supplier",
Immutable = false,
RoomId = 1
}
},
OptionCancelPolicy = new CancelPolicy // Using OptionCancelPolicy as defined in classes
{
RoomCancelPolicyDescriptions = new List<RoomCancelPolicyDescription>
{
new RoomCancelPolicyDescription
{
OccupancyRefId = 1,
Description = "Cancellations within 48 hours before check-in incur a 50% charge."
}
},
Refundable = false,
CancelPenalties = new List<CancelPenalty>
{
new CancelPenalty
{
HoursBefore = 48,
PenaltyType = "Percentage",
Currency = "EUR",
Value = 50m,
Deadline = DateTime.Parse("2025-05-30T23:59:59Z")
}
},
CancelPolicyDescription = "50% charge if canceled within 48 hours before check-in."
},
Promotions = new List<Promotion>
{
new Promotion
{
Code = "LASTMINUTE",
Name = "Last Minute Offer"
}
},
RateRules = new List<RateRule>
{
new RateRule
{
RateRuleType = "Honeymoon",
Code = "HONEYMOON",
Name = "Honeymoon Special",
Restrictions = new List<Restriction>
{
new Restriction
{
Code = "MARRIAGE_CERT",
Name = "Marriage Certificate Required",
RestrictionType = "Document"
}
}
}
},
Remarks = new List<Remark>
{
new Remark
{
RemarkType = "General",
Text = "Check-in from 3 PM, check-out by 11 AM."
}
},
Surcharges = new List<Surcharge>
{
new Surcharge
{
ChargeType = "Excluded",
Mandatory = true,
Description = "Resort Fee",
Price = new Price
{
Currency = "EUR",
Binding = true,
Net = 10m,
Gross = 10m,
NetSpecified = true,
MinimumSellingPrice = 10m
},
Code = "RESORT_FEE"
}
},
Amenities = new List<Amenity>
{
new Amenity
{
Code = "POOL",
Type = "General",
Value = "Outdoor Pool",
Texts = "Heated swimming pool available from 8 AM to 8 PM."
}
},
Supplements = new List<Supplement>
{
new Supplement
{
Code = "SPABUNDLE",
Name = "Spa Package",
Mandatory = false,
Price = new Price
{
Currency = "EUR",
Binding = true,
Net = 50m,
Gross = 55m,
NetSpecified = true,
MinimumSellingPrice = 50m
},
SupplementType = "Other",
ChargeType = "Excluded",
DurationType = "Session",
Quantity = 1,
Resort = new Resort
{
Code = "SPA123",
Name = "Luxury Spa Center"
},
Unit = "Hours"
}
},
AddOns = new Dictionary<string, string>
{
{ "LATE_CHECKOUT", "Late Checkout Available Until 2 PM" }
}
}
}
}
},
Location = new Location
{
Code = "PAR",
Country = "France",
Longitude = 2.3522,
Latitude = 48.8566
},
AccommodationType = "Hotel",
AccommodationCode = "HOTEL_PARIS_001",
AccommodationName = "Hotel Le Parisien"
}
},
DiscardedItems = 0
};
{
"adviseMessages":
[
{
"code": "SupplierNoResultsFound",
"level": "Warning",
"description": "No results found for the selected supplier.",
"correlationId": "b9d1ab45-f18d-4d88-b7bd-185a40498a1b",
"external":
{
"code": "SUPPLIER_NOT_FOUND",
"message": "The requested supplier could not be found.",
"httpStatusCode": 404
}
}
],
"accommodations":
[
{
"boards":
[
{
"boardCode": "BB",
"name": "Bed & Breakfast",
"options":
[
{
"formId": "BB12345",
"status": "OK",
"price":
{
"currency": "EUR",
"binding": true,
"net": 120,
"gross": 130,
"netSpecified": true,
"minimumSellingPrice": 125
},
"paymentTypes":
[
"CardBookingPay"
],
"rooms":
[
{
"occupancyRefId": 1,
"code": "DBL",
"description": "Double Room with Sea View",
"roomPrice":
{
"price":
{
"currency": "EUR",
"binding": true,
"net": 120,
"gross": 130,
"netSpecified": true,
"minimumSellingPrice": 125
},
"priceBreakdown":
[
{
"price":
{
"currency": "EUR",
"binding": true,
"net": 60,
"gross": 65,
"netSpecified": true,
"minimumSellingPrice": 62.5
},
"start": 0,
"end": 1
}
]
},
"refundable": true,
"refundableSpecified": true,
"legacyRoomId": "DBL_SEA_01",
"units": 5,
"ratePlan":
{
"code": "STANDARD",
"name": "Standard Rate"
},
"promotions":
[
{
"code": "EARLYBIRD",
"name": "Early Bird Discount"
}
],
"remarks":
[
{
"remarkType": "Room",
"text": "Non-smoking room with complimentary Wi-Fi."
}
],
"surcharges":
[
{
"chargeType": "Excluded",
"mandatory": true,
"description": "City Tax per person per night",
"price":
{
"currency": "EUR",
"binding": true,
"net": 5,
"gross": 5,
"netSpecified": true,
"minimumSellingPrice": 5
},
"code": "CITY_TAX"
}
],
"cancelPolicy":
{
"refundable": false,
"cancelPenalties":
[
{
"hoursBefore": 48,
"penaltyType": "Percentage",
"currency": "EUR",
"value": 50,
"deadline": "2025-05-30T23:59:59Z"
}
],
"cancelPolicyDescription": "50% charge if canceled within 48 hours before check-in."
},
"beds":
[
{
"type": "Queen",
"description": "1 Queen-size Bed",
"count": 1,
"shared": false
}
],
"amenities":
[
{
"code": "WIFI",
"type": "Room",
"value": "Free Wi-Fi",
"texts": "High-speed internet available in the room."
}
],
"unitsSpecified": true,
"features":
[
{
"code": "BALCONY",
"name": "Private Balcony"
}
]
}
],
"parameters":
[
{
"key": 101,
"value": "HotelSupplierX",
"parameterType": "Supplier",
"immutable": false,
"roomId": 1
}
],
"cancelPolicy":
{
"roomCancelPolicyDescriptions":
[
{
"occupancyRefId": 1,
"description": "Cancellations within 48 hours before check-in incur a 50% charge."
}
],
"refundable": false,
"cancelPenalties":
[
{
"hoursBefore": 48,
"penaltyType": "Percentage",
"currency": "EUR",
"value": 50,
"deadline": "2025-05-30T23:59:59Z"
}
],
"cancelPolicyDescription": "50% charge if canceled within 48 hours before check-in."
},
"promotions":
[
{
"code": "LASTMINUTE",
"name": "Last Minute Offer"
}
],
"rateRules":
[
{
"rateRuleType": "Honeymoon",
"code": "HONEYMOON",
"name": "Honeymoon Special",
"restrictions":
[
{
"code": "MARRIAGE_CERT",
"name": "Marriage Certificate Required",
"restrictionType": "Document"
}
]
}
],
"remarks":
[
{
"remarkType": "General",
"text": "Check-in from 3 PM, check-out by 11 AM."
}
],
"surcharges":
[
{
"chargeType": "Excluded",
"mandatory": true,
"description": "Resort Fee",
"price":
{
"currency": "EUR",
"binding": true,
"net": 10,
"gross": 10,
"netSpecified": true,
"minimumSellingPrice": 10
},
"code": "RESORT_FEE"
}
],
"amenities":
[
{
"code": "POOL",
"type": "General",
"value": "Outdoor Pool",
"texts": "Heated swimming pool available from 8 AM to 8 PM."
}
],
"supplements":
[
{
"code": "SPABUNDLE",
"name": "Spa Package",
"mandatory": false,
"price":
{
"currency": "EUR",
"binding": true,
"net": 50,
"gross": 55,
"netSpecified": true,
"minimumSellingPrice": 50
},
"supplementType": "Other",
"chargeType": "Excluded",
"durationType": "Session",
"quantity": 1,
"resort":
{
"code": "SPA123",
"name": "Luxury Spa Center"
},
"unit": "Hours"
}
],
"addOns":
{
"LATE_CHECKOUT": "Late Checkout Available Until 2 PM"
}
}
]
}
],
"location":
{
"code": "PAR",
"country": "France",
"longitude": 2.3522,
"latitude": 48.8566
},
"accommodationType": "Hotel",
"accommodationCode": "HOTEL_PARIS_001",
"accommodationName": "Hotel Le Parisien"
}
],
"discardedItems": 0
}
Details
The SearchRs object represents the standardized structure of the response returned by the supplier.
| Name | Relation | Type | Description |
|---|---|---|---|
| AuditData | 0 . . 1 | 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 | 0 . . N | Array<ProviderAuditRq> | Collection of audit entries for provider requests.Each entry contains details about a specific request made to the provider. |
| AuditData/Request/SendAt | 1 | String | The timestamp indicating when the request was sent. Date on UTC Standard (ISO 8601 UTC 2025-05-21T08:48:53.9744052+00:00) |
| AuditData/Request/Data | 1 | String | The payload data included in the request. |
| AuditData/Request/Url | 1 | String | The URL of the provider endpoint to which the request is sent. |
| AuditData/Request/Headers | 1 | Object | A collection of headers included in the request. |
| AuditData/Request/HttpMethod | 1 | HttpMethod | The HTTP method used to send the request. |
| AuditData/Request/HttpMethod/ Method | 1 | String | No description available. |
| AuditData/Response | 0 . . N | Array<ProviderAuditRs> | Collection of audit entries for provider responses.Each entry contains details about a specific response received from the provider. |
| AuditData/Response/ReceivedAt | 1 | String | The timestamp indicating when the response was received. Date on UTC Standard (ISO 8601 UTC 2025-05-21T08:48:53.9744052+00:00) |
| AuditData/Response/Data | 1 | String | The payload data contained in the provider's response. |
| AuditData/Response/Headers | 1 | Object | A collection of headers included in the provider's response. |
| AuditData/Response/StatusCode | 1 | Integer | The HTTP status code returned by the provider. |
| AdviseMessages | 0 . . N | Array<AdviseMessage> | Collection of advice messages, which may include errors or warnings generated during the Search process. |
| AdviseMessages/Code | 1 | AdviseMessageCode | Gets the code that represents the message type. |
| AdviseMessages/Level | 1 | AdviseMessageLevel | Gets the severity level of the message (e.g., Error, Warning, or Info). |
| AdviseMessages/Description | 0 . . 1 | String | Gets the message description providing additional context. |
| AdviseMessages/CorrelationId | 0 . . 1 | String | Gets a unique identifier for correlating the message with specific operations. |
| AdviseMessages/External | 0 . . 1 | External | Gets additional external details associated with the message. |
| AdviseMessages/External/Code | 0 . . 1 | String | The supplier's internal code for identifying the nature of the response or error. |
| AdviseMessages/External/ Message | 1 | String | A descriptive message returned by the supplier. |
| AdviseMessages/External/ HttpStatusCode | 1 | Integer | The HTTP status code of the supplier's response. |
| Accommodations | 0 . . N | Array | List of accommodations, boards, and options returned by the Search.These represent the available (hotels-boards-options) that meet the client's criteria. |
| Accommodations/ AccommodationType | 1 | AccommodationType | Gets or initializes the type of accommodation. |
| Accommodations/ AccommodationCode | 1 | String | Gets the unique code identifying the accommodation. |
| Accommodations/ AccommodationName | 0 . . 1 | String | Gets or initializes the name of the accommodation. |
| Accommodations/Boards | 1 . . N | Array<Board> | Gets the list of boards available for the hotel. |
| Accommodations/Boards/ BoardCode | 1 | String | The unique code identifying the board. |
| Accommodations/Boards/Name | 0 . . 1 | String | The name of the board. |
| Accommodations/Boards/Options | 1 . . N | Array<Option> | The collection of options associated with this board. |
| Accommodations/Boards/Options/ FormId | 0 . . 1 | String | Internal field for FormTest. Not serialized. DO NOT USE! |
| Accommodations/Boards/Options/ Status | 1 | Status | Indicates the availability status of the option. |
| Accommodations/Boards/Options/ Price | 1 | Price | The price details associated with the option, including net, gross and minimum selling price. |
| Accommodations/Boards/Options/ Price/Currency | 1 | Currency | The currency of the price, represented in ISO 4217 format (e.g., USD, EUR). |
| Accommodations/Boards/Options/ Price/Binding | 1 | Boolean | Indicates whether the price is binding. |
| Accommodations/Boards/Options/ Price/Net | 1 | Double | The net price paid by the Buyer to the Seller. |
| Accommodations/Boards/Options/ Price/Gross | 1 | Double | The gross price, which includes the net price and the Buyer's commission. |
| Accommodations/Boards/Options/ Price/NetSpecified | 1 | Boolean | Indicates whether the net price is explicitly specified. |
| Accommodations/Boards/Options/ Price/MinimumSellingPrice | 1 | Double | The minimum selling price. |
| Accommodations/Boards/Options/ PaymentTypes | 1 . . N | Array<PaymentType> | Specifies the accepted payment types for the option. |
| Accommodations/Boards/Options/ Rooms | 1 . . N | Array<Room> | The list of rooms included with the option, including type, description, and price. |
| Accommodations/Boards/Options/ Rooms/OccupancyRefId | 1 | Integer | Numeric ID linking this room to its occupancy data in the Occupancy. |
| Accommodations/Boards/Options/ Rooms/Code | 1 | String | Unique code assigned to this room. |
| Accommodations/Boards/Options/ Rooms/Description | 0 . . 1 | String | Description of the room's features or characteristics. |
| Accommodations/Boards/Options/ Rooms/RoomPrice | 1 | RoomPrice | Pricing information for the room, including total price and currency details. |
| Accommodations/Boards/Options/ Rooms/RoomPrice/Price | 1 | Price | The total price of the room. |
| Accommodations/Boards/Options/ Rooms/RoomPrice/Price/Currency | 1 | Currency | The currency of the price, represented in ISO 4217 format (e.g., USD, EUR). |
| Accommodations/Boards/Options/ Rooms/RoomPrice/Price/Binding | 1 | Boolean | Indicates whether the price is binding. |
| Accommodations/Boards/Options/ Rooms/RoomPrice/Price/Net | 1 | Double | The net price paid by the Buyer to the Seller. |
| Accommodations/Boards/Options/ Rooms/RoomPrice/Price/Gross | 1 | Double | The gross price, which includes the net price and the Buyer's commission. |
| Accommodations/Boards/Options/ Rooms/RoomPrice/Price/ NetSpecified | 1 | Boolean | Indicates whether the net price is explicitly specified. |
| Accommodations/Boards/Options/ Rooms/RoomPrice/Price/ MinimumSellingPrice | 1 | Double | The minimum selling price. |
| Accommodations/Boards/Options/ Rooms/RoomPrice/PriceBreakdown | 0 . . N | Array<PriceBreakdown> | Breakdown of the room price over specific periods, such as daily rates. |
| Accommodations/Boards/Options/ Rooms/RoomPrice/PriceBreakdown/ Price | 1 | Price | The price for each day of the room during the specified period. |
| Accommodations/Boards/Options/ Rooms/RoomPrice/PriceBreakdown/ Price/Currency | 1 | Currency | The currency of the price, represented in ISO 4217 format (e.g., USD, EUR). |
| Accommodations/Boards/Options/ Rooms/RoomPrice/PriceBreakdown/ Price/Binding | 1 | Boolean | Indicates whether the price is binding. |
| Accommodations/Boards/Options/ Rooms/RoomPrice/PriceBreakdown/ Price/Net | 1 | Double | The net price paid by the Buyer to the Seller. |
| Accommodations/Boards/Options/ Rooms/RoomPrice/PriceBreakdown/ Price/Gross | 1 | Double | The gross price, which includes the net price and the Buyer's commission. |
| Accommodations/Boards/Options/ Rooms/RoomPrice/PriceBreakdown/ Price/NetSpecified | 1 | Boolean | Indicates whether the net price is explicitly specified. |
| Accommodations/Boards/Options/ Rooms/RoomPrice/PriceBreakdown/ Price/MinimumSellingPrice | 1 | Double | The minimum selling price. |
| Accommodations/Boards/Options/ Rooms/RoomPrice/PriceBreakdown/ Start | 1 | Integer | The starting day of the pricing period (inclusive). |
| Accommodations/Boards/Options/ Rooms/RoomPrice/PriceBreakdown/ End | 1 | Integer | The ending day of the pricing period (inclusive). |
| Accommodations/Boards/Options/ Rooms/Refundable | 1 | Boolean | Indicates if the room is refundable based on the cancellation policy. |
| Accommodations/Boards/Options/ Rooms/RefundableSpecified | 1 | Boolean | Indicates whether the refundable status has been explicitly specified. |
| Accommodations/Boards/Options/ Rooms/LegacyRoomId | 1 | String | Legacy identifier for internal tracking. Automatically generated using OccupancyRefId and Code. |
| Accommodations/Boards/Options/ Rooms/Units | 0 . . 1 | Integer | Number of units available for this room type. |
| Accommodations/Boards/Options/ Rooms/RatePlan | 0 . . 1 | RatePlan | Rate plan associated with this room. |
| Accommodations/Boards/Options/ Rooms/RatePlan/Code | 1 | String | The unique code for the rate plan. |
| Accommodations/Boards/Options/ Rooms/RatePlan/Name | 0 . . 1 | String | The name of the rate plan. |
| Accommodations/Boards/Options/ Rooms/Promotions | 0 . . N | Array<Promotion> | Promotions or discounts applicable to this room. |
| Accommodations/Boards/Options/ Rooms/Promotions/Code | 1 | String | The unique code identifying the promotion. |
| Accommodations/Boards/Options/ Rooms/Promotions/Name | 0 . . 1 | String | The name of the promotion. |
| Accommodations/Boards/Options/ Rooms/Remarks | 0 . . N | Array<Remark> | Additional remarks or notes about this room. |
| Accommodations/Boards/Options/ Rooms/Remarks/RemarkType | 1 | 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. |
| Accommodations/Boards/Options/ Rooms/Remarks/Text | 1 | 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 | 0 . . N | Array<Surcharge> | Additional surcharges applied to this room. |
| Accommodations/Boards/Options/ Rooms/Surcharges/ChargeType | 1 | 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 | 1 | 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 | 1 | 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 | 1 | 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 | 1 | Currency | The currency of the price, represented in ISO 4217 format (e.g., USD, EUR). |
| Accommodations/Boards/Options/ Rooms/Surcharges/Price/Binding | 1 | Boolean | Indicates whether the price is binding. |
| Accommodations/Boards/Options/ Rooms/Surcharges/Price/Net | 1 | Double | The net price paid by the Buyer to the Seller. |
| Accommodations/Boards/Options/ Rooms/Surcharges/Price/Gross | 1 | Double | The gross price, which includes the net price and the Buyer's commission. |
| Accommodations/Boards/Options/ Rooms/Surcharges/Price/ NetSpecified | 1 | Boolean | Indicates whether the net price is explicitly specified. |
| Accommodations/Boards/Options/ Rooms/Surcharges/Price/ MinimumSellingPrice | 1 | Double | The minimum selling price. |
| Accommodations/Boards/Options/ Rooms/Surcharges/Code | 0 . . 1 | 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 | 0 . . 1 | CancelPolicy | Cancellation policy specific to this room. |
| Accommodations/Boards/Options/ Rooms/CancelPolicy/Refundable | 1 | Boolean | Indicates whether the booking is refundable. |
| Accommodations/Boards/Options/ Rooms/CancelPolicy/ CancelPenalties | 0 . . N | Array<CancelPenalty> | A collection of penalties that apply if the booking is canceled. |
| Accommodations/Boards/Options/ Rooms/CancelPolicy/ CancelPenalties/HoursBefore | 0 . . 1 | Integer | [Deprecated] This field is deprecated. Use Deadline instead. Indicates the number of hours before the check-in date when the penalty becomes applicable. |
| Accommodations/Boards/Options/ Rooms/CancelPolicy/ CancelPenalties/PenaltyType | 1 | PenaltyType | Specifies the type of penalty enforced upon cancellation. |
| Accommodations/Boards/Options/ Rooms/CancelPolicy/ CancelPenalties/Currency | 1 | Currency | Specifies the currency in which the penalty value is expressed. |
| Accommodations/Boards/Options/ Rooms/CancelPolicy/ CancelPenalties/Value | 1 | Double | Indicates the value of the penalty. |
| Accommodations/Boards/Options/ Rooms/CancelPolicy/ CancelPenalties/Deadline | 1 | String | Date on UTC Standard TimeZone in which this cancellation policy applies (ISO 8601 UTC 2025-11-01T05:00:00Z) |
| Accommodations/Boards/Options/ Rooms/CancelPolicy/ CancelPolicyDescription | 0 . . 1 | String | Provides additional details or a textual summary of the cancellation policy. |
| Accommodations/Boards/Options/ Rooms/Beds | 0 . . N | Array<Bed> | List of beds available in the room, including types and configurations. |
| Accommodations/Boards/Options/ Rooms/Beds/Type | 0 . . 1 | String | The type of the bed. |
| Accommodations/Boards/Options/ Rooms/Beds/Description | 0 . . 1 | String | A description of the bed. |
| Accommodations/Boards/Options/ Rooms/Beds/Count | 0 . . 1 | Integer | The number of beds of this type in the room. |
| Accommodations/Boards/Options/ Rooms/Beds/Shared | 0 . . 1 | Boolean | Indicates whether the bed is shared. |
| Accommodations/Boards/Options/ Rooms/Amenities | 0 . . N | Array<Amenity> | Amenities included with this room, such as Wi-Fi or parking. |
| Accommodations/Boards/Options/ Rooms/Amenities/Code | 1 | String | A unique code that identifies the amenity. |
| Accommodations/Boards/Options/ Rooms/Amenities/Type | 1 | AmenityType | The type of the amenity, defined by AmenityType. |
| Accommodations/Boards/Options/ Rooms/Amenities/Value | 1 | String | The value associated with the amenity. |
| Accommodations/Boards/Options/ Rooms/Amenities/Texts | 0 . . 1 | String | Additional textual information or description for the amenity. |
| Accommodations/Boards/Options/ Rooms/UnitsSpecified | 1 | Boolean | Indicates whether the number of units has been explicitly specified. |
| Accommodations/Boards/Options/ Rooms/Features | 0 . . N | Array<Feature> | Features or custom attributes of the room, used for specific integrations. |
| Accommodations/Boards/Options/ Rooms/Features/Code | 1 | String | The unique code identifying the feature of the room. |
| Accommodations/Boards/Options/ Parameters | 0 . . N | Array<Parameter> | Parameters for transferring data between operations, such as from Search to Quote or Quote to Book. |
| Accommodations/Boards/Options/ Parameters/Key | 1 | Integer | Identifies the parameter with a numeric key. |
| Accommodations/Boards/Options/ Parameters/Value | 1 | String | Defines the value associated with the parameter. |
| Accommodations/Boards/Options/ Parameters/ParameterType | 1 | ParameterType | Specifies the type of the parameter (ParameterType), whether it is internal or supplier-related. |
| Accommodations/Boards/Options/ Parameters/Immutable | 1 | 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 | 1 | Integer | Associates the parameter with a specific room, identified by its ID. |
| Accommodations/Boards/Options/ CancelPolicy | 0 . . 1 | OptionCancelPolicy | The cancellation policy associated with the option, detailing penalties and conditions. |
| Accommodations/Boards/Options/ CancelPolicy/Refundable | 1 | Boolean | Indicates whether the booking is refundable. |
| Accommodations/Boards/Options/ CancelPolicy/CancelPenalties | 0 . . N | Array<CancelPenalty> | A collection of penalties that apply if the booking is canceled. |
| Accommodations/Boards/Options/ CancelPolicy/CancelPenalties/ HoursBefore | 0 . . 1 | Integer | [Deprecated] This field is deprecated. Use Deadline instead. Indicates the number of hours before the check-in date when the penalty becomes applicable. |
| Accommodations/Boards/Options/ CancelPolicy/CancelPenalties/ PenaltyType | 1 | PenaltyType | Specifies the type of penalty enforced upon cancellation. |
| Accommodations/Boards/Options/ CancelPolicy/CancelPenalties/ Currency | 1 | Currency | Specifies the currency in which the penalty value is expressed. |
| Accommodations/Boards/Options/ CancelPolicy/CancelPenalties/ Value | 1 | Double | Indicates the value of the penalty. |
| Accommodations/Boards/Options/ CancelPolicy/CancelPenalties/ Deadline | 1 | String | Date on UTC Standard TimeZone in which this cancellation policy applies (ISO 8601 UTC 2025-11-01T05:00:00Z) |
| Accommodations/Boards/Options/ CancelPolicy/ CancelPolicyDescription | 0 . . 1 | String | Provides additional details or a textual summary of the cancellation policy. |
| Accommodations/Boards/Options/ CancelPolicy/ RoomCancelPolicyDescriptions | 0 . . N | Array<RoomCancelPolicyDescriptions> | Gets or sets the list of room-specific cancellation policy descriptions. |
| Accommodations/Boards/Options/ CancelPolicy/ RoomCancelPolicyDescriptions OccupancyRefId | 1 | Integer | Identifies the specific occupancy within the booking for which this cancellation policy applies. |
| Accommodations/Boards/Options/ CancelPolicy/ RoomCancelPolicyDescriptions Description | 1 | String | Textual information detailing the cancellation policy applicable to the room associated with the OccupancyRefId. |
| Accommodations/Boards/Options/ Promotions | 0 . . N | Array<Promotion> | The promotions applied to the option, such as discounts or special offers. |
| Accommodations/Boards/Options/ Promotions/Code | 1 | String | The unique code identifying the promotion. |
| Accommodations/Boards/Options/ Promotions/Name | 0 . . 1 | String | The name of the promotion. |
| Accommodations/Boards/Options/ RateRules | 0 . . N | Array<RateRule2> | The rate rules for the option, specifying sales restrictions such as "Senior Discount" or "Resident Rate." |
| Accommodations/Boards/Options/ RateRules/RateRuleType | 1 | 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 | 0 . . 1 | 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 | 0 . . 1 | 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 | 0 . . N | 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 | 1 | String | A unique identifier for the restriction. |
| Accommodations/Boards/Options/ RateRules/Restrictions/Name | 0 . . 1 | String | A descriptive name for the restriction. |
| Accommodations/Boards/Options/ RateRules/Restrictions/ RestrictionType | 1 | RestrictionType | The type of the restriction, categorizing its purpose or application. |
| Accommodations/Boards/Options/ Remarks | 0 . . N | Array<Remark> | Additional remarks associated with the option, such as special conditions or information. |
| Accommodations/Boards/Options/ Remarks/RemarkType | 1 | 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. |
| Accommodations/Boards/Options/ Remarks/Text | 1 | 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 | 0 . . N | Array<Surcharge> | Surcharges applied to the option, such as mandatory fees or taxes. |
| Accommodations/Boards/Options/ Surcharges/ChargeType | 1 | 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 | 1 | 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 | 1 | 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 | 1 | 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 | 1 | Currency | The currency of the price, represented in ISO 4217 format (e.g., USD, EUR). |
| Accommodations/Boards/Options/ Surcharges/Price/Binding | 1 | Boolean | Indicates whether the price is binding. |
| Accommodations/Boards/Options/ Surcharges/Price/Net | 1 | Double | The net price paid by the Buyer to the Seller. |
| Accommodations/Boards/Options/ Surcharges/Price/Gross | 1 | Double | The gross price, which includes the net price and the Buyer's commission. |
| Accommodations/Boards/Options/ Surcharges/Price/NetSpecified | 1 | Boolean | Indicates whether the net price is explicitly specified. |
| Accommodations/Boards/Options/ Surcharges/Price/ MinimumSellingPrice | 1 | Double | The minimum selling price. |
| Accommodations/Boards/Options/ Surcharges/Code | 0 . . 1 | 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 | 0 . . N | Array<Amenity> | Amenities included with the option, such as "Free Wi-Fi" or "Parking." |
| Accommodations/Boards/Options/ Amenities/Code | 1 | String | A unique code that identifies the amenity. |
| Accommodations/Boards/Options/ Amenities/Type | 1 | AmenityType | The type of the amenity, defined by AmenityType. |
| Accommodations/Boards/Options/ Amenities/Value | 1 | String | The value associated with the amenity. |
| Accommodations/Boards/Options/ Amenities/Texts | 0 . . 1 | String | Additional textual information or description for the amenity. |
| Accommodations/Boards/Options/ Supplements | 0 . . N | Array<Supplement> | Supplements available with the option, such as activity passes. |
| Accommodations/Boards/Options/ Supplements/Code | 1 | String | The unique code identifying the supplement. |
| Accommodations/Boards/Options/ Supplements/Name | 1 | String | The descriptive name of the supplement. |
| Accommodations/Boards/Options/ Supplements/Description | 1 | String | An optional textual description providing additional details about the supplement. |
| Accommodations/Boards/Options/ Supplements/Mandatory | 1 | Boolean | Indicates whether the supplement is mandatory for the booking. |
| Accommodations/Boards/Options/ Supplements/Price | 1 | Price | The Price associated with the supplement, including details such as currency and net price. |
| Accommodations/Boards/Options/ Supplements/Price/Currency | 1 | Currency | The currency of the price, represented in ISO 4217 format (e.g., USD, EUR). |
| Accommodations/Boards/Options/ Supplements/Price/Binding | 1 | Boolean | Indicates whether the price is binding. |
| Accommodations/Boards/Options/ Supplements/Price/Net | 1 | Double | The net price paid by the Buyer to the Seller. |
| Accommodations/Boards/Options/ Supplements/Price/Gross | 1 | Double | The gross price, which includes the net price and the Buyer's commission. |
| Accommodations/Boards/Options/ Supplements/Price/NetSpecified | 1 | Boolean | Indicates whether the net price is explicitly specified. |
| Accommodations/Boards/Options/ Supplements/Price/ MinimumSellingPrice | 1 | Double | The minimum selling price. |
| Accommodations/Boards/Options/ Supplements/SupplementType | 1 | SupplementType | The specific SupplementType of the supplement (e.g., board, additional service). |
| Accommodations/Boards/Options/ Supplements/ChargeType | 1 | ChargeType | Defines how the supplement is charged using ChargeType (e.g., per person, per stay). |
| Accommodations/Boards/Options/ Supplements/DurationType | 1 | DurationType | Specifies whether the supplement applies to a specific duration (Open or Range). |
| Accommodations/Boards/Options/ Supplements/Quantity | 1 | Integer | The quantity of the supplement included in the booking. |
| Accommodations/Boards/Options/ Supplements/StartDate | 1 | String | The start date for the supplement (if applicable). |
| Accommodations/Boards/Options/ Supplements/ StartDateAsDateTime | 0 . . 1 | String | The start date as a DateTime object for easier manipulation. |
| Accommodations/Boards/Options/ Supplements/EndDate | 1 | String | The end date for the supplement (if applicable). |
| Accommodations/Boards/Options/ Supplements/EndDateAsDateTime | 0 . . 1 | String | The end date as a DateTime object for easier manipulation. |
| Accommodations/Boards/Options/ Supplements/Resort | 1 | Resort | The associated Resort where the supplement applies. |
| Accommodations/Boards/Options/ Supplements/Resort/Code | 1 | String | Unique code that identifies the resort in the system. |
| Accommodations/Boards/Options/ Supplements/Resort/Name | 1 | String | Name of the resort. |
| Accommodations/Boards/Options/ Supplements/Resort/Description | 0 . . 1 | String | Optional description providing additional details about the resort. |
| Accommodations/Boards/Options/ Supplements/Unit | 1 | UnitTimeType | Specifies the unit of time for the supplement (e.g., per day, per stay) using UnitTimeType. |
| Accommodations/Boards/Options/ AddOns | 0 . . 1 | Object | Internal field for passing additional information across layers. |
| Accommodations/Location | 0 . . 1 | Location | Gets the geographical location of the hotel. |
| Accommodations/Location/Code | 1 | String | The unique code identifying the location. |
| Accommodations/Location/ Country | 0 . . 1 | String | The ISO 3166-1 alpha-2 country code where the location is situated. |
| Accommodations/Location/ Longitude | 0 . . 1 | Double | The longitude coordinate of the location, expressed in decimal degrees. |
| Accommodations/Location/ Latitude | 0 . . 1 | Double | The latitude coordinate of the location, expressed in decimal degrees. |
| GlobalOptionParameters | 1 . . N | 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 | 1 | Integer | Identifies the parameter with a numeric key. |
| GlobalOptionParameters/Value | 1 | String | Defines the value associated with the parameter. |
| GlobalOptionParameters/ ParameterType | 1 | ParameterType | Specifies the type of the parameter (ParameterType), whether it is internal or supplier-related. |
| GlobalOptionParameters/ Immutable | 1 | 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 | 1 | Integer | Associates the parameter with a specific room, identified by its ID. |
| DiscardedItems | 0 . . 1 | Integer | Discarded items in the Search response, can be rooms or options depending on the connector. |