Exchange Search API Reference

POST

exchangesearch/catalogofferingsairchange

Base path:

Use this base path if you have not yet received or not migrated to the new credentials from Travelport:

Pre-production https://api.pp.travelport.com/11/

Production https://api.travelport.com/11/

Use this base path after you have migrated to the new credentials from Travelport (using .net instead of .com):

Pre-production https://api.pp.travelport.net/11/

Production https://api.travelport.net/11/

The base path for this API varies from that for other JSON Air APIs and does not include air at the end.

Related Content: Exchange, Refund, and Void Guide

GDS only. For NDC exchange functionality, see the Exchange, Refund, and Void Guide.

Exchange Search is the second step in the GDS exchange workflow, after the optional Eligibility step. It searches for an alternate itinerary for a possible exchange on a currently ticketed GDS itinerary. The response details any differences in base fare, taxes, fees, and total price between the currently ticketed itinerary and the possible new itinerary. It should be followed by an Add/Modify Offer request to select a new itinerary from these search results.

When exchanging multi-offer tickets, you must exchange each offer in its own workbench session. See Multi-offer Exchanges.

Request

As part of the request requirements, also see Authentication and Common Air Headers.

Query Parameters

None.

Request Body

See the Exchange, Refund, and Void Guide for important information about requirements for exchanges.

Show Exchange Search Basic Request Body Table

See the Optional Modifiers table next for optional search modifiers that can be added to this basic request.

