Skip Navigation

Search and Pricing Parameters

The Exchange Shopping web service supports a wide range of search and pricing parameters that can be used to narrow down shopping results. Multiple parameters may be combined within a single request.

The purpose of this chapter is to provide detailed information on these parameters. These parameters are included in one of the following sections of the request based on application (per passenger, per leg, or per entire request):

Exchange Shopping Xpath

ExchangeShoppingRQ/PassengerInformation
ExchangeShoppingRQ/OriginDestinationInformation
ExchangeShoppingRQ/TravelPreferences

The following sections provide details about each of these parameters, including specific scenarios and expected results.

Required Search Parameters

These parameters must be provided when:

  • A given portion of travel should remain unchanged (leg not shopped)
  • Alternate options should be searched for a given leg (leg shopped), but originally ticketed airports or dates should remain unchanged
  • A new leg should be added to the ticketed itinerary

Origin and Destination City or Airport

This parameter provides details about the origin and destination city/airport of each portion of travel (leg) in the request.

Exchange Shopping Xpath

ExchangeShoppingRQ/OriginDestinationInformation/StartLocation ExchangeShoppingRQ/OriginDestinationInformation/EndLocation

Departure Date and Time or Arrival Date

This parameter provides details about the departure or arrival date or date and preferred time of a specific portion of travel.

The following applies:

  • These parameters always apply per leg.
  • Either departure date and time OR arrival date can be requested per single leg.
  • If both departure AND arrival date or date and time are requested for the same leg, an error message will be returned. This is controlled by the Exchange Shopping XML schema. = validation
  • If there is more than one leg within the request, departure or arrival dates can be combined between different legs, for example, on the first leg, departure time is used and on the second one, arrival date.
  • Date/time is always considered local date/time at associated airport/city. For departure date/time, it is the local date/time at the origin airport/city.
  • If departure time is indicated in the request, the Exchange Shopping web service will search for the flights using the requested time as the preferred one.
  • If no departure or arrival is included in the request, the service will check for the flights departing or arriving between 00:00 and 23:59 of the day indicated as departure or arrival date.

Exchange Shopping Xpaths

ExchangeShoppingRQ/OriginDestinationInformation/DateTimeSelection/DepartureDate
or:

ExchangeShoppingRQ/OriginDestinationInformation/DateTimeSelection/DepartureDateTime
or:

ExchangeShoppingRQ/OriginDestinationInformation/DateTimeSelection/ArrivalDate

Optional Search and Pricing Parameters

The following optional search and pricing parameters only apply to shopped legs. If any of these parameters are included for not shopped legs they will be ignored.

Search for Alternate Times before and/or after Departure Time

This parameter allows searching for alternate itinerary options departing a specific number of hours before and/or after departure time specified in the request.

  • This parameter applies per leg
  • The value for this parameter can be from 001 to 009, which defines a window of 1 to 9 hours around the preferred departure time.
  • “Alternate Times before and/or after Departure time” cannot be combined with “Search by Arrival Date”, “Arrival Date and Time” or “Search by Departure/Arrival Time Range” within the same leg.
  • When shopping for multiple legs, “Search for Alternate Times Before and/or After Departure Time” can be combined with “Preferred Departure/Arrival Time Range”, “Search by Arrival Date” or “Arrival Date and Time” on different legs.

Exchange Shopping Xpath ExchangeShoppingRQ/OriginDestinationInformation/DateTimeSelection/DepartureDateTime/@minus - departure given number of hours before departure time specified in the request

ExchangeShoppingRQ/OriginDestinationInformation/DateTimeSelection/DepartureDateTime/@plus - departure given number of hours after departure time specified in the request  

Departure or Arrival Time Range

