# Search hotels by location. The Search by Location request searches for hotels by any one of these: 1) geographic coordinates, 2) address, 3) IATA airport code, or 4) IATA city code. Although you can search by various criteria, all responses return results in the same format. The response returns up to 100 properties, or all available properties if less than 100. If more than 100 properties matching the search criteria are available, you can request the next page of results with the Search Pagination API. Endpoint: POST /hotel/search/properties/search Version: 11.35.0 Security: bearerAuth ## Header parameters: - `TraceId` (string) Used in hospitality workflows to provide a Unique transaction or tracking id for a single request and response. - `XAUTH_TRAVELPORT_ACCESSGROUP` (string) Identifies the Travelport access group with which the caller is associated - `TVP-PCC-Core` (string) Allows user to pass PCC instead of Access Group ID - `TVP-Correlation-Id` (string) Identifier used to correlate hotel API invocations across a multi-call business flows. ## Request fields (application/json): - `PropertiesQuerySearch` (object) Used for a Hotel Search by Location request. Defines the search criteria, including the type of location to search by (address, coordinates, airport, or city), stay dates, room occupancy details, and optional filtering criteria. This request is usually followed by a Hotel Availability request or optionally a Hotel Details request. - `PropertiesQuerySearch.@type` (string, required) Discriminator class PropertiesQuerySearch only Example: PropertiesQuerySearch - `PropertiesQuerySearch.SortOrder` (string) The method to be used in sorting hotel properties Enum: "StarRating", "Proximity" - `PropertiesQuerySearch.CheckInDate` (string, required) Check-in date in YYYY-MM-DD format. - `PropertiesQuerySearch.CheckOutDate` (string, required) Check-out date in YYYY-MM-DD format. - `PropertiesQuerySearch.ChainCodes` (array) One to six hotel chain codes to include in the search results. Each chain code is typically two alpha characters. ChainCodes supports the entry of brand codes, which are expanded internally by Travelport into the associated chain codes for that brand. - `PropertiesQuerySearch.HotelName` (string) Search for properties with a matching hotel name. This string must match as a substring (case insensitive) in a property's name for the property to be returned. Must be at least three characters long. Supported characters are alphanumeric, comma, period, apostrophe, hyphen, semicolon, colon, and space. - `PropertiesQuerySearch.RequestedCurrency` (string) Send a currency code to request conversion rate information for converting to that currency from the hotel location's currency. The response then returns the CurrencyRateConversion object, which provides the conversion rate of the specified currency that can be used to calculate, independently of the API, the conversion of the rates returned in the response. - `PropertiesQuerySearch.ImageSize` (string) A size for the image to return, allowing you to set image quality. Hospitality APIs no longer support thumbnail. Enum: "Large", "Medium", "Small", "Thumbnail", "ExtraLarge" - `PropertiesQuerySearch.RoomStayCandidate` (array) Contains information associated with room searches. - `PropertiesQuerySearch.RoomStayCandidate.GuestCounts` (object, required) The number and age(s) of guests within the room. - `PropertiesQuerySearch.RoomStayCandidate.GuestCounts.@type` (string) Example: GuestCounts - `PropertiesQuerySearch.RoomStayCandidate.GuestCounts.GuestCount` (array, required) - `PropertiesQuerySearch.RoomStayCandidate.GuestCounts.GuestCount.@type` (string) Example: GuestCount - `PropertiesQuerySearch.RoomStayCandidate.GuestCounts.GuestCount.age` (integer) The age of the guest. Required only when request includes a child in the room. Example: 21 - `PropertiesQuerySearch.RoomStayCandidate.GuestCounts.GuestCount.count` (integer) Number of guests. Supports numeric values 1-9 inclusive. Example: 2 - `PropertiesQuerySearch.RoomStayCandidate.GuestCounts.GuestCount.ageQualifyingCode` (string) "Required only for children or if traveler age is relevant, such as for a senior discount. Supported values include '8' and '10'. 8: Traveler in this GuestCount is a child. 10: Traveler in this GuestCount is an adult." Example: 10 - `PropertiesQuerySearch.RoomStayCandidate.RoomAmenity` (array) - `PropertiesQuerySearch.RoomStayCandidate.RoomAmenity.@type` (string) - `PropertiesQuerySearch.RoomStayCandidate.RoomAmenity.description` (string) Description of amenity received from supplier. Example: WiFi - `PropertiesQuerySearch.RoomStayCandidate.RoomAmenity.quantity` (integer) quantity of amenity - `PropertiesQuerySearch.RoomStayCandidate.RoomAmenity.Name` (string) Room Amenity Name Example: 24 hour Room Service - `PropertiesQuerySearch.RoomStayCandidate.RoomAmenity.Inclusion` (array) - `PropertiesQuerySearch.RoomStayCandidate.RoomAmenity.includedInd` (boolean) Represents if the amenity is included with the rate - `PropertiesQuerySearch.RoomStayCandidate.RoomAmenity.surchargeInd` (boolean) Represents if the amenity attracts a surcharge. - `PropertiesQuerySearch.RoomStayCandidate.RoomAmenity.code` (string) OTA code used to describe the room amenity. This is optional in the Properties Search request but mandatory in the response. - `PropertiesQuerySearch.RateCandidates` (object) For a Hotel Search request: up to eight negotiated rate codes and/or one frequent guest number. For a Hotel Availability request: rate plans, access codes, and rate categories - send only if requesting rate plans. - `PropertiesQuerySearch.RateCandidates.@type` (string, required) Discriminator classes RateCandidates and RateCandidatesDetail Example: RateCandidates - `PropertiesQuerySearch.RateCandidates.RateCandidate` (array, required) - `PropertiesQuerySearch.RateCandidates.RateCandidate.@type` (string, required) Discriminator classes RateCandidate and RateCandidateDetail Example: RateCandidateDetail - `PropertiesQuerySearch.RateCandidates.RateCandidate.priority` (integer) A rate candidate priority - `PropertiesQuerySearch.RateCandidates.RateCandidate.rateCode` (string) "The negotiated rateCode to be applied to the request. For Hotel Availability, each rateCode must be associated with a chainCode, propertyCode, and a rateCategory of 'Multi-level/Negotiated/Secure'. For Hotel Rules, this value can be found, if returned, in the Availability response's ProductRateCodeInfo/RateCodeInfo/value." Example: HL123 - `PropertiesQuerySearch.RateCandidates.RateCandidate.rateCategory` (string) For Hotel Search, request a rate category by sending up to 8 OTA rate categories to search for. If the supplier has rates available for the requested category, the response contains those rates and indicates them as such. Some properties do not return these rates unless explicitly requested. For a Hotel Rules request, this value can be found, if returned, in the Availability response's ProductRateCodeInfo/RateCodeInfo/rateCategory. Enum: "All", "Association", "Business", "BusinessStandard", "Club", "Convention", "Corporate", "Consortiums", "Discount", "Credential", "Employee", "FamilyPlan", "FullInclusive", "Government", "Inclusive", "Industry/TravelAgentRate", "Leisure", "Military", "Monthly", "Multi-DayPackage", "MultLevel/Negotiated/Secure", "Other", "Package", "PrePaid", "Promotional", "RackGeneral", "SeniorCitizen", "Standard", "Tour", "VIP", "Weekend", "Weekly" - `PropertiesQuerySearch.RateCandidates.RateCandidate.chainCode` (string) Code for the hotel chain (typically 2 characters) Example: UR - `PropertiesQuerySearch.RateCandidates.RateCandidate.propertyCode` (string) The property code of the requested property (typically 5 characters). Example: G3375 - `PropertiesQuerySearch.RateCandidates.RateCandidate.masterRateCode` (string) An agency-created rate code that can be translated into up to 12 negotiated rate codes. If masterRateCode is sent, any additional rateCodes will be ignored. Example: 1ABC23 - `PropertiesQuerySearch.RateCandidates.prePayRatesOnlyInd` (boolean) A prepay rate charges the full amount on the credit card immediately on booking. If true, returns only pre-paid rates. If false, allows the return of all rates. - `PropertiesQuerySearch.RateCandidates.postPayRatesOnlyInd` (boolean) A postpay rate (most common in the US) charges the credit card at the property when the guest checks in. If true, returns only post-paid rates. If false, allows the return of all rates. - `PropertiesQuerySearch.RateCandidates.removeSpecialRatesInd` (boolean) Used to request the removal of rate category (Promotional/Package/etc.) rates that may have been returned by the supplier as typical published rates. If true, removes all rate category type rates (except for negotiated rates). If true but one or more specific rate categories are requested, then this indicator is ignored and the rate category is applied. If false, allows the return of all rates returned by the supplier with no filtering. Default behavior is false. - `PropertiesQuerySearch.SearchBy` (object, required) Search for Hotels, based on the type of location: 1) geographic coordinates, 2) address, 3) IATA airport code, or 4) IATA city code. - `PropertiesQuerySearch.SearchBy.@type` (string, required) Discriminator classes SearchByGeoLocation, SearchByAddress, SearchByAirport, and SearchByCity Example: SearchByAirport - `PropertiesQuerySearch.SearchBy.SearchRadius` (object) For Air: distance covered by the flight. For Hotel: a radius around a specified location. The Distance object is returned in all Hotel Search responses but is not relevant to a search by property IDs, only for a search by location. - `PropertiesQuerySearch.SearchBy.SearchRadius.value` (number) When using distance as a Hotel property search parameter, the maximum distance is 25 for miles and 40 for kilometres. Example: 25 - `PropertiesQuerySearch.SearchBy.SearchRadius.unitOfDistance` (string) For Hotels: Optional object to request either miles or kilometers for the search radius from the specified location. If unitOfDistance is not specified, the search defaults to miles for properties in the United States, Myanmar, and Liberia. The search defaults to kilometers in all other countries. Enum: "Miles", "Kilometers" - `PropertiesQuerySearch.returnAllImagesInd` (boolean) If true, returns all property images of the requested ImageSize. If false, returns the best single image. Default behavior is false. - `PropertiesQuerySearch.PropertyAmenityCode` (array) - `PropertiesQuerySearch.BrandCodes` (array) The permitted property brand code(s) to be returned for this request Example: EM, EH - `PropertiesQuerySearch.returnOnlyAvailablePropertiesInd` (boolean) If true, returns only properties with current availability for the dates requested. In some cases, fewer than 25 properties per page may be returned. If false, return properties regardless of availability. Default behavior is false. - `PropertiesQuerySearch.AggregatorList` (array) - `PropertiesQuerySearch.recommendedPropertyAmenitiesInd` (boolean) If true, a limited set of property amenities will be returned in the response. if false, or omitted a full set of property amenities will be returned in the response. - `PropertiesQuerySearch.applyLenientPropertyListRulesInd` (boolean) If true, properties are returned by distance from location, some properties in the list will not support any of the negotiated rates in the request. ## Response 200 fields (application/json): - `PropertiesResponse` (object) The response of a Properties endpoint request. - `PropertiesResponse.@type` (string) Example: response - `PropertiesResponse.transactionId` (string) A unique system-generated (128 bit GUID format) transaction/tracking id for a single request and response (i.e. for a single transaction) used for internal tracking and troubleshooting. Also known as E2ETrackingId. Not returned in all Hotel API responses. Example: 49f58f5f-c443-43b4-9f5d-be405fd00a01 - `PropertiesResponse.traceId` (string) Used in hospitality workflows to provide a unique transaction or tracking id for a single request and response. For Air Eligibility, returned if a custom trace ID was sent in the request header. For Hotel Rules, returned if a custom trace ID was sent in the request header. Example: TraceID_123456 - `PropertiesResponse.correlationId` (string) Identifier used to correlate hotel API invocations across a multi-call business flows. - `PropertiesResponse.reservationStatus` (string) Status of reservation or offer completion. Enum: "Success", "Fail", "Partial", "Pending", "OnHold", "Retry", "Other" - `PropertiesResponse.Result` (object) Returns the error and/or warning message information, if applicable. - `PropertiesResponse.Result.@type` (string) Discriminator class Result only Example: Result - `PropertiesResponse.Result.status` (string) The status of an error or warning Enum: "Not processed", "Incomplete", "Complete", "Unknown" - `PropertiesResponse.Result.Error` (array) A list of error information returned at the provider level for a response. - `PropertiesResponse.Result.Error.@type` (string, required) Discriminator classes Error or ErrorDetail Example: ErrorDetail - `PropertiesResponse.Result.Error.StatusCode` (integer) Http standard response code Example: 200 - `PropertiesResponse.Result.Error.Message` (string) The Travelport standardized error or warning message Example: No flights found. - `PropertiesResponse.Result.Error.NameValuePair` (array) - `PropertiesResponse.Result.Error.NameValuePair.value` (string) Text directly related to name description, providing more detail. May have character restrictions based on remark type (e.g. Free Text limitations: 84 characters, alphanumeric and some special characters). Example: Sunday - `PropertiesResponse.Result.Error.NameValuePair.id` (string) Optional internally referenced id Example: 6 - `PropertiesResponse.Result.Error.NameValuePair.name` (string, required) Key, categorizing the type of remark or error. Example: Day1 - `PropertiesResponse.Result.Warning` (array) A list of warning information returned at the provider level for a response. - `PropertiesResponse.Result.Warning.@type` (string, required) Discriminator classes Warning or WarningDetail Example: WarningDetail - `PropertiesResponse.Result.Warning.StatusCode` (integer) Http standard response code Example: 200 - `PropertiesResponse.Result.Warning.Message` (string) The Travelport standardized error or warning message Example: Customer Loyalty could not be applied. - `PropertiesResponse.Result.Warning.NameValuePair` (array) - `PropertiesResponse.Identifier` (object) A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination). - `PropertiesResponse.Identifier.value` (string) Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. Example: A0656EFF-FAF4-456F-B061-0161008D7C4E - `PropertiesResponse.Identifier.authority` (string) Name of the supplier system that created this identifier - the source of information. For AirPrice, please note that GDS offers return the value 'Travelport' in authority while NDC offers return the carrier code of the issuing NDC carrier. When returned from Air Exchange Eligibility, authority is always 'Travelport' as the transaction issuer. For Hotels, authority indicates which supplier returned the lowest available rate for that property: either 'TVPT' (Travelport) or 'BKNG' (booking.com). Booking.com access requires additional provisioning and a direct agreement with the supplier. Authority is not returned if the property is closed or returns an error. For Hotel Create Reservation (Full Payload) and Sync Reservation send the value from the Availability response in CatalogOffering/Identifier/authority for the instance you want to book. Example: TVPT - `PropertiesResponse.NextSteps` (object) Container for the steps that describe actions that may be taken on the containing object. Not applicable for an Eligibility or Exchange response. - `PropertiesResponse.NextSteps.baseURI` (string, required) The base portion of the URI in order to shorten the uris in the individual steps - `PropertiesResponse.NextSteps.id` (string) Optional internally referenced id Example: 5 - `PropertiesResponse.NextSteps.NextStep` (array, required) - `PropertiesResponse.NextSteps.NextStep.value` (string) Example: www.resourcelocation.com - `PropertiesResponse.NextSteps.NextStep.id` (string) Identifier for the Next Step Example: 2 - `PropertiesResponse.NextSteps.NextStep.action` (string, required) The action this next step is intended to achieve Example: cancel - `PropertiesResponse.NextSteps.NextStep.method` (string, required) Describes the set of potential methods that can be taken after an operation. Enum: "GET", "DELETE", "PUT", "POST" - `PropertiesResponse.NextSteps.NextStep.description` (string) Additional clarification for the next step Example: remove offer from the order - `PropertiesResponse.ReferenceList` (array) - `PropertiesResponse.ReferenceList.@type` (string, required) Discriminator - Air Search child classes are ReferenceListAmenity, ReferenceListBrand, ReferenceListFlight, ReferenceListProduct, ReferenceListTermsAndConditions, and ReferenceListUniversalProductAttribute. - Air Price child classes are ReferenceListAmenity and ReferenceListBrand. - FareRules child class is ReferenceListFlight. - Search Ancillaries child class is ReferenceListFlight. - Seat Map child class is ReferenceListSeatingChart. - Hotel Availability child class is ReferenceListPropertyDates. - Reservation and Reservation Workbench child classes are ReferenceListAmenity, ReferenceListBrand, and ReferenceListUniversalProductAttribute. - Exchange Search child classes are ReferenceListBrand, ReferenceListFlight, and ReferenceListExchangedPrice. - Reservation Receipt child classes are ReferenceListOffer and ReferenceListTraveler. - Book_Traveler child class is ReferenceListTraveler. Example: ReferenceListFlight - `PropertiesResponse.ReferenceList.id` (string) Uniquely identifies for the Reference List - `PropertiesResponse.CurrencyRateConversion` (array) - `PropertiesResponse.CurrencyRateConversion.@type` (string) - `PropertiesResponse.CurrencyRateConversion.SourceCurrency` (object, required) Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `PropertiesResponse.CurrencyRateConversion.SourceCurrency.value` (string) An ISO 4217 currency code. Example: USD - `PropertiesResponse.CurrencyRateConversion.SourceCurrency.codeAuthority` (string) Currency code authority Example: ISO 4217 - `PropertiesResponse.CurrencyRateConversion.SourceCurrency.decimalPlace` (integer) Number of decimal places for the currency. Example: 4 - `PropertiesResponse.CurrencyRateConversion.SourceCurrency.decimalAuthority` (string) Currency code decimal authority Example: ISO 4217 - `PropertiesResponse.CurrencyRateConversion.ConversionRate` (object, required) Conversion rate of SourceCurrency value to TargetCurrency value. This value can be used to calculate, independently of the API, conversion for the rates in the response. The response does not convert any amounts. - `PropertiesResponse.CurrencyRateConversion.ConversionRate.value` (number) - `PropertiesResponse.CurrencyRateConversion.ConversionRate.rateAuthority` (string) Contextual rate authority Example: ISO 4217 - `PropertiesResponse.CurrencyRateConversion.ConversionRate.rateAsOf` (string) Rate as of Example: 2026-08-07T12:12:00Z - `PropertiesResponse.Pagination` (object) Pagination object used when result sets span across a number of pages. - `PropertiesResponse.Pagination.@type` (string, required) Example: Pagination - `PropertiesResponse.Pagination.page` (integer, required) The current page number of the full result set Example: 1 - `PropertiesResponse.Pagination.pageSize` (integer, required) The total number of items on this page Example: 20 - `PropertiesResponse.Pagination.totalPages` (integer, required) The total number of pages in this result set Example: 5 - `PropertiesResponse.Pagination.totalItems` (integer, required) The total number of pages in this result set Example: 100 ## Response 400 fields (application/json): - `@type` (string) Example: response - `transactionId` (string) A unique system-generated (128 bit GUID format) transaction/tracking id for a single request and response (i.e. for a single transaction) used for internal tracking and troubleshooting. Also known as E2ETrackingId. Not returned in all Hotel API responses. Example: 49f58f5f-c443-43b4-9f5d-be405fd00a01 - `traceId` (string) Used in hospitality workflows to provide a unique transaction or tracking id for a single request and response. For Air Eligibility, returned if a custom trace ID was sent in the request header. For Hotel Rules, returned if a custom trace ID was sent in the request header. Example: TraceID_123456 - `correlationId` (string) Identifier used to correlate hotel API invocations across a multi-call business flows. - `reservationStatus` (string) Status of reservation or offer completion. Enum: "Success", "Fail", "Partial", "Pending", "OnHold", "Retry", "Other" - `Result` (object) Returns the error and/or warning message information, if applicable. - `Result.@type` (string) Discriminator class Result only Example: Result - `Result.status` (string) The status of an error or warning Enum: "Not processed", "Incomplete", "Complete", "Unknown" - `Result.Error` (array) A list of error information returned at the provider level for a response. - `Result.Error.@type` (string, required) Discriminator classes Error or ErrorDetail Example: ErrorDetail - `Result.Error.StatusCode` (integer) Http standard response code Example: 200 - `Result.Error.Message` (string) The Travelport standardized error or warning message Example: No flights found. - `Result.Error.NameValuePair` (array) - `Result.Error.NameValuePair.value` (string) Text directly related to name description, providing more detail. May have character restrictions based on remark type (e.g. Free Text limitations: 84 characters, alphanumeric and some special characters). Example: Sunday - `Result.Error.NameValuePair.id` (string) Optional internally referenced id Example: 6 - `Result.Error.NameValuePair.name` (string, required) Key, categorizing the type of remark or error. Example: Day1 - `Result.Warning` (array) A list of warning information returned at the provider level for a response. - `Result.Warning.@type` (string, required) Discriminator classes Warning or WarningDetail Example: WarningDetail - `Result.Warning.StatusCode` (integer) Http standard response code Example: 200 - `Result.Warning.Message` (string) The Travelport standardized error or warning message Example: Customer Loyalty could not be applied. - `Result.Warning.NameValuePair` (array) - `Identifier` (object) A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination). - `Identifier.value` (string) Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. Example: A0656EFF-FAF4-456F-B061-0161008D7C4E - `Identifier.authority` (string) Name of the supplier system that created this identifier - the source of information. For AirPrice, please note that GDS offers return the value 'Travelport' in authority while NDC offers return the carrier code of the issuing NDC carrier. When returned from Air Exchange Eligibility, authority is always 'Travelport' as the transaction issuer. For Hotels, authority indicates which supplier returned the lowest available rate for that property: either 'TVPT' (Travelport) or 'BKNG' (booking.com). Booking.com access requires additional provisioning and a direct agreement with the supplier. Authority is not returned if the property is closed or returns an error. For Hotel Create Reservation (Full Payload) and Sync Reservation send the value from the Availability response in CatalogOffering/Identifier/authority for the instance you want to book. Example: TVPT - `NextSteps` (object) Container for the steps that describe actions that may be taken on the containing object. Not applicable for an Eligibility or Exchange response. - `NextSteps.baseURI` (string, required) The base portion of the URI in order to shorten the uris in the individual steps - `NextSteps.id` (string) Optional internally referenced id Example: 5 - `NextSteps.NextStep` (array, required) - `NextSteps.NextStep.value` (string) Example: www.resourcelocation.com - `NextSteps.NextStep.id` (string) Identifier for the Next Step Example: 2 - `NextSteps.NextStep.action` (string, required) The action this next step is intended to achieve Example: cancel - `NextSteps.NextStep.method` (string, required) Describes the set of potential methods that can be taken after an operation. Enum: "GET", "DELETE", "PUT", "POST" - `NextSteps.NextStep.description` (string) Additional clarification for the next step Example: remove offer from the order - `ReferenceList` (array) - `ReferenceList.@type` (string, required) Discriminator - Air Search child classes are ReferenceListAmenity, ReferenceListBrand, ReferenceListFlight, ReferenceListProduct, ReferenceListTermsAndConditions, and ReferenceListUniversalProductAttribute. - Air Price child classes are ReferenceListAmenity and ReferenceListBrand. - FareRules child class is ReferenceListFlight. - Search Ancillaries child class is ReferenceListFlight. - Seat Map child class is ReferenceListSeatingChart. - Hotel Availability child class is ReferenceListPropertyDates. - Reservation and Reservation Workbench child classes are ReferenceListAmenity, ReferenceListBrand, and ReferenceListUniversalProductAttribute. - Exchange Search child classes are ReferenceListBrand, ReferenceListFlight, and ReferenceListExchangedPrice. - Reservation Receipt child classes are ReferenceListOffer and ReferenceListTraveler. - Book_Traveler child class is ReferenceListTraveler. Example: ReferenceListFlight - `ReferenceList.id` (string) Uniquely identifies for the Reference List - `CurrencyRateConversion` (array) - `CurrencyRateConversion.@type` (string) - `CurrencyRateConversion.SourceCurrency` (object, required) Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `CurrencyRateConversion.SourceCurrency.value` (string) An ISO 4217 currency code. Example: USD - `CurrencyRateConversion.SourceCurrency.codeAuthority` (string) Currency code authority Example: ISO 4217 - `CurrencyRateConversion.SourceCurrency.decimalPlace` (integer) Number of decimal places for the currency. Example: 4 - `CurrencyRateConversion.SourceCurrency.decimalAuthority` (string) Currency code decimal authority Example: ISO 4217 - `CurrencyRateConversion.ConversionRate` (object, required) Conversion rate of SourceCurrency value to TargetCurrency value. This value can be used to calculate, independently of the API, conversion for the rates in the response. The response does not convert any amounts. - `CurrencyRateConversion.ConversionRate.value` (number) - `CurrencyRateConversion.ConversionRate.rateAuthority` (string) Contextual rate authority Example: ISO 4217 - `CurrencyRateConversion.ConversionRate.rateAsOf` (string) Rate as of Example: 2026-08-07T12:12:00Z - `Pagination` (object) Pagination object used when result sets span across a number of pages. - `Pagination.@type` (string, required) Example: Pagination - `Pagination.page` (integer, required) The current page number of the full result set Example: 1 - `Pagination.pageSize` (integer, required) The total number of items on this page Example: 20 - `Pagination.totalPages` (integer, required) The total number of pages in this result set Example: 5 - `Pagination.totalItems` (integer, required) The total number of pages in this result set Example: 100 ## Response 401 fields (application/json): - `@type` (string) Example: response - `transactionId` (string) A unique system-generated (128 bit GUID format) transaction/tracking id for a single request and response (i.e. for a single transaction) used for internal tracking and troubleshooting. Also known as E2ETrackingId. Not returned in all Hotel API responses. Example: 49f58f5f-c443-43b4-9f5d-be405fd00a01 - `traceId` (string) Used in hospitality workflows to provide a unique transaction or tracking id for a single request and response. For Air Eligibility, returned if a custom trace ID was sent in the request header. For Hotel Rules, returned if a custom trace ID was sent in the request header. Example: TraceID_123456 - `correlationId` (string) Identifier used to correlate hotel API invocations across a multi-call business flows. - `reservationStatus` (string) Status of reservation or offer completion. Enum: "Success", "Fail", "Partial", "Pending", "OnHold", "Retry", "Other" - `Result` (object) Returns the error and/or warning message information, if applicable. - `Result.@type` (string) Discriminator class Result only Example: Result - `Result.status` (string) The status of an error or warning Enum: "Not processed", "Incomplete", "Complete", "Unknown" - `Result.Error` (array) A list of error information returned at the provider level for a response. - `Result.Error.@type` (string, required) Discriminator classes Error or ErrorDetail Example: ErrorDetail - `Result.Error.StatusCode` (integer) Http standard response code Example: 200 - `Result.Error.Message` (string) The Travelport standardized error or warning message Example: No flights found. - `Result.Error.NameValuePair` (array) - `Result.Error.NameValuePair.value` (string) Text directly related to name description, providing more detail. May have character restrictions based on remark type (e.g. Free Text limitations: 84 characters, alphanumeric and some special characters). Example: Sunday - `Result.Error.NameValuePair.id` (string) Optional internally referenced id Example: 6 - `Result.Error.NameValuePair.name` (string, required) Key, categorizing the type of remark or error. Example: Day1 - `Result.Warning` (array) A list of warning information returned at the provider level for a response. - `Result.Warning.@type` (string, required) Discriminator classes Warning or WarningDetail Example: WarningDetail - `Result.Warning.StatusCode` (integer) Http standard response code Example: 200 - `Result.Warning.Message` (string) The Travelport standardized error or warning message Example: Customer Loyalty could not be applied. - `Result.Warning.NameValuePair` (array) - `Identifier` (object) A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination). - `Identifier.value` (string) Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. Example: A0656EFF-FAF4-456F-B061-0161008D7C4E - `Identifier.authority` (string) Name of the supplier system that created this identifier - the source of information. For AirPrice, please note that GDS offers return the value 'Travelport' in authority while NDC offers return the carrier code of the issuing NDC carrier. When returned from Air Exchange Eligibility, authority is always 'Travelport' as the transaction issuer. For Hotels, authority indicates which supplier returned the lowest available rate for that property: either 'TVPT' (Travelport) or 'BKNG' (booking.com). Booking.com access requires additional provisioning and a direct agreement with the supplier. Authority is not returned if the property is closed or returns an error. For Hotel Create Reservation (Full Payload) and Sync Reservation send the value from the Availability response in CatalogOffering/Identifier/authority for the instance you want to book. Example: TVPT - `NextSteps` (object) Container for the steps that describe actions that may be taken on the containing object. Not applicable for an Eligibility or Exchange response. - `NextSteps.baseURI` (string, required) The base portion of the URI in order to shorten the uris in the individual steps - `NextSteps.id` (string) Optional internally referenced id Example: 5 - `NextSteps.NextStep` (array, required) - `NextSteps.NextStep.value` (string) Example: www.resourcelocation.com - `NextSteps.NextStep.id` (string) Identifier for the Next Step Example: 2 - `NextSteps.NextStep.action` (string, required) The action this next step is intended to achieve Example: cancel - `NextSteps.NextStep.method` (string, required) Describes the set of potential methods that can be taken after an operation. Enum: "GET", "DELETE", "PUT", "POST" - `NextSteps.NextStep.description` (string) Additional clarification for the next step Example: remove offer from the order - `ReferenceList` (array) - `ReferenceList.@type` (string, required) Discriminator - Air Search child classes are ReferenceListAmenity, ReferenceListBrand, ReferenceListFlight, ReferenceListProduct, ReferenceListTermsAndConditions, and ReferenceListUniversalProductAttribute. - Air Price child classes are ReferenceListAmenity and ReferenceListBrand. - FareRules child class is ReferenceListFlight. - Search Ancillaries child class is ReferenceListFlight. - Seat Map child class is ReferenceListSeatingChart. - Hotel Availability child class is ReferenceListPropertyDates. - Reservation and Reservation Workbench child classes are ReferenceListAmenity, ReferenceListBrand, and ReferenceListUniversalProductAttribute. - Exchange Search child classes are ReferenceListBrand, ReferenceListFlight, and ReferenceListExchangedPrice. - Reservation Receipt child classes are ReferenceListOffer and ReferenceListTraveler. - Book_Traveler child class is ReferenceListTraveler. Example: ReferenceListFlight - `ReferenceList.id` (string) Uniquely identifies for the Reference List - `CurrencyRateConversion` (array) - `CurrencyRateConversion.@type` (string) - `CurrencyRateConversion.SourceCurrency` (object, required) Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `CurrencyRateConversion.SourceCurrency.value` (string) An ISO 4217 currency code. Example: USD - `CurrencyRateConversion.SourceCurrency.codeAuthority` (string) Currency code authority Example: ISO 4217 - `CurrencyRateConversion.SourceCurrency.decimalPlace` (integer) Number of decimal places for the currency. Example: 4 - `CurrencyRateConversion.SourceCurrency.decimalAuthority` (string) Currency code decimal authority Example: ISO 4217 - `CurrencyRateConversion.ConversionRate` (object, required) Conversion rate of SourceCurrency value to TargetCurrency value. This value can be used to calculate, independently of the API, conversion for the rates in the response. The response does not convert any amounts. - `CurrencyRateConversion.ConversionRate.value` (number) - `CurrencyRateConversion.ConversionRate.rateAuthority` (string) Contextual rate authority Example: ISO 4217 - `CurrencyRateConversion.ConversionRate.rateAsOf` (string) Rate as of Example: 2026-08-07T12:12:00Z - `Pagination` (object) Pagination object used when result sets span across a number of pages. - `Pagination.@type` (string, required) Example: Pagination - `Pagination.page` (integer, required) The current page number of the full result set Example: 1 - `Pagination.pageSize` (integer, required) The total number of items on this page Example: 20 - `Pagination.totalPages` (integer, required) The total number of pages in this result set Example: 5 - `Pagination.totalItems` (integer, required) The total number of pages in this result set Example: 100 ## Response 402 fields (application/json): - `@type` (string) Example: response - `transactionId` (string) A unique system-generated (128 bit GUID format) transaction/tracking id for a single request and response (i.e. for a single transaction) used for internal tracking and troubleshooting. Also known as E2ETrackingId. Not returned in all Hotel API responses. Example: 49f58f5f-c443-43b4-9f5d-be405fd00a01 - `traceId` (string) Used in hospitality workflows to provide a unique transaction or tracking id for a single request and response. For Air Eligibility, returned if a custom trace ID was sent in the request header. For Hotel Rules, returned if a custom trace ID was sent in the request header. Example: TraceID_123456 - `correlationId` (string) Identifier used to correlate hotel API invocations across a multi-call business flows. - `reservationStatus` (string) Status of reservation or offer completion. Enum: "Success", "Fail", "Partial", "Pending", "OnHold", "Retry", "Other" - `Result` (object) Returns the error and/or warning message information, if applicable. - `Result.@type` (string) Discriminator class Result only Example: Result - `Result.status` (string) The status of an error or warning Enum: "Not processed", "Incomplete", "Complete", "Unknown" - `Result.Error` (array) A list of error information returned at the provider level for a response. - `Result.Error.@type` (string, required) Discriminator classes Error or ErrorDetail Example: ErrorDetail - `Result.Error.StatusCode` (integer) Http standard response code Example: 200 - `Result.Error.Message` (string) The Travelport standardized error or warning message Example: No flights found. - `Result.Error.NameValuePair` (array) - `Result.Error.NameValuePair.value` (string) Text directly related to name description, providing more detail. May have character restrictions based on remark type (e.g. Free Text limitations: 84 characters, alphanumeric and some special characters). Example: Sunday - `Result.Error.NameValuePair.id` (string) Optional internally referenced id Example: 6 - `Result.Error.NameValuePair.name` (string, required) Key, categorizing the type of remark or error. Example: Day1 - `Result.Warning` (array) A list of warning information returned at the provider level for a response. - `Result.Warning.@type` (string, required) Discriminator classes Warning or WarningDetail Example: WarningDetail - `Result.Warning.StatusCode` (integer) Http standard response code Example: 200 - `Result.Warning.Message` (string) The Travelport standardized error or warning message Example: Customer Loyalty could not be applied. - `Result.Warning.NameValuePair` (array) - `Identifier` (object) A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination). - `Identifier.value` (string) Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. Example: A0656EFF-FAF4-456F-B061-0161008D7C4E - `Identifier.authority` (string) Name of the supplier system that created this identifier - the source of information. For AirPrice, please note that GDS offers return the value 'Travelport' in authority while NDC offers return the carrier code of the issuing NDC carrier. When returned from Air Exchange Eligibility, authority is always 'Travelport' as the transaction issuer. For Hotels, authority indicates which supplier returned the lowest available rate for that property: either 'TVPT' (Travelport) or 'BKNG' (booking.com). Booking.com access requires additional provisioning and a direct agreement with the supplier. Authority is not returned if the property is closed or returns an error. For Hotel Create Reservation (Full Payload) and Sync Reservation send the value from the Availability response in CatalogOffering/Identifier/authority for the instance you want to book. Example: TVPT - `NextSteps` (object) Container for the steps that describe actions that may be taken on the containing object. Not applicable for an Eligibility or Exchange response. - `NextSteps.baseURI` (string, required) The base portion of the URI in order to shorten the uris in the individual steps - `NextSteps.id` (string) Optional internally referenced id Example: 5 - `NextSteps.NextStep` (array, required) - `NextSteps.NextStep.value` (string) Example: www.resourcelocation.com - `NextSteps.NextStep.id` (string) Identifier for the Next Step Example: 2 - `NextSteps.NextStep.action` (string, required) The action this next step is intended to achieve Example: cancel - `NextSteps.NextStep.method` (string, required) Describes the set of potential methods that can be taken after an operation. Enum: "GET", "DELETE", "PUT", "POST" - `NextSteps.NextStep.description` (string) Additional clarification for the next step Example: remove offer from the order - `ReferenceList` (array) - `ReferenceList.@type` (string, required) Discriminator - Air Search child classes are ReferenceListAmenity, ReferenceListBrand, ReferenceListFlight, ReferenceListProduct, ReferenceListTermsAndConditions, and ReferenceListUniversalProductAttribute. - Air Price child classes are ReferenceListAmenity and ReferenceListBrand. - FareRules child class is ReferenceListFlight. - Search Ancillaries child class is ReferenceListFlight. - Seat Map child class is ReferenceListSeatingChart. - Hotel Availability child class is ReferenceListPropertyDates. - Reservation and Reservation Workbench child classes are ReferenceListAmenity, ReferenceListBrand, and ReferenceListUniversalProductAttribute. - Exchange Search child classes are ReferenceListBrand, ReferenceListFlight, and ReferenceListExchangedPrice. - Reservation Receipt child classes are ReferenceListOffer and ReferenceListTraveler. - Book_Traveler child class is ReferenceListTraveler. Example: ReferenceListFlight - `ReferenceList.id` (string) Uniquely identifies for the Reference List - `CurrencyRateConversion` (array) - `CurrencyRateConversion.@type` (string) - `CurrencyRateConversion.SourceCurrency` (object, required) Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `CurrencyRateConversion.SourceCurrency.value` (string) An ISO 4217 currency code. Example: USD - `CurrencyRateConversion.SourceCurrency.codeAuthority` (string) Currency code authority Example: ISO 4217 - `CurrencyRateConversion.SourceCurrency.decimalPlace` (integer) Number of decimal places for the currency. Example: 4 - `CurrencyRateConversion.SourceCurrency.decimalAuthority` (string) Currency code decimal authority Example: ISO 4217 - `CurrencyRateConversion.ConversionRate` (object, required) Conversion rate of SourceCurrency value to TargetCurrency value. This value can be used to calculate, independently of the API, conversion for the rates in the response. The response does not convert any amounts. - `CurrencyRateConversion.ConversionRate.value` (number) - `CurrencyRateConversion.ConversionRate.rateAuthority` (string) Contextual rate authority Example: ISO 4217 - `CurrencyRateConversion.ConversionRate.rateAsOf` (string) Rate as of Example: 2026-08-07T12:12:00Z - `Pagination` (object) Pagination object used when result sets span across a number of pages. - `Pagination.@type` (string, required) Example: Pagination - `Pagination.page` (integer, required) The current page number of the full result set Example: 1 - `Pagination.pageSize` (integer, required) The total number of items on this page Example: 20 - `Pagination.totalPages` (integer, required) The total number of pages in this result set Example: 5 - `Pagination.totalItems` (integer, required) The total number of pages in this result set Example: 100 ## Response 403 fields (application/json): - `@type` (string) Example: response - `transactionId` (string) A unique system-generated (128 bit GUID format) transaction/tracking id for a single request and response (i.e. for a single transaction) used for internal tracking and troubleshooting. Also known as E2ETrackingId. Not returned in all Hotel API responses. Example: 49f58f5f-c443-43b4-9f5d-be405fd00a01 - `traceId` (string) Used in hospitality workflows to provide a unique transaction or tracking id for a single request and response. For Air Eligibility, returned if a custom trace ID was sent in the request header. For Hotel Rules, returned if a custom trace ID was sent in the request header. Example: TraceID_123456 - `correlationId` (string) Identifier used to correlate hotel API invocations across a multi-call business flows. - `reservationStatus` (string) Status of reservation or offer completion. Enum: "Success", "Fail", "Partial", "Pending", "OnHold", "Retry", "Other" - `Result` (object) Returns the error and/or warning message information, if applicable. - `Result.@type` (string) Discriminator class Result only Example: Result - `Result.status` (string) The status of an error or warning Enum: "Not processed", "Incomplete", "Complete", "Unknown" - `Result.Error` (array) A list of error information returned at the provider level for a response. - `Result.Error.@type` (string, required) Discriminator classes Error or ErrorDetail Example: ErrorDetail - `Result.Error.StatusCode` (integer) Http standard response code Example: 200 - `Result.Error.Message` (string) The Travelport standardized error or warning message Example: No flights found. - `Result.Error.NameValuePair` (array) - `Result.Error.NameValuePair.value` (string) Text directly related to name description, providing more detail. May have character restrictions based on remark type (e.g. Free Text limitations: 84 characters, alphanumeric and some special characters). Example: Sunday - `Result.Error.NameValuePair.id` (string) Optional internally referenced id Example: 6 - `Result.Error.NameValuePair.name` (string, required) Key, categorizing the type of remark or error. Example: Day1 - `Result.Warning` (array) A list of warning information returned at the provider level for a response. - `Result.Warning.@type` (string, required) Discriminator classes Warning or WarningDetail Example: WarningDetail - `Result.Warning.StatusCode` (integer) Http standard response code Example: 200 - `Result.Warning.Message` (string) The Travelport standardized error or warning message Example: Customer Loyalty could not be applied. - `Result.Warning.NameValuePair` (array) - `Identifier` (object) A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination). - `Identifier.value` (string) Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. Example: A0656EFF-FAF4-456F-B061-0161008D7C4E - `Identifier.authority` (string) Name of the supplier system that created this identifier - the source of information. For AirPrice, please note that GDS offers return the value 'Travelport' in authority while NDC offers return the carrier code of the issuing NDC carrier. When returned from Air Exchange Eligibility, authority is always 'Travelport' as the transaction issuer. For Hotels, authority indicates which supplier returned the lowest available rate for that property: either 'TVPT' (Travelport) or 'BKNG' (booking.com). Booking.com access requires additional provisioning and a direct agreement with the supplier. Authority is not returned if the property is closed or returns an error. For Hotel Create Reservation (Full Payload) and Sync Reservation send the value from the Availability response in CatalogOffering/Identifier/authority for the instance you want to book. Example: TVPT - `NextSteps` (object) Container for the steps that describe actions that may be taken on the containing object. Not applicable for an Eligibility or Exchange response. - `NextSteps.baseURI` (string, required) The base portion of the URI in order to shorten the uris in the individual steps - `NextSteps.id` (string) Optional internally referenced id Example: 5 - `NextSteps.NextStep` (array, required) - `NextSteps.NextStep.value` (string) Example: www.resourcelocation.com - `NextSteps.NextStep.id` (string) Identifier for the Next Step Example: 2 - `NextSteps.NextStep.action` (string, required) The action this next step is intended to achieve Example: cancel - `NextSteps.NextStep.method` (string, required) Describes the set of potential methods that can be taken after an operation. Enum: "GET", "DELETE", "PUT", "POST" - `NextSteps.NextStep.description` (string) Additional clarification for the next step Example: remove offer from the order - `ReferenceList` (array) - `ReferenceList.@type` (string, required) Discriminator - Air Search child classes are ReferenceListAmenity, ReferenceListBrand, ReferenceListFlight, ReferenceListProduct, ReferenceListTermsAndConditions, and ReferenceListUniversalProductAttribute. - Air Price child classes are ReferenceListAmenity and ReferenceListBrand. - FareRules child class is ReferenceListFlight. - Search Ancillaries child class is ReferenceListFlight. - Seat Map child class is ReferenceListSeatingChart. - Hotel Availability child class is ReferenceListPropertyDates. - Reservation and Reservation Workbench child classes are ReferenceListAmenity, ReferenceListBrand, and ReferenceListUniversalProductAttribute. - Exchange Search child classes are ReferenceListBrand, ReferenceListFlight, and ReferenceListExchangedPrice. - Reservation Receipt child classes are ReferenceListOffer and ReferenceListTraveler. - Book_Traveler child class is ReferenceListTraveler. Example: ReferenceListFlight - `ReferenceList.id` (string) Uniquely identifies for the Reference List - `CurrencyRateConversion` (array) - `CurrencyRateConversion.@type` (string) - `CurrencyRateConversion.SourceCurrency` (object, required) Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `CurrencyRateConversion.SourceCurrency.value` (string) An ISO 4217 currency code. Example: USD - `CurrencyRateConversion.SourceCurrency.codeAuthority` (string) Currency code authority Example: ISO 4217 - `CurrencyRateConversion.SourceCurrency.decimalPlace` (integer) Number of decimal places for the currency. Example: 4 - `CurrencyRateConversion.SourceCurrency.decimalAuthority` (string) Currency code decimal authority Example: ISO 4217 - `CurrencyRateConversion.ConversionRate` (object, required) Conversion rate of SourceCurrency value to TargetCurrency value. This value can be used to calculate, independently of the API, conversion for the rates in the response. The response does not convert any amounts. - `CurrencyRateConversion.ConversionRate.value` (number) - `CurrencyRateConversion.ConversionRate.rateAuthority` (string) Contextual rate authority Example: ISO 4217 - `CurrencyRateConversion.ConversionRate.rateAsOf` (string) Rate as of Example: 2026-08-07T12:12:00Z - `Pagination` (object) Pagination object used when result sets span across a number of pages. - `Pagination.@type` (string, required) Example: Pagination - `Pagination.page` (integer, required) The current page number of the full result set Example: 1 - `Pagination.pageSize` (integer, required) The total number of items on this page Example: 20 - `Pagination.totalPages` (integer, required) The total number of pages in this result set Example: 5 - `Pagination.totalItems` (integer, required) The total number of pages in this result set Example: 100 ## Response 404 fields (application/json): - `@type` (string) Example: response - `transactionId` (string) A unique system-generated (128 bit GUID format) transaction/tracking id for a single request and response (i.e. for a single transaction) used for internal tracking and troubleshooting. Also known as E2ETrackingId. Not returned in all Hotel API responses. Example: 49f58f5f-c443-43b4-9f5d-be405fd00a01 - `traceId` (string) Used in hospitality workflows to provide a unique transaction or tracking id for a single request and response. For Air Eligibility, returned if a custom trace ID was sent in the request header. For Hotel Rules, returned if a custom trace ID was sent in the request header. Example: TraceID_123456 - `correlationId` (string) Identifier used to correlate hotel API invocations across a multi-call business flows. - `reservationStatus` (string) Status of reservation or offer completion. Enum: "Success", "Fail", "Partial", "Pending", "OnHold", "Retry", "Other" - `Result` (object) Returns the error and/or warning message information, if applicable. - `Result.@type` (string) Discriminator class Result only Example: Result - `Result.status` (string) The status of an error or warning Enum: "Not processed", "Incomplete", "Complete", "Unknown" - `Result.Error` (array) A list of error information returned at the provider level for a response. - `Result.Error.@type` (string, required) Discriminator classes Error or ErrorDetail Example: ErrorDetail - `Result.Error.StatusCode` (integer) Http standard response code Example: 200 - `Result.Error.Message` (string) The Travelport standardized error or warning message Example: No flights found. - `Result.Error.NameValuePair` (array) - `Result.Error.NameValuePair.value` (string) Text directly related to name description, providing more detail. May have character restrictions based on remark type (e.g. Free Text limitations: 84 characters, alphanumeric and some special characters). Example: Sunday - `Result.Error.NameValuePair.id` (string) Optional internally referenced id Example: 6 - `Result.Error.NameValuePair.name` (string, required) Key, categorizing the type of remark or error. Example: Day1 - `Result.Warning` (array) A list of warning information returned at the provider level for a response. - `Result.Warning.@type` (string, required) Discriminator classes Warning or WarningDetail Example: WarningDetail - `Result.Warning.StatusCode` (integer) Http standard response code Example: 200 - `Result.Warning.Message` (string) The Travelport standardized error or warning message Example: Customer Loyalty could not be applied. - `Result.Warning.NameValuePair` (array) - `Identifier` (object) A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination). - `Identifier.value` (string) Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. Example: A0656EFF-FAF4-456F-B061-0161008D7C4E - `Identifier.authority` (string) Name of the supplier system that created this identifier - the source of information. For AirPrice, please note that GDS offers return the value 'Travelport' in authority while NDC offers return the carrier code of the issuing NDC carrier. When returned from Air Exchange Eligibility, authority is always 'Travelport' as the transaction issuer. For Hotels, authority indicates which supplier returned the lowest available rate for that property: either 'TVPT' (Travelport) or 'BKNG' (booking.com). Booking.com access requires additional provisioning and a direct agreement with the supplier. Authority is not returned if the property is closed or returns an error. For Hotel Create Reservation (Full Payload) and Sync Reservation send the value from the Availability response in CatalogOffering/Identifier/authority for the instance you want to book. Example: TVPT - `NextSteps` (object) Container for the steps that describe actions that may be taken on the containing object. Not applicable for an Eligibility or Exchange response. - `NextSteps.baseURI` (string, required) The base portion of the URI in order to shorten the uris in the individual steps - `NextSteps.id` (string) Optional internally referenced id Example: 5 - `NextSteps.NextStep` (array, required) - `NextSteps.NextStep.value` (string) Example: www.resourcelocation.com - `NextSteps.NextStep.id` (string) Identifier for the Next Step Example: 2 - `NextSteps.NextStep.action` (string, required) The action this next step is intended to achieve Example: cancel - `NextSteps.NextStep.method` (string, required) Describes the set of potential methods that can be taken after an operation. Enum: "GET", "DELETE", "PUT", "POST" - `NextSteps.NextStep.description` (string) Additional clarification for the next step Example: remove offer from the order - `ReferenceList` (array) - `ReferenceList.@type` (string, required) Discriminator - Air Search child classes are ReferenceListAmenity, ReferenceListBrand, ReferenceListFlight, ReferenceListProduct, ReferenceListTermsAndConditions, and ReferenceListUniversalProductAttribute. - Air Price child classes are ReferenceListAmenity and ReferenceListBrand. - FareRules child class is ReferenceListFlight. - Search Ancillaries child class is ReferenceListFlight. - Seat Map child class is ReferenceListSeatingChart. - Hotel Availability child class is ReferenceListPropertyDates. - Reservation and Reservation Workbench child classes are ReferenceListAmenity, ReferenceListBrand, and ReferenceListUniversalProductAttribute. - Exchange Search child classes are ReferenceListBrand, ReferenceListFlight, and ReferenceListExchangedPrice. - Reservation Receipt child classes are ReferenceListOffer and ReferenceListTraveler. - Book_Traveler child class is ReferenceListTraveler. Example: ReferenceListFlight - `ReferenceList.id` (string) Uniquely identifies for the Reference List - `CurrencyRateConversion` (array) - `CurrencyRateConversion.@type` (string) - `CurrencyRateConversion.SourceCurrency` (object, required) Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `CurrencyRateConversion.SourceCurrency.value` (string) An ISO 4217 currency code. Example: USD - `CurrencyRateConversion.SourceCurrency.codeAuthority` (string) Currency code authority Example: ISO 4217 - `CurrencyRateConversion.SourceCurrency.decimalPlace` (integer) Number of decimal places for the currency. Example: 4 - `CurrencyRateConversion.SourceCurrency.decimalAuthority` (string) Currency code decimal authority Example: ISO 4217 - `CurrencyRateConversion.ConversionRate` (object, required) Conversion rate of SourceCurrency value to TargetCurrency value. This value can be used to calculate, independently of the API, conversion for the rates in the response. The response does not convert any amounts. - `CurrencyRateConversion.ConversionRate.value` (number) - `CurrencyRateConversion.ConversionRate.rateAuthority` (string) Contextual rate authority Example: ISO 4217 - `CurrencyRateConversion.ConversionRate.rateAsOf` (string) Rate as of Example: 2026-08-07T12:12:00Z - `Pagination` (object) Pagination object used when result sets span across a number of pages. - `Pagination.@type` (string, required) Example: Pagination - `Pagination.page` (integer, required) The current page number of the full result set Example: 1 - `Pagination.pageSize` (integer, required) The total number of items on this page Example: 20 - `Pagination.totalPages` (integer, required) The total number of pages in this result set Example: 5 - `Pagination.totalItems` (integer, required) The total number of pages in this result set Example: 100 ## Response 500 fields (application/json): - `@type` (string) Example: response - `transactionId` (string) A unique system-generated (128 bit GUID format) transaction/tracking id for a single request and response (i.e. for a single transaction) used for internal tracking and troubleshooting. Also known as E2ETrackingId. Not returned in all Hotel API responses. Example: 49f58f5f-c443-43b4-9f5d-be405fd00a01 - `traceId` (string) Used in hospitality workflows to provide a unique transaction or tracking id for a single request and response. For Air Eligibility, returned if a custom trace ID was sent in the request header. For Hotel Rules, returned if a custom trace ID was sent in the request header. Example: TraceID_123456 - `correlationId` (string) Identifier used to correlate hotel API invocations across a multi-call business flows. - `reservationStatus` (string) Status of reservation or offer completion. Enum: "Success", "Fail", "Partial", "Pending", "OnHold", "Retry", "Other" - `Result` (object) Returns the error and/or warning message information, if applicable. - `Result.@type` (string) Discriminator class Result only Example: Result - `Result.status` (string) The status of an error or warning Enum: "Not processed", "Incomplete", "Complete", "Unknown" - `Result.Error` (array) A list of error information returned at the provider level for a response. - `Result.Error.@type` (string, required) Discriminator classes Error or ErrorDetail Example: ErrorDetail - `Result.Error.StatusCode` (integer) Http standard response code Example: 200 - `Result.Error.Message` (string) The Travelport standardized error or warning message Example: No flights found. - `Result.Error.NameValuePair` (array) - `Result.Error.NameValuePair.value` (string) Text directly related to name description, providing more detail. May have character restrictions based on remark type (e.g. Free Text limitations: 84 characters, alphanumeric and some special characters). Example: Sunday - `Result.Error.NameValuePair.id` (string) Optional internally referenced id Example: 6 - `Result.Error.NameValuePair.name` (string, required) Key, categorizing the type of remark or error. Example: Day1 - `Result.Warning` (array) A list of warning information returned at the provider level for a response. - `Result.Warning.@type` (string, required) Discriminator classes Warning or WarningDetail Example: WarningDetail - `Result.Warning.StatusCode` (integer) Http standard response code Example: 200 - `Result.Warning.Message` (string) The Travelport standardized error or warning message Example: Customer Loyalty could not be applied. - `Result.Warning.NameValuePair` (array) - `Identifier` (object) A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination). - `Identifier.value` (string) Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request. Example: A0656EFF-FAF4-456F-B061-0161008D7C4E - `Identifier.authority` (string) Name of the supplier system that created this identifier - the source of information. For AirPrice, please note that GDS offers return the value 'Travelport' in authority while NDC offers return the carrier code of the issuing NDC carrier. When returned from Air Exchange Eligibility, authority is always 'Travelport' as the transaction issuer. For Hotels, authority indicates which supplier returned the lowest available rate for that property: either 'TVPT' (Travelport) or 'BKNG' (booking.com). Booking.com access requires additional provisioning and a direct agreement with the supplier. Authority is not returned if the property is closed or returns an error. For Hotel Create Reservation (Full Payload) and Sync Reservation send the value from the Availability response in CatalogOffering/Identifier/authority for the instance you want to book. Example: TVPT - `NextSteps` (object) Container for the steps that describe actions that may be taken on the containing object. Not applicable for an Eligibility or Exchange response. - `NextSteps.baseURI` (string, required) The base portion of the URI in order to shorten the uris in the individual steps - `NextSteps.id` (string) Optional internally referenced id Example: 5 - `NextSteps.NextStep` (array, required) - `NextSteps.NextStep.value` (string) Example: www.resourcelocation.com - `NextSteps.NextStep.id` (string) Identifier for the Next Step Example: 2 - `NextSteps.NextStep.action` (string, required) The action this next step is intended to achieve Example: cancel - `NextSteps.NextStep.method` (string, required) Describes the set of potential methods that can be taken after an operation. Enum: "GET", "DELETE", "PUT", "POST" - `NextSteps.NextStep.description` (string) Additional clarification for the next step Example: remove offer from the order - `ReferenceList` (array) - `ReferenceList.@type` (string, required) Discriminator - Air Search child classes are ReferenceListAmenity, ReferenceListBrand, ReferenceListFlight, ReferenceListProduct, ReferenceListTermsAndConditions, and ReferenceListUniversalProductAttribute. - Air Price child classes are ReferenceListAmenity and ReferenceListBrand. - FareRules child class is ReferenceListFlight. - Search Ancillaries child class is ReferenceListFlight. - Seat Map child class is ReferenceListSeatingChart. - Hotel Availability child class is ReferenceListPropertyDates. - Reservation and Reservation Workbench child classes are ReferenceListAmenity, ReferenceListBrand, and ReferenceListUniversalProductAttribute. - Exchange Search child classes are ReferenceListBrand, ReferenceListFlight, and ReferenceListExchangedPrice. - Reservation Receipt child classes are ReferenceListOffer and ReferenceListTraveler. - Book_Traveler child class is ReferenceListTraveler. Example: ReferenceListFlight - `ReferenceList.id` (string) Uniquely identifies for the Reference List - `CurrencyRateConversion` (array) - `CurrencyRateConversion.@type` (string) - `CurrencyRateConversion.SourceCurrency` (object, required) Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency. - `CurrencyRateConversion.SourceCurrency.value` (string) An ISO 4217 currency code. Example: USD - `CurrencyRateConversion.SourceCurrency.codeAuthority` (string) Currency code authority Example: ISO 4217 - `CurrencyRateConversion.SourceCurrency.decimalPlace` (integer) Number of decimal places for the currency. Example: 4 - `CurrencyRateConversion.SourceCurrency.decimalAuthority` (string) Currency code decimal authority Example: ISO 4217 - `CurrencyRateConversion.ConversionRate` (object, required) Conversion rate of SourceCurrency value to TargetCurrency value. This value can be used to calculate, independently of the API, conversion for the rates in the response. The response does not convert any amounts. - `CurrencyRateConversion.ConversionRate.value` (number) - `CurrencyRateConversion.ConversionRate.rateAuthority` (string) Contextual rate authority Example: ISO 4217 - `CurrencyRateConversion.ConversionRate.rateAsOf` (string) Rate as of Example: 2026-08-07T12:12:00Z - `Pagination` (object) Pagination object used when result sets span across a number of pages. - `Pagination.@type` (string, required) Example: Pagination - `Pagination.page` (integer, required) The current page number of the full result set Example: 1 - `Pagination.pageSize` (integer, required) The total number of items on this page Example: 20 - `Pagination.totalPages` (integer, required) The total number of pages in this result set Example: 5 - `Pagination.totalItems` (integer, required) The total number of pages in this result set Example: 100