Object	Description	Required/Optional
CatalogOfferingsQueryAirChange	Top level object for request. Includes CatalogOfferingsAirChangeRequest.	Required
CatalogOfferingsAirChangeRequest	Top level object. Includes SearchCriteriaFlight, PassengerCriteria, and BuildFromReservationWorkbench. Includes PricingModifiersAirChange and SearchModifiersAir if any optional search modifiers detailed in the table below are sent. Send with "@type": "CatalogOfferingsAirChangeRequestReservation",	Required
returnBrandedFaresInd	By default Exchange Search returns branded fares. Set to false to disable the return of branded fares.	Optional
detailViewInd	Returns a detailed response. Set to true to return a tax breakdown and branded fare attributes (see the Air Shopping Guide for more about brand attributes). Set to false to disable the return of details. A detailed response includes the following additional or expanded detail elements: In the detailed response only, both Price and ModifyPrice include a PriceBreakdown object to list taxes and fees separately if applicable. When branded fares are requested with returnBrandedFaresInd above: In the summary response, each offer returns limited brand details (brand name, tier, and id) for each flight in PassengerFlight/Brand. In the detailed response, brand details for each flight are consolidated in the ReferenceListBrand object, which includes name, tier, id, and brand attributes if available. PassengerFlight/Brand returns only a brand identifier and a cross-reference for the corresponding instance of ReferenceListBrand .	Optional
SearchCriteriaFlight	Array. Defines one origin and destination (O&D) pair. Send one SearchCriteriaFlight for each O&D pair, or leg. Includes From and To objects.	Required
departureDate	String. Date of departure in YYYY-MM-DD format (e.g., departureDate="2022-12-06").	Required
departureTime	String. Time of departure in HH:MM:SS format (e.g., departureTime="18:00:00"). departureTime is required on a same-day flight, i.e., when searching for multiple legs on the same day.	Optional
From	Object.	Required
cityOrAirport	String. Optional enumeration specifying whether to restrict the search based on the city/airport code sent in value. Supported values: City Only Airport Only City or Airport	Optional
value	String. The IATA location code for the departure airport/city for this leg.	Required
To	Object	Required
cityOrAirport	String. Optional enumeration specifying whether to restrict the search based on the city/airport code sent in value. Supported values: City Only Airport Only City or Airport	Optional
value	String. The IATA location code for the arrival city/airport for this leg.	Required
DepartureTimeRange	Optional object to specify a start time and end time for the flight search. Only results within the specified window are returned. If both DepartureTimeRange and SearchCriteriaFlightChange @departureTime above are sent, Exchange Search uses the DepartureTimeRange for the search, not the departureTime. Key value pairs: value: Currently not used. start: Start time for the specified departure window. end: End time for the specified departure window.	Optional
PassengerCriteria	Array. Defines each passenger to search for. Send one instance of PassengerCriteria for each passenger. Send with @type PassengerCriteriaAirChange. Includes TravelerIdentiferRef object. Note that although the JSON Search API sends an instance of PassengerCriteria for each PTC, Exchange Price Quote sends PassengerCriteria for each passenger.	Required
passengerTypeCode	String. The passenger type code (PTC) for this specific passenger. Common PTCs are: ADT: adult CHD: child of unknown age (see Notes on PTC and age below) CNN: child when age is known INF: infant without a seat INS: infant with a seat UNN: unaccompanied child	Required
number	Number. The number of passengers with this PTC. Should always be 1, as Passenger Criteria here is for an individual passenger.	Required
age	Number. The age of the passenger. Notes on PTC and age Travelport recommends sending age only with PTCs that require age for pricing. For child passengers, Travelport recommends sending the age of the child in the age attribute plus the PTC CNN. Travelport recommends against sending CNN without age, or the CHD PTC. Many fares cannot be quoted for CHD. The age for CNN is generally between 2 and 11 inclusive, with ADT fares returned for ages 12 and up; however, this can vary by airline and country. The age for INF must be either 0 or 1. During booking, date of birth is required for all child and infant PTCs (Add Traveler payload in Traveler/birthDate).	Optional
specifiedPassengerTypeCodeOnlyInd	Boolean. Send with true to return only offers for the specified PTC. Exchange Search generally returns the lowest fares available for any PTC. Sending specifiedPassengerTypeCodeOnlyInd set to true limits the fares returned to the specified PTC, which may return a higher priced fare that has better rules or commission. Note that if no fares are available for the specified PTC then no fares are returned and the error message "UNABLE TO PRICE AS SPECIFIED" is returned.	Optional Default is false
TravelerIdentiferRef	Top level object for traveler identifier.	Required
id	The traveler identifier from the reservation.	Required
BuildFromReservationWorkbench	Includes ReservationIdentifier and OfferIdentifier; may include ProductIdentifier object.	Required
ReservationIdentifier	Includes Identifier object.	Required
Identifier	Workbench identifier information. Key value pairs: authority: Always send the value Travelport. value: The workbench ID returned when the workbench is created.	Required
OfferIdentifier	The ID of the offer to change. *Exchange Search supports sending requests to search with an empty reservation, which can result when air segments and stored fares are canceled but the reservation is kept open to retain traveler and ticket information. Do not send OfferIdentifier or ProductIdentifier when searching with an empty reservation.	*Required
id	Send the offer ID of the offer to change (returned as part of the Reservation Retrieve when the workbench is created).	Required
ProductIdentifier	Array. Send ProductIdentifier only if you want to return offers that change one or more specified products, instead of changing the entire offer. Do not send if you want to return options to modify the entire offer. (A product is one leg of an itinerary; a leg is all flight or flights between one origin and destination pair.) Send an instance of ProductIdentifier for each product/leg you want to change. Do not send ProductIdentifier for any leg you do not want to change. For example, if you send only the first product identifier for a round-trip itinerary, all offers include new options for the first leg and return the same flight/s that are already on the existing itinerary for the second leg. See the OfferIdentifier note above for an empty reservation.	Optional
id	The product ID of the product to change.	Optional

Show Exchange Search Request Optional Modifiers Table