This qualifier allows searching for itinerary options by departure or arrival time range.

  • This parameter applies per leg
  • Unless otherwise specified, the default is to check all flight times
  • This parameter applies to origin/destination only; it does not apply to connecting points. For example: For the leg from Larnaca (LCA) to London (LON) via Amsterdam (AMS), only the departure time range of flights from LCA or arrival time range in LON will be considered. AMS is not considered as it is a connecting city.
  • Either departure or arrival time range can be requested for a given leg
  • If departure/arrival time window is requested, both time window start time and end time must be specified, otherwise the time range parameter will be ignored.
  • Combining departure or arrival time range with “Preferred Departure or Arrival Time” or “Alternate Time before/after Departure” search parameters within a single leg is not allowed and controlled by the XML schema.

Exchange Shopping Xpaths ExchangeShoppingRQ/OriginDestinationInformation/DateTimeSelection/DepartureDate/@timeWindowStart ExchangeShoppingRQ/OriginDestinationInformation/DateTimeSelection/DepartureDate/@timeWindowEnd

or:

ExchangeShoppingRQ/OriginDestinationInformation/DateTimeSelection/ArrivalDate/@timeWindowStart ExchangeShoppingRQ/OriginDestinationInformation/DateTimeSelection/ArrivalDate/@timeWindowEnd

Search for Preferred Airline

The Preferred Airline indicator narrows the returned options down to only the ones that include the specified carrier(s).

  • This parameter applies per leg
  • The default is to check all carriers if carrier application is not restricted by Category 31 rules or other restrictions of the exchanged fare.
  • Up to 20 preferred carriers can be specified per leg
  • The carrier code must be specified with two alpha-numeric characters. Any other character combination will result in an error.
  • This parameter applies only to the marketing carrier; the operating carrier is not taken into consideration.
  • The same carrier code may not be included as preferred and non-preferred (see “Exclude an Airline”) carrier when combining both parameters. Including the same carrier code when combining both parameters will result in the following error response: “Unable to process the request where the same airline: {carrier’s two-character code} is indicated as preferred and non-preferred carrier. Please amend your request and try again.”

Note: This validation only applies to shopped legs.

Exchange Shopping Xpath

ExchangeShoppingRQ/OriginDestinationInformation/IncludeVendor

Exclude an Airline

The Exclude an Airline indicator narrows the returned options down to only to the ones that do not include the non-preferred carrier(s).

  • This parameter applies to the entire request -The default is to check all carriers if the carrier application is not restricted by Category 31 rules or restrictions of any other category of exchanged fare.
  • Up to 20 non-preferred carriers can be specified per itinerary
  • The carrier code must be specified with two alpha-numeric characters. Any other character combination will result in an error.
  • This parameter applies only to the marketing carrier; the operating carrier is not taken into consideration.
  • The same carrier code may not be included as preferred and non-preferred (see “Search for Preferred Airline”) carrier when combining both parameters. Including the same carrier code when combining both parameters will result in the following error response: “Unable to process the request where the same airline: {carrier’s two-character code} is indicated as preferred and non-preferred carrier. Please amend your request and try again.”

Exchange Shopping Xpath

ExchangeShoppingRQ/TravelPreferences/ExcludeVendor

Maximum Number of Connections Permitted per Leg

The Maximum Number of Connections indicator is used to set the maximum acceptable number of connections allowed per leg in the itinerary. Intermediate stops with no change of plane are not considered connections.

  • Applicable to the entire request (i.e., to all shopped legs). It is not possible to request a different maximum number of connections per each leg.
  • Possible values are: 0, 1, 2, or 3 to indicate the maximum number of connections
  • The default number of connections is 3
  • Any value other than 0-3 will result in an error message
  • Zero (0) indicates a request for either nonstop or direct flights only
  • This qualifier cannot be combined with “Use Same Connections” and/or “Maximum Number of Stops per Leg”.

Exchange Shopping Xpath

ExchangeShoppingRQ/TravelPreferences/Flight/@maxConnections

Maximum Number of Stops Permitted per Leg

This indicator is used to set the maximum acceptable number of intermediate stops allowed per portion of travel. Intermediate stops (no change of plane) are counted as connections for the purposes of this indicator.

  • Applicable to the entire request (i.e., all shopped legs). It is not possible to request a different number of maximum number of stops for different legs.
  • Possible values are: 0, 1, 2, or 3 to indicate the maximum number of stops
  • If value other than 0-3 will result in an error message
  • Zero (0) indicates a request for nonstop flights only
  • This qualifier cannot be combined with “Use Same Connections” and/or “Maximum Number of Connections per Leg”.

Exchange Shopping Xpath

ExchangeShoppingRQ/TravelPreferences/@maxStops

Online Carrier Service Only

This parameter allows to search for online (single carrier) itinerary options.

  • Applies to the entire request
  • This parameter applies to the marketing carrier only; the operating carrier is not taken into consideration
  • Different itinerary options may be on different carriers; however each option will include flights on a single carrier (e.g., option 1 returns flights for carrier XX only, option 2 returns flights for carrier YY only)
  • Both online and interline itineraries will be returned by default unless otherwise restricted by Category 31 rules. To get both online and interline itinerary options, “Specify Interline Carrier Service Only” should be skipped in the request.
  • If the online indicator is set to “true,” only itineraries on a single marketing carrier will be returned if applicable per the Category 31 rules of the ticketed fare(s).
  • This parameter may not be combined with “Interline Carrier Service Only.” Setting both the online and interline indicators to “true” will result in an error response.

Exchange Shopping Xpath

ExchangeShoppingRQ/TravelPreferences/@onlineIndicator

Interline Carrier Service Only

This parameter allows to search for interline (multi-carrier) itinerary options.

  • Applies to the entire request
  • Each itinerary option will include flights on at least two different marketing carriers, unless restricted by the Category 31 rules of the ticketed fare(s).
  • Both online and interline itineraries will be returned by default unless otherwise restricted by Category 31 rules. To get both online and interline itinerary options, “Specify Interline Carrier Service Only” should be skipped in the request.
  • If the interline indicator is set to “true,” only itineraries with multiple marketing carriers will be returned if applicable per the Category 31 rules of the ticketed fare(s).
  • This parameter may not be combined with “Interline Carrier Service Only.” Setting both the online and interline indicators to “true” will result in an error response.

Exchange Shopping Xpath

ExchangeShoppingRQ/TravelPreferences/@interlineIndicator  

Consider Only These Connection Cities/Airports

This indicator is used to specify connection cities or airports.

  • When using city codes to indicate connecting points, all airports will be considered for multi-airport locations (e.g., LON) as per DSF settings for multi-airports.
  • When using airport code as connecting point (e.g., LHR), only this airport will be considered when searching for itinerary options.
  • When specifying one connection city/airport, only this city/airport will be considered as a connecting point for the itinerary options.
  • When specifying more than one connection city/airport, itinerary options with one or more of these connection points will be returned. The options returned will not include connections via any other cities/airports.
  • Direct flights can also be returned if connection locations are requested.
  • A request may include this parameter as well as the “Use Same Connections” search parameter, however they may not be used for the same leg. Combining these two parameters on the same leg will result in an error message.

Exchange Shopping Xpath

ExchangeShoppingRQ/OriginDestinationInformation/ConnectionLocation/Location

Use Same Connections

This qualifier allows to search for itinerary options using same connecting cities as already ticketed.

  • This parameter cannot be combined with “Maximum Number of Stops per Leg” and/or “Maximum Number of Connections per Leg”.
  • This parameter may be combined with “Consider Only These Connection Cities/Airports” in a request, however they may not be combined on the same leg. Combining these two parameters on the same leg will result in an error message.
  • The itinerary options returned may include additional connecting points for that leg in addition to the specified connecting point if lower fares are found.
  • This qualifier only applies to transactions with an active PNR, as it requires full details for the booked segments.

Exchange Shopping Xpath