Object	Description	Required/Optional
SearchModifiersAir	Optional modifiers related to the journey, such as connections. May include CabinPreference, PricingModifiersAirChange, OrganizationInformation, and/or CalculatedFareAdjustment objects.	Optional
CabinPreference	Array. Requests a fare based on the cabin class. Only one cabin preferenceType (Permitted, Preferred, or PreferredWithUpgrade) is allowed per request, but there is no limit to the number of cabins that can be sent.	Optional
cabins	String. A space-delimited list of cabins. Supported values are (no default): Economy PremiumEconomy Business First PremiumFirst	Required if CabinPreference sent
preferenceType	Supported values: Permitted: Searches for ONLY the specified cabin class or classes. If that class is not available, the response does not return any offers. Preferred: Searches for the specified cabin class or classes, but will return lower classes if the specified class is not available. PreferredWithUpgrade: Searches for the specified cabin class or classes, and will return higher classes if the specified class is not available. Sending a mix of preferenceType values is not supported. For example, you cannot send an instance of CabinPreference with a preferenceType of Permitted and another instance with preferenceType of Prohibited. In this case the results default to the Preferred preference.	Required if CabinPreference sent
legSequence	Send legSequence to specify the sequence of the leg that the cabin preference applies to. You can apply the preference to only some legs of the itinerary, or different preferences to different legs. The following example excerpt shows one instance of CabinPreference applied to legs 1 and 4, and another instance that applies to legs 2 and 3. To apply a preference to the entire itinerary, send legSequence for each leg of the itinerary. Show Example CabinPreference at leg level - single cabin preference on two legs `...{ "SearchModifiersAir": { "@type": "SearchModifiersAir", "CabinPreference": [ { "@type": "CabinPreference", "preferenceType": "PreferredWithUpgrade", "cabins": [ "PremiumFirst", "First", "Business" ], "legSequence": [ 1, 3 ] } ] } }...` Show Example CabinPreference at leg level - different cabin preference for different legs `...{ "SearchModifiersAir" : { "@type": "SearchModifiersAir", "CabinPreference" : [ { "@type" : "CabinPreference", "preferenceType" : "Permitted", "cabins" : [ "First", "Business" ], "legSequence" : [ 1, 4 ] }, { "@type" : "CabinPreference", "preferenceType" : "Permitted", "cabins" : [ "PremiumEconomy", "Economy",], "legSequence" : [2, 3 ] } ] }...`	Required if CabinPreference sent
FlightType	Optional search preferences about connections and stops.	Optional
connectionType	The connection type to limit the search. The specified type and all higher types can be returned. Supported values (no default): NonStopDirect: Direct flight from the origin to the destination without a stop. StopDirect: Direct flight from origin to destination with a stop that does not have a change in flight number. SingleConnection: Flight options requiring one change of planes. DoubleConnection: Flight options requiring two changes of planes.	Required if FlightType sent
PricingModifiersAirChange	Optional modifiers related to pricing, such as brands and account codes. Includes OrganizationInformation if sending account codes. Includes FareSelection if sending fare types. Includes CalculatedFareAdjustment if sending increase/decrease fare modifiers.	Optional
currencyCode	String. Send the currency type to return if you want to override the default currency specified with your PCC. For a list of currency codes, see the Universal API Reference Data file linked from Downloads.	Optional
keepToBrandInd	By default Exchange Search returns the lowest available brand regardless of original brand on the ticket. Set to true to request only flight options available in the same brand as the original ticket. Set to false to not force the original brand. If not sent, the default value is false, The functionality works only for scenarios where the date and/or time is changed on a flight. It is not supported for more complex scenarios such as changing routing, adding segments, or connection changes.	Optional
PricingPCC	String, 2-10 characters supported. Use to send a faring PCC for which a selective access or code group agreement exists between that PCC and the PCC associated with your account. (PCC is the pseudo city code; a travel provider's identification code for the JSON APIs, provisioned from Travelport.) The following combinations of PricingPCC and FareSelection/fareType=PrivateFaresOnly (see below) return results as follows: PricingPCC sent and PrivateFaresOnly not requested: If a selective access or group agreement exists, both public and private fares (if available) are returned for the requesting and providing PCC. PricingPCC sent and PrivateFaresOnly not requested: If no selective access or group agreement exists, only public fares are returned. PricingPCC sent and PrivateFaresOnly is requested: If a selective access or group agreement exists that allows private fare access, private fares (if available) are returned for the requesting and providing PCC. PricingPCC sent and PrivateFaresOnly is requested: If a selective access or group agreement exists but does not allow private fares access, or if no agreement exists, an error is returned.	Optional
OrganizationInformation	Top level object for OrganizationIdentifier.	Optional
OrganizationIdentifier	Send up to 5 account or contract codes, if they are required for an airline or agency private fare.	Required if OrganizationInformation sent
organizationCodeType	String. Always send with the string Account.	Required if OrganizationInformation sent
value	String. The account code to apply. If an account code for a private fare is sent, any tour code filed through a supplier as a private fare CAT 35 is shown in the response in TermsAndConditionsFull/OrganizationInformation/OrganizationIdentifier, with an organizationCodeType value of Tour and the tour code returned in OrganizationIdentifier/value.	Required if OrganizationInformation sent
supplier	String. The IATA code for the airline on which the account code is applicable.	Required if OrganizationInformation sent
accountCodeFaresOnlyInd	Boolean. Optional indicator to limit the fares returned to only fares filed for that account code. Send set to true, along with one or more account codes in OrganizationIdentifier/value per above. If sending multiple account codes, send each instance with accountCodeFaresOnlyInd set to true. If not sent the default is false. If an account code is sent without accountCodeFaresOnlyInd set to true, the response includes any fares filed for that account code plus fares that are not specific to the account code. If accountCodeFaresOnlyInd is sent with true and no account code, the indicator is ignored and the response returns all fares and the following warning: accountCodeFaresOnlyInd set to true requires an account code to be specified in the request.	Optional
CalculatedFareAdjustment	Optional pricing modifier allowing customers who have airline calculated fares to increase or decrease those fares before taxes during exchanges. The @type value for CalculatedFareAdjustment specifies whether to increase or decrease the fare as follows: @type CalculatedFareAdjustmentDiscount discounts the fare. @type CalculatedFareAdjustmentIncrease increases the fare. Show Example excerpt - CalculatedFareAdjustment to discount fare by an amount `"CalculatedFareAdjustment": { "@type": "CalculatedFareAdjustmentDiscount", "AmountPercent": { "@type": "AmountPercentAmount", "Amount": { "value": 20 } } } }` Show Example excerpt - CalculatedFareAdjustment to discount fare by a percent `"CalculatedFareAdjustment": { "@type": "CalculatedFareAdjustmentDiscount", "AmountPercent": { "@type": "AmountPercentPercent", "Percent": 11 } } }` Show Example excerpt - CalculatedFareAdjustment to increase fares by flat amount `"CalculatedFareAdjustment": { "@type": "CalculatedFareAdjustmentIncrease", "AmountPercent": { "@type": "AmountPercentAmount", "Amount": { "value": 5 } } } }`	Optional
AmountPercent	Use with CalculatedFareAdjustment to specify an amount or percentage to increase or decrease the fare by. Includes either Percent or Amount objects. Send with @type AmountPercentAmount for Amount or @type AmountPercentPercent for Percent.	Required if CalculatedFareAdjustment sent
AmountPercent/Percent	Use with CalculatedFareAdjustment/AmountPercent to specify a percentage to increase or decrease the fare by.	Optional
AmountPercent/Amount	Use with CalculatedFareAdjustment/AmountPercent to specify an amount to increase or decrease the fare by.	Optional
FareSelection	Optional object to send fare type values.	Optional
prohibitUnbundledFaresInd	Set to true to prevent unbundled fares. Default is false. When sent, FareSelection must be sent with @type FareSelectionDetail.	Optional
fareType	Specifies the fare types to return. Supported values: PublicFaresOnly PrivateFaresOnly AgencyPrivateFaresOnly AirlinePrivateFaresOnly NetFaresOnly: Only net fares. If no net fares are available, the response returns an error and does not return any fares. PublicAndPrivateFares (default): Lowest of all public and private fares. AllFares: Not supported.	Optional

Response

The Exchange Search response is similar to the Search response. The table below refers to the response table in the Search API Reference for several common objects that are returned in the Exchange Search response with the same type of data.

Show Response Body Table

Object	Description
CatalogOfferingsAirChangeResponse	Top level object for the full response. Include CatalogOfferings and ReferenceList objects. Key value pairs: transactionId: System-generated unique ID for this response. Can be used for internal tracking and troubleshooting. traceId: Returned if a custom trace ID was sent in the request header. See Transaction and Trace IDs for details. See Identifiers in the JSON APIs for more about identifiers across all JSON APIs.
CatalogOfferings	Top level object for all offers. Includes Identifier and CatalogOffering.
CatalogOfferings/Identifier	Identifier information for the response. Key value pair: value: Transaction identifier.
CatalogOffering	Array. Each instance returns an individual offer. Includes ProductOptions, Price, TermsAndConditions, ModifyPrice objects; returns PastDate if any segments have already been flown. Up to 25 instances of CatalogOffering may be returned. All instances of CatalogOffering have @type CatalogOfferingModify. Key value pair: id: Internal short reference for offer. Must be sent in any subsequent request to book this specific offer.
ProductOptions	Flight options for one leg of the itinerary. Key value pair: sequence: Sequence of this leg of the itinerary for this product. For example, on a round-trip itinerary, the outbound/departure leg has sequence value 1, and the inbound/return leg has sequence value 2. Includes Product object.
Product	Array. Lists the flight or connecting flights for one leg of the itinerary. Repeats for additional legs. Key value pairs: totalDuration: Total time length of the segment in hours (H) and minutes (M). id: Internal product id. Includes FlightSegment and PassengerFlight objects.
FlightSegment	Array. One instance for each flight in the product. For example, a leg (aka product) with no connecting flights would return one instance while a leg with connecting flights would return two instances. Key value pair: sequence: Order of the sequence; e.g. 1 for the first segment on the leg. Includes Flight object.
Flight	Array. One instance for each flight in the FlightSegment. A leg with a direct flight option has one Flight object, while a leg with connecting flights has one Flight object for each connecting flight on the leg. Includes FlightRef.
FlightRef	Internal cross-reference to full flight details returned in ReferenceList/ReferenceListFlight.
PassengerFlight	Array. Returns PTC and class/fare information for each PTC requested. One instance for each PTC requested. Key value pairs: passengerQuantity: Number of passengers in that PTC. passengerTypeCode: The PTC code. Includes FlightProduct.
FlightProduct	Key value pairs: segmentSequence: Order of the corresponding flight in the sequence. Note that the segmentSequence value for connecting flights is the same; for example, for two connecting flights on the outbound or first leg of the itinerary, both flights have the segmentSequence value 1. classOfService: Class of service code. cabin: Cabin class. fareBasisCode: Fare basis code for the flight. fareType: Indicates the fare type. Possible values are AirlinePrivateFare, AgencyPrivateFare, PublicFare, or NetFare (net fares are not supported for NDC). If branded fares are returned, includes the Brand object.
Brand	Returned for branded fares. May include BrandRef object. Brand details are returned by default and are consolidated in ReferenceList/ReferenceListBrand per below (Brand details can be disabled by sending returnBrandedFaresInd as false.) In this case Brand does not return the brand name or Identifier but instead returns BrandRef, which matches to the brand identifier (e.g., b1) in ReferenceListBrand.
Brand/BrandRef	Cross-reference to the brand identifier (e.g., b1) in ReferenceListBrand.
Price	The Price object returns price information for this offer. It includes the following: exchangeInd: true indicates the currently ticketed itinerary can be exchanged for this itinerary. Because the price information applies to an exchange, this value is always returned as true. Price includes the objects Base, TotalTaxes, TotalFees, TotalPrice, and PriceBreakdown if a detail response was requested The amounts in Base, TotalTaxes, TotalFees, and TotalPrice are inclusive of all travelers across all PTCs. The amounts in PriceBreakdown apply to one traveler with the PTC returned in that instance. In Price/Fees and ModifyPrice/Fees, a Tax object is returned if applicable to provide the VAT information for the change fee, including the currency code, tax code, and amount.
Base	Number. Base price for all passengers before taxes and fees.
TotalTaxes	Number. Sum of all taxes for all passengers.
TotalFees	Sum of all fees for all passengers.
TotalPrice	Total price for all passengers including base cost, taxes, and fees.
PriceBreakdown Returned only if a detail response was requested.	Array. One instance per PTC. Key value pairs: quantity: Number of passengers in this PTC. requestedPassengerType: The PTC. Includes the Commission (if filed) and Amount objects. May include FiledAmount. For any fare that has a private fare component, PriceBreakdown includes the objects Commission (either a percent or amount) and NetBaseAmount, which is the base fare filed by the airline.
PriceBreakdown/Amount	Includes the standard CurrencyCode, Base, Taxes, Fees, and Total objects to return the base fare, taxes, fees, and total fare for this PTC.
PriceBreakdown/Commission	Any commission filed by an airline in a CAT35 fare is returned in PriceBreakdownAir/Commission. The amount is either a percent of the fare component (@type CommissionPercent and the Percent object) or an amount (@type CommissionAmount with Amount @value). Commission is not returned if no commission is filed, or if the commission is a mix of amount and percent. Show Commission examples - percent and amount Commission as a percent: `"Commission": { "@type": "CommissionPercent", "Percent": 0 },` Commission as an amount: `"Commission": { "@type": "CommissionAmount", "Amount": { "code": "GBP", "minorUnit": 2, "value": 0.0 } },`
Amount	Specifies commission when commission is a set amount. Key value pairs: code: Currency code for this amount. minorUnit: The smallest unit of currency for the currency in code. For example; the smallest denomination in USD is the cent, which is 1/100 of a USD, and the minor unit value is 2. Not all currencies have a minor unit. value: The amount of the commission.
Percent	Number. Specifies commission percent when commission is a percent.
PriceBreakdown/FiledAmount	Returned if there is an equivalent amount on the fare.
PriceBreakdown/NetBaseAmount	The base fare filed by the airline exclusive of any commission or additional markup. Returned only for fares with a private fare component. See Net Ticket Data in the Exchange, Refund, and Void Guide for details.
FiledAmount	Any filed fare amounts. Key value pairs: currencyCode: Currency code of the filed fare. decimalPlace: Decimal places in the filed fare currency. value: Value of the filed amount.
TermsAndConditions	The terms and conditions that apply to the offer. For full details see the Search API Reference.
TermsAndConditions/FulfillmentMethod	If there is a refundable balance, TermsAndConditions includes the FulfillmentMethod object. Includes RefundMethod and ChangeFeeCollectionMethod.
RefundMethod	Determines how the refundable balance will be handled. Key value pair: value: Possible values are RefundOriginalFOP, EMD, MCO, Unknown.
ChangeFeeCollectionMethod	Notes how the ChangeFee should be collected. Key value pair: value: Possible values are EMD, TAX, MCO, Unknown.
changeFeeIssuedSeparatelyInd	Indicator returned set to true when a refund will be returned along with a change fee. Key value pair: value: Supported value is EMD. When a non-refundable fare component exists, the refund amount after adjustment with the change fee is not returned, which will cause a discrepancy in the TotalPrice value.
FareCalculation	For each PTC, when available, FareCalculation returns the fare calculation ladder for all public and private fare types filed by an agency or an airline. Returned as a string with unlimited bytes.
CurrencyRateConversion	Returned when the POS country and country of the originating flight are different. Includes SourceCurrency, TargetCurrency, and ConversionRate objects.
SourceCurrency	Currency of the country of originating flight. Key value pair: value: Code for currency of country of originating flight.
TargetCurrency	Currency of the country of the POS. Key value pair: value: Code for currency of POS country.
ConversionRate	Key value pair: rateAsOf: Date and time of conversion rate used. value: Conversion rate from SourceCurrency to Target Currency.
ModifyPrice	ModifyPrice returns details about any fare difference between the currently ticketed itinerary and the offer in the CatalogOffering. Returns amounts in the CurrencyCode, Base, TotalTaxes, TotalPrice, and PriceBreakdown in the same format as the standard Price object. For all amounts in the following objects below, if there is no difference between the current ticket and the new amount, the value is 0. A negative number indicates the repriced amount is less than the ticket's current amount for that base, tax, fee, etc. A positive number indicates the repriced amount is higher. For example, A negative number in TotalPrice indicates an amount left after exchange.
ResidualPrice	Returned if any residual value remains at exchange for this offer. Returns amounts in the CurrencyCode, Base, TotalTaxes, TotalPrice, and PriceBreakdown in the same format as the standard Price object.
AdditionalCollectionPrice	Returned if any additional amount (add collect) is due for this offer at exchange. Returns amounts in the CurrencyCode, Base, TotalTaxes, TotalPrice, and PriceBreakdown in the same format as the standard Price object.
SupplierRetainedPrice	Returned when an offer includes a system-ignored amount to show the carrier-forfeited residual value. Returns amounts in the CurrencyCode, Base, TotalTaxes, TotalPrice, and PriceBreakdown in the same format as the standard Price object. Note the following about forfeited residual values: When SupplierRetainedPrice is returned, the terminal record includes an EP$ modifier that indicates the system-ignored residual amount as follows. No change to the JSON response payload; this entry is available only via a terminal program. T P1/S1/CDL/ET/FEX0067232556649/EP$61.39 When a residual value is forfeited because of a Category 31 filing by the airline, an entry about the forfeit is made in the historical notepad record. No change to the JSON response payload. The historical notepad is accessible only via a terminal program with the *HNP entry, and available only to specifically provisioned customers. Contact your Travelport representative for any questions about your access. Show Example SupplierRetainedPrice object "SupplierRetainedPrice": { "@type": "SupplierRetainedPriceDetail", "id": "SupplierRetainedPrice_1", "CurrencyCode": { "decimalPlace": 2, "value": "USD" }, "Base": 0, "TotalTaxes": 0, "TotalPrice": 0, "PriceBreakdown": [ { "@type": "PriceBreakdownAir", "quantity": 1, "requestedPassengerType": "ADT", "Amount": { "@type": "Amount", "Base": 0, "Taxes": { "@type": "Taxes", "TotalTaxes": 0 } } }, { "@type": "PriceBreakdownAir", "quantity": 1, "requestedPassengerType": "SRC", "Amount": { "@type": "Amount", "Base": 0, "Taxes": { "@type": "Taxes", "TotalTaxes": 0 } } } ] }
PastDate	Returned if an exchange is requested for a ticket on which some flight segments have already been flown. Lists the flown flight segments by flight segment number. Show Example PastDate object for flown segments `"PastDate": [ "s1", "s2" ]`
CurrencyCode	Specifies the currency in which prices are returned. Key value pairs: value: IATA code for currency. decimalPlace: Indicates the number of decimal places returned.
ReferenceList/ReferenceListFlight	Flight details for the flights returned in the offers. For details see the ReferenceList section of the Search API Reference.
ReferenceList/ReferenceListBrand	Brand details for the brands returned in the offers. For details see the ReferenceList section of the Search API Reference.
ReferenceList/ReferenceListExchangedPrice	Exchange Search 24.11.29 and later. Returns the original price of the exchanged ticket. Returns amounts in the CurrencyCode, Base, TotalTaxes, TotalPrice, and PriceBreakdown in the same format as the standard Price object.

Example Request

For additional examples, download the developer toolkits and see Using Postman and Developer Toolkits.

The example below requests an Exchange Search for multiple passengers.

Show Example Exchange Search for multiple passengers

{
    "CatalogOfferingsQueryAirChange": {
        "CatalogOfferingsAirChangeRequest": {
            "@type": "CatalogOfferingsAirChangeRequestReservation",
            "returnBrandedFaresInd": true,
            "detailViewInd": true,
            "SearchCriteriaFlight": [{
                    "departureDate": "2021-05-14",
                    "departureTime": "07:30:00",
                    "From": {
                        "cityOrAirport": "Airport Only",
                        "value": "LHR"
                    },
                    "To": {
                        "cityOrAirport": "City or Airport",
                        "value": "FRA"
                    }
                }, {
                    "departureDate": "2021-05-30",
                    "departureTime": "08:00:00",
                    "From": {
                        "cityOrAirport": "Airport Only",
                        "value": "FRA"
                    },
                    "To": {
                        "cityOrAirport": "City or Airport",
                        "value": "LHR"
                    }
                }
            ],
            "PassengerCriteria": [{
                    "@type": "PassengerCriteriaAirChange",
                    "number": 1,
                    "age": 20,
                    "passengerTypeCode": "ADT",
                    "TravelerIdentifierRef": {
                        "id": "travelerRefId_1"
                    }
                }, {
                    "@type": "PassengerCriteriaAirChange",
                    "number": 1,
                    "age": 22,
                    "passengerTypeCode": "ADT",
                    "TravelerIdentifierRef": {
                        "id": "travelerRefId_2"
                    }
                }, {
                    "@type": "PassengerCriteriaAirChange",
                    "number": 1,
                    "age": 6,
                    "passengerTypeCode": "C06",
                    "TravelerIdentifierRef": {
                        "id": "travelerRefId_3"
                    }
                }, {
                    "@type": "PassengerCriteriaAirChange",
                    "number": 1,
                    "age": 8,
                    "passengerTypeCode": "C08",
                    "TravelerIdentifierRef": {
                        "id": "travelerRefId_4"
                    }
                }, {
                    "@type": "PassengerCriteriaAirChange",
                    "number": 1,
                    "age": 60,
                    "passengerTypeCode": "ADT",
                    "TravelerIdentifierRef": {
                        "id": "travelerRefId_5"
                    }
                }, {
                    "@type": "PassengerCriteriaAirChange",
                    "number": 1,
                    "age": 60,
                    "passengerTypeCode": "ADT",
                    "TravelerIdentifierRef": {
                        "id": "travelerRefId_6"
                    }
                }
            ],
            "PricingModifiersAirChange": {},
            "BuildFromReservationWorkbench": {
                "ReservationIdentifier": {
                    "Identifier": {
                        "authority": "Travelport",
                        "value": "723f8a67-a1b2-4f41-b52b-71c5026db23e"
                    }
                },
                "OfferIdentifier": {
                    "id": "offer_1"
                },
                "ProductIdentifier": [{
                        "id": "product_1"
                    }, {
                        "id": "product_2"
                    }
                ]
            }
        }
    }
}

Example Response