ExchangeShoppingRQ/PassengerInformation/PassengerWithoutPNR

Exchange Shopping Xpath

ExchangeShoppingRQ/OriginDestinationInformation/@preserveConnectionsIndicator=“true”

Corporate ID

This qualifier allows to search for negotiated fares filed with a Corporate ID.

  • This qualifier applies to the entire request and to all passengers included in the request.
  • Exchange Shopping will always return the lowest applicable fare combination for the itinerary option, even if the resulting fares are not filed with the requested Corporate ID, but filed as a public or private fare.
  • Up to four Corporate IDs are allowed in the request.
  • A Corporate ID may be combined with an Account Code within the same request.
  • You can send a combination of up to four Corporate IDs and Account Codes.

Exchange Shopping Xpath

/ExchangeShoppingRQ/TravelPreferences/PriceRequestInformation/NegotiatedFareCode

Account Code

This qualifier allows to search for negotiated fares filed with an Account Code.

  • This qualifier applies to the entire request and to all passengers included in the request
  • Exchange Shopping will always return the lowest applicable fare combination for the itinerary option, even if the resulting fares are not filed with the requested Account Code, but filed as a public or private fare.
  • Up to four Account Codes per transaction are allowed.
  • You can send a combination of up to four Corporate IDs and Account Codes

Exchange Shopping Xpath

/ExchangeShoppingRQ/TravelPreferences/PriceRequestInformation/AccountCode/@Code

Passenger Type Code

This parameter allows to search for itinerary options for a specific Passenger Type Code (PTC).

  • This parameter applies to the entire itinerary for each passenger.
  • Only one PTC can be specified per given passenger.
  • If the adult (ADT) fare is lower than the fare for the requested PTC and that PTC maps to ADT, the lower ADT fare will be returned.
  • When no PTC is defined in the Exchange Shopping request, the search will pass the passenger type from the original ticket (priced passenger type).
  • A maximum of four (4) different PTCs are supported per request.
  • When the request includes infants not occupying a seat (e.g., INF), the options returned for the infant may be in a different booking class as the option for the passengers occupying a seat, as availability is not verified for infants.

Exchange Shopping Xpath

ExchangeShoppingRQ/PassengerInformation/PassengerWithoutPNR/PassengerTypeOverride

or:

ExchangeShoppingRQ/PassengerInformation/PassengerWithPNR/PassengerTypeOverride

Requests for Infant PTCs Only

Exchange Shopping does not support requests for infant passengers only. At least one accompanying non-infant type passenger is required in the Exchange Shopping request.

This applies to PTCs overridden in Exchange Shopping request using the Shop by Passenger Type Code parameter or, if not applied, to the default PTC with which the exchanged ticket was priced.

Check PTC validation – what happens if no PTC is specified for new ticket in AE

Solution Returned in Different Booking Classes for Different PTCs

When the Exchange Shopping request includes multiple PTCs (e.g., 2 ADT + 2 YTH), the options returned may be in a different booking class for each PTC if this results in a lower fare. This applies to PTCs overridden in the Exchange Shopping request using the Shop by Passenger Type Code parameter or, if not applied, to the defaulted PTC with which the exchanged ticket was priced. When the option returned includes different booking classes for the different PTCs, the following flag will be set to “true” in the response to indicate that the solution will require splitting PNR:

Exchange Shopping Xpath

ExchangeShoppingRS/Solution/@requireSplitPNR

When the solution includes different booking classes for the different PTCs, availability is still checked for the total number of passengers in the request to ensure enough seats are available.

Solution Returned in Different Cabin Classes for Different PTCs

When the Exchange Shopping request involves multiple PTCs (e.g., 2 ADT + 2 YTH), the itinerary options returned may be not only in different booking classes, but also in different cabins for each PTC if this results in a lower fare (e.g., business cabin for ADTs and economy cabin for YTH). When the option returned are in a different cabin for at least one segment for the different PTCs, the following flag will be returned:

Exchange Shopping Xpath

ExchangeShoppingRS/Solution/@passengersInDifferentCabins=“true"

The response will also include the flag indicating that a PNR split is required.

Handling Infants in Terms of Options in Different Cabins

When an option includes a fare for an infant without a seat (e.g., INF) with at least one segment in a cabin that is different from any other non-infant, that itinerary option will not be included in the Exchange Shopping response, as infant passenger are not allowed to travel in a different cabin than the passenger(s) occupying a seat.

Note: There is no validation of the accompanying passenger for infant type PTCs performed.

Specified Passenger Type Only

This qualifier will only return fares filed with the requested passenger type. The returned options will not include adult fares, even if these are lower.

Exchange Shopping Xpath

ExchangeShoppingRQ/TravelPreferences/PriceRequestInformation/TPA_Extensions/XOFares/@value

Government Status

This qualifier allows to target fares with specific eligibility requirements. The requested government status types must be followed by appropriate country, country and state, or city code. The following government status types are supported:

  • Nationality – requires 2-letter country code (e.g., RU),
  • Residency – requires either a 2-letter country code (e.g., ES), a 2-letter country code followed by a 2-letter state/region code (e.g., USFL for the state of Florida in USA), or a 3-letter city code (e.g., BKK)
  • Employee - requires 2-letter country code (e.g., ES) or a 2-letter country code followed by a 2-letter state/region code (e.g., USFL for the state of Florida in USA).

Exchange Shopping Xpath

ExchangeShoppingRQ/TravelPreferences/PriceRequestInformation/GovernmentStatus

No Penalty Fares

This qualifier will return only fares with no change or cancellation fees.

Exchange Shopping Xpath

ExchangeShoppingRQ/TravelPreferences/PriceRequestInformation/@noPenaltyFares

Request Public/Private Fares Only

These qualifiers will return only options with published or private fares. They cannot be combined.

Exchange Shopping Xpath ExchangeShoppingRQ/TravelPreferences/PriceRequestInformation/TPA_Extensions/PublicFare/@ind

or

ExchangeShoppingRQ/TravelPreferences/PriceRequestInformation/TPA_Extensions/PrivateFare/@ind

Exempt all taxes

This qualifier will exempt only taxes from the total price, however fees and passenger facility charges (PFC) will be included.

Exchange Shopping Xpath ExchangeShoppingRQ/TravelPreferences/PriceRequestInformation/TPA_Extensions/ExemptAllTaxes/@value

Exempt all taxes and fees

This qualifier will exempt all taxes and include fees and passenger facility charges (PFCs). This is an equivalent of 'TE' qualifier.

Exchange Shopping Xpath /ExchangeShoppingRQ/TravelPreferences/PriceRequestInformation/TPA_Extensions/ExemptAllTaxesAndFees/@value

Override specific taxes

This qualifier will override taxes. You can override taxes by a tax code and tax amount. This is an equivalent of 'TX' qualifier

Exchange Shopping Xpath /ExchangeShoppingRQ/TravelPreferences/PriceRequestInformation/TPA_Extensions/Taxes/Tax

Exempt specific taxes

This qualifier will exempt taxes by tax code. This is an equivalent of 'TE-{tax code}' qualifier

Exchange Shopping Xpath /ExchangeShoppingRQ/TravelPreferences/PriceRequestInformation/TPA_Extensions/ExemptTax/@TaxCode

No Min/Max stay

This qualifier is used to search for fares with no minimum/maximum stay restrictions.

Exchange Shopping Xpath ExchangeShoppingRQ/TravelPreferences/PriceRequestInformation/TPA_Extensions/MinMaxStay/@ind

No Advance Purchase

This qualifier is used to search for fares with no advance purchase restrictions.

Exchange Shopping Xpath ExchangeShoppingRQ/TravelPreferences/PriceRequestInformation/TPA_Extensions/ResTicketing/@ind