API Information

Response Format
XML
Service Action Code
BargainFinderMaxRQ
Current Version
3.0.0
Target Audience
TN
Environment
Production
Documentation
Go to the Bargain Finder Max documentation

What's New

  • Bargain FinderSM Max has been enhanced to enable more customization and flexibility within the request and return additional information in the response as follows: • Schedule Filtering – new elements were added to the request schema: *Search by Airport or City codes – Allows you to specify for Origin/Destination if search should be processed as a city or airport code *Preferred Operating Carrier– Allows you to narrow the search by operating carrier (following the same logic as the current element for the marketing carrier). • Baggage Allowance and Charges - Allows you to manage baggage information at the request level. • Override Electronic Ticket Validation - Allows you to select a validating carrier and override the local settlement validation method and Interline Electronic Ticketing (IET) validation. • Multiple Fares Per Itinerary (MFPI) – Enables more customization for change fee, refundability and passenger type functionality: * Added ability to include multiple Passenger Types allowable per fare group. * Modifying default logic for Passenger Type processing within a fare group and added capability to force a requested Passenger Type. *Added Change Fee and Refundability to be added per fare group; the response changed to make a clear distinction.

Business Value

  • Each of these enhancements enable greater personalization and efficiency to further refine the search. Results are more relevant options, which drives higher booking conversion.

New Features

In the Request

Required

Parameter: RequestType

Type: BaggageRequestType

Description: Baggage information request type. Valid values are: • “A” - Allowance only • “C” - Allowance and charges • “N” - No baggage information

Sample Value:

<OTA_AirLowFareSearchRQ> <TravelPreferences> <Baggage RequestType="A" Description="true"/> </TravelPreferences> </OTA_AirLowFareSearchRQ>
Note: The “RequestType” parameter is required within the “Baggage” element.
Parameter: SettlementValidation

Type: Boolean

Description: The “SettlementValidation” parameter allows you to override the local settlement plan check.

Sample Value:

<OTA_AirLowFareSearchRQ> <TravelPreferences> <TPA_Extensions> <ValidatingCarrierCheck> <SettlementValidation Ind="false"/> <IETValidation Ind="false"/> <Carrier Code="K0"/> </ValidatingCarrierCheck> </TPA_Extensions> </TravelPreferences> </OTA_AirLowFareSearchRQ>
Note: When SettlementValidation/@Ind is set to false, it disables the settlement method validation in the local point of sale. When SettlementValidation/@Ind is set to true, it validates the settlement method in the local POS. If specified along with Carrier Code, the settlement validation will be disabled. ed (if “false”) or proceed (if “true”) for the carriers specified in the request; if no Carrier Code is specified, the settlement validation will be disabled/proceed for all validating carriers. If a country code(s) is provided, the settlement validation will be triggered for the specified country/countries). The “SettlementValidation” element is required within the “ValidatingCarrierCheck” element.
Parameter: IETValidation

Type: Boolean

Description: IETValidation allows you to disable Electronic Ticketing agreements validation or specify in which points of sale and for which carriers Electronic Ticketing agreements should be checked.

Sample Value:

<OTA_AirLowFareSearchRQ> <TravelPreferences> <TPA_Extensions> <ValidatingCarrierCheck> <SettlementValidation Ind="false"/> <IETValidation Ind="true"/> <Carrier Code="K0"/> <Country Code="PL"/> </ValidatingCarrierCheck> </TPA_Extensions> </TravelPreferences> </OTA_AirLowFareSearchRQ>
Note: When IETValidation/@Ind is set to “false,” it disables the Interline Electronic Ticketing agreements validation. When IETValidation/@Ind is set to “true,” at least one Country Code must be specified and will trigger IET validation performed in the specified countries. The “IETValidation” element is required within the “ValidatingCarrierCheck” element.
Parameter: Country/@Code

Type: String

Description: Country/@Code parameter allows you to specify country code(s) for which IET and/or settlement validation should be performed. At least one country code must be provided if IETValidation/@Ind is set to “true”.

Sample Value:

<OTA_AirLowFareSearchRQ> <TravelPreferences> <TPA_Extensions> <ValidatingCarrierCheck> <SettlementValidation Ind="false"/> <IETValidation Ind="true"/> <Carrier Code="K0"/> <Country Code="PL"/> </ValidatingCarrierCheck> </TPA_Extensions> </TravelPreferences> </OTA_AirLowFareSearchRQ>
Note: Country code is a valid parameter only if IET Validation is set to “true” in the request; otherwise, it is ignored. The format is a two-character country code as defined by ISO.

Optional

Parameter: LocationType

Type: String

Description: Parameter to narrow origin/destination search to specified airport or city. Valid values are: • “A” - Airport code • “C” - City code

Sample Value:

<OTA_AirLowFareSearchRQ> <OriginDestinationInformation> <OriginLocation> <OriginLocation LocationCode="OSL" LocationType="A"/> </OriginLocation> </OriginDestinationInformation> </OTA_AirLowFareSearchRQ>
Note: If no “LocationType” is specified, the “LocationCode” will default to a city code (if city and airport codes are the same).
Parameter: Type

Type: PreferLevelType

Description: “Type” parameter allows you to narrow the search by carrier type. Valid values are: • “Marketing” • “Operating”

Sample Value:

<OTA_AirLowFareSearchRQ> <TravelPreferences> <VendorPref Code="K0" PreferLevel="Preferred" Type="Operating"/> </TravelPreferences> </OTA_AirLowFareSearchRQ>
Note: If no “Type” parameter is added, vendor preference defaults to the marketing carrier.
Parameter: Baggage

Type: Complex

Description: Element to request baggage information

Sample Value:

N/A
Note: If the “Baggage” element is added, the parameter “RequestType” is required. Current baggage information, allowance only, will be returned if the “Baggage” element is not added to the request.
Parameter: Description

Type: Boolean

Description: The “Description” parameter allows you to request baggage text information. Valid values are: • “true” - To request text information. • “false” – Not to request text information.

Sample Value:

<OTA_AirLowFareSearchRQ> <TravelPreferences> <Baggage RequestType="A" Description="true"/> </TravelPreferences> </OTA_AirLowFareSearchRQ>
Note: If “RequestType” is set to “N”, the “Description” parameter will be ignored. If no “Description” parameter is specified in the request, it is considered as “false”.
Parameter: ValidatingCarrierCheck

Type: Complex

Description: The ValidatingCarrierCheck element encompasses the elements allowing you to override the local settlement method validation and Interline Electronic Ticketing agreements.

Sample Value:

N/A
Parameter: Carrier/@Code

Type: String

Description: Carrier/@Code parameter allows you to specify a carrier code(s) for which the specified settlement method and/or IET validation should (should not) be done.

Sample Value:

<OTA_AirLowFareSearchRQ> <TravelPreferences> <TPA_Extensions> <ValidatingCarrierCheck> <SettlementValidation Ind="false"/> <IETValidation Ind="true"/> <Carrier Code="K0"/> <Country Code="PL"/> </ValidatingCarrierCheck> </TPA_Extensions> </TravelPreferences> </OTA_AirLowFareSearchRQ>
Note: If a carrier code is not added in the request, the settlement validation is enabled/disabled for all carriers.
Parameter: PassengerTypeQuantity/@Code

Type: String

Description: This is a functional enhancement to Multiple Fares Per Itinerary (MFPI) within Bargain FinderSM Max. This parameter allows you to specify multiple passenger type codes in a FlexibleFares group.

Sample Value:

<OTA_AirLowFareSearchRQ> <TravelPreferences> <TPA_Extensions> <FlexibleFares> <FareParameters> <PassengerTypeQuantity Code="ADT" Quantity="2"/> <PassengerTypeQuantity Code="JCB" Quantity="1"/> <PassengerTypeQuantity Code="CNN" Quantity="1"/> </FareParameters> </FlexibleFares> </TPA_Extensions> </TravelPreferences> </OTA_AirLowFareSearchRQ>
Note: This is an extension of MFPI functionality – specify multiple passenger types.
Parameter: PassengerTypeQuantity/@Quantity

Type: Numeric1to999

Description: This is a functional enhancement to Multiple Fares Per Itinerary within Bargain Finder Max. This parameter is used to specify the quantity of passengers per a given Passenger Type.

Sample Value:

<OTA_AirLowFareSearchRQ> <TravelPreferences> <TPA_Extensions> <FlexibleFares> <FareParameters> <PassengerTypeQuantity Code="ADT" Quantity="2"/> <PassengerTypeQuantity Code="JCB" Quantity="1"/> <PassengerTypeQuantity Code="CNN" Quantity="1"/> </FareParameters> </FlexibleFares> </TPA_Extensions> </TravelPreferences> </OTA_AirLowFareSearchRQ>
Note: Up to four PassengerTypeQuantity elements with different Passenger Types Codes can be added in a single Multiple Fares group. The number of passenger types will match the number of passengers traveling.
Parameter: XOFares/@Ind

Type: Boolean

Description: This is a functional enhancement to Multiple Fares Per Itinerary within Bargain Finder Max. When XOFares/@Ind is set to “true,” it will force the specified fare on all legs of the returned solution to match the passenger type requested. This enhancement will remove the default application of XO (stay true to passenger type) qualifier on MFPI groups.

Sample Value:

<OTA_AirLowFareSearchRQ> <TravelPreferences> <TPA_Extensions> <FlexibleFares> <FareParameters> <XOFares Ind="true"/> <PassengerTypeQuantity Code="ADT" Quantity="2"/> </FareParameters> </FlexibleFares> </TPA_Extensions> </TravelPreferences> </OTA_AirLowFareSearchRQ>
Note: When XOFares/@Ind is set to “true,” only the fares matching the requested passenger type will be returned on all fare components. Otherwise, the fare matching the specified passenger type will be returned on at least one leg. NOTE: If you are using this option today in MFPI you will want to validate your logic is working as expected.
Parameter: VoluntaryChanges

Type: VoluntaryChangesSMPType

Description: This element identifies whether penalties associated with voluntary changes should be included in the search results.

Sample Value:

<OTA_AirLowFareSearchRQ> <TravelPreferences> <TPA_Extensions> <FlexibleFares> <FareParameters> <VoluntaryChanges Match="All"> <Penalty Amount="78.00" Application="Before" CurrencyCode="USD" Exclude="true" Type="Refund"/> </VoluntaryChanges> </FareParameters> </FlexibleFares> </TPA_Extensions> </TravelPreferences> </OTA_AirLowFareSearchRQ>
Note: By adding this functionality users requesting an MFPI request can use the optional Max Penalty qualifier to filter by fare flexibility and maximum penalty amounts.

In the Response

Required

Parameter: EquivalentAmount

Type: MonetaryAmountType

Description: Equivalent amount for baggage charges.

Sample Value:

<OTA_AirLowFareSearchRS> <PricedItineraries> <PricedItinerary> <AirItineraryPricingInfo> <ItinTotalFare> <TPA_Extensions> <BaggageInformationList> <BaggageInformation ProvisionType="A" AirlineCode="K0"> <Segment Id="0"/> <Segment Id="1"/> <Allowance Weight="30" Unit="kg"/> </BaggageInformation> <BaggageInformation ProvisionType="C" AirlineCode="K0"> <Segment Id="0"/> <Segment Id="1"/> <Charge EquivalentAmount="25.00" EquivalentCurrency="USD" FirstPiece="1" LastPiece="1" Description1="UP TO 50 POUNDS/23 KILOGRAMS" Description2="UP TO 62 LINEAR INCHES/158 LINEAR CENTIMETERS"/> </BaggageInformation> </BaggageInformationList> </TPA_Extensions> </ItinTotalFare> </AirItineraryPricingInfo> </PricedItinerary> </PricedItineraries> </OTA_AirLowFareSearchRS>
Note: “EquivalentAmount” is required within the “Charge” element.
Parameter: EquivalentCurrency

Type: CurrencyCodeType

Description: Equivalent currency for baggage charges.

Sample Value:

<OTA_AirLowFareSearchRS> <PricedItineraries> <PricedItinerary> <AirItineraryPricingInfo> <ItinTotalFare> <TPA_Extensions> <BaggageInformationList> <BaggageInformation ProvisionType="A" AirlineCode="K0"> <Segment Id="0"/> <Segment Id="1"/> <Allowance Weight="30" Unit="kg"/> </BaggageInformation> <BaggageInformation ProvisionType="C" AirlineCode="K0"> <Segment Id="0"/> <Segment Id="1"/> <Charge EquivalentAmount="25.00" EquivalentCurrency="USD" FirstPiece="1" LastPiece="1" Description1="UP TO 50 POUNDS/23 KILOGRAMS" Description2="UP TO 62 LINEAR INCHES/158 LINEAR CENTIMETERS"/> </BaggageInformation> </BaggageInformationList> </TPA_Extensions> </ItinTotalFare> </AirItineraryPricingInfo> </PricedItinerary> </PricedItineraries> </OTA_AirLowFareSearchRS>
Note: “EquivalentCurrency” is required within the “Charge” element.

Optional

Parameter: ProvisionType

Type: BaggageProvisionType

Description: “ProvisionType” indicates baggage information. Valid values are: • “A” - Checked Baggage Allowance. • “C” - Day of Check-in Charges.

Sample Value:

<OTA_AirLowFareSearchRS> <PricedItineraries> <PricedItinerary> <AirItineraryPricingInfo> <ItinTotalFare> <TPA_Extensions> <BaggageInformationList> <BaggageInformation ProvisionType="A" AirlineCode="K0"> <Segment Id="0"/> <Segment Id="1"/> <Allowance Pieces="1" Description1="UP TO 50 POUNDS/23 KILOGRAMS" Description2="UP TO 62 LINEAR INCHES/158 LINEAR CENTIMETERS"/> </BaggageInformation> </BaggageInformationList> </TPA_Extensions> </ItinTotalFare> </AirItineraryPricingInfo> </PricedItinerary> </PricedItineraries> </OTA_AirLowFareSearchRS>
Parameter: AirlineCode

Type: AirlineCodeType

Description: “AirlineCode” indicates the carrier whose baggage provisions apply.

Sample Value:

<OTA_AirLowFareSearchRS> <PricedItineraries> <PricedItinerary> <AirItineraryPricingInfo> <ItinTotalFare> <TPA_Extensions> <BaggageInformationList> <BaggageInformation ProvisionType="A" AirlineCode="K0"> <Segment Id="0"/> <Segment Id="1"/> <Allowance Pieces="1" Description1="UP TO 50 POUNDS/23 KILOGRAMS" Description2="UP TO 62 LINEAR INCHES/158 LINEAR CENTIMETERS"/> </BaggageInformation> </BaggageInformationList> </TPA_Extensions> </ItinTotalFare> </AirItineraryPricingInfo> </PricedItinerary> </PricedItineraries> </OTA_AirLowFareSearchRS>
Parameter: Description1

Type: String

Description: Baggage text information.

Sample Value:

<OTA_AirLowFareSearchRS> <PricedItineraries> <PricedItinerary> <AirItineraryPricingInfo> <ItinTotalFare> <TPA_Extensions> <BaggageInformationList> <BaggageInformation ProvisionType="A" AirlineCode="K0"> <Segment Id="0"/> <Segment Id="1"/> <Allowance Pieces="1" Description1="UP TO 50 POUNDS/23 KILOGRAMS" Description2="UP TO 62 LINEAR INCHES/158 LINEAR CENTIMETERS"/> </BaggageInformation> </BaggageInformationList> </TPA_Extensions> </ItinTotalFare> </AirItineraryPricingInfo> </PricedItinerary> </PricedItineraries> </OTA_AirLowFareSearchRS>
Parameter: Description2

Type: String

Description: Baggage text information.

Sample Value:

<OTA_AirLowFareSearchRS> <PricedItineraries> <PricedItinerary> <AirItineraryPricingInfo> <ItinTotalFare> <TPA_Extensions> <BaggageInformationList> <BaggageInformation ProvisionType="A" AirlineCode="K0"> <Segment Id="0"/> <Segment Id="1"/> <Allowance Pieces="1" Description1="UP TO 50 POUNDS/23 KILOGRAMS" Description2="UP TO 62 LINEAR INCHES/158 LINEAR CENTIMETERS"/> </BaggageInformation> </BaggageInformationList> </TPA_Extensions> </ItinTotalFare> </AirItineraryPricingInfo> </PricedItinerary> </PricedItineraries> </OTA_AirLowFareSearchRS>
Parameter: Charge

Type: Complex

Description: Charge information for the first two checked bags (if applicable).

Sample Value:

N/A
Note: If the “Charge” element is applicable, the “EquivalentAmount” and “EquivalentCurrency” parameters are required.
Parameter: FirstPiece

Type: Byte

Description: Specify first baggage piece for which the specified charge information applies.

Sample Value:

<OTA_AirLowFareSearchRS> <PricedItineraries> <PricedItinerary> <AirItineraryPricingInfo> <ItinTotalFare> <TPA_Extensions> <BaggageInformationList> <BaggageInformation ProvisionType="A" AirlineCode="K0"> <Segment Id="0"/> <Segment Id="1"/> <Allowance Weight="30" Unit="kg"/> </BaggageInformation> <BaggageInformation ProvisionType="C" AirlineCode="K0"> <Segment Id="0"/> <Segment Id="1"/> <Charge EquivalentAmount="25.00" EquivalentCurrency="USD" FirstPiece="1" LastPiece="1" Description1="UP TO 50 POUNDS/23 KILOGRAMS" Description2="UP TO 62 LINEAR INCHES/158 LINEAR CENTIMETERS"/> </BaggageInformation> </BaggageInformationList> </TPA_Extensions> </ItinTotalFare> </AirItineraryPricingInfo> </PricedItinerary> </PricedItineraries> </OTA_AirLowFareSearchRS>
Note: “FirstPiece” can be the same as “LastPiece” if the specified charge applies to one piece only.
Parameter: LastPiece

Type: Byte

Description: Specify last baggage piece for which the specified charge information applies.

Sample Value:

<OTA_AirLowFareSearchRS> <PricedItineraries> <PricedItinerary> <AirItineraryPricingInfo> <ItinTotalFare> <TPA_Extensions> <BaggageInformationList> <BaggageInformation ProvisionType="A" AirlineCode="K0"> <Segment Id="0"/> <Segment Id="1"/> <Allowance Weight="30" Unit="kg"/> </BaggageInformation> <BaggageInformation ProvisionType="C" AirlineCode="K0"> <Segment Id="0"/> <Segment Id="1"/> <Charge EquivalentAmount="25.00" EquivalentCurrency="USD" FirstPiece="1" LastPiece="1" Description1="UP TO 50 POUNDS/23 KILOGRAMS" Description2="UP TO 62 LINEAR INCHES/158 LINEAR CENTIMETERS"/> </BaggageInformation> </BaggageInformationList> </TPA_Extensions> </ItinTotalFare> </AirItineraryPricingInfo> </PricedItinerary> </PricedItineraries> </OTA_AirLowFareSearchRS>
Note: “LastPiece” can be the same as “FirstPiece” if the specified charge applies to one piece only.
Parameter: SettlementMethod

Type: String (Length 3 characters)

Description: The “SettlementMethod” parameter describes the settlement method verified for validating carrier(s).

Sample Value:

<OTA_AirLowFareSearchRS> <PricedItineraries> <PricedItinerary> <AirItineraryPricingInfo> <TPA_Extensions> <ValidatingCarrier SettlementMethod="NSP" NewVcxProcess="true"> <Default Code="BR"> <Country Code="NL"/> <Country Code="PL"/> </Default> <Alternate Code="LO"> <Country Code="NL"/> <Country Code="PL"/> </Alternate> </ValidatingCarrier> </TPA_Extensions> </AirItineraryPricingInfo> </PricedItinerary> </PricedItineraries> </OTA_AirLowFareSearchRS>
Note: If no settlement method is checked (SettlementValidation Ind="false" in request), NSP appears in the response.
Parameter: NewVcxProcess

Type: Boolean

Description: “NewVcxProcess” indicates whether IET validation was requested (by IETValidation Ind set as “true" or “false” in the request).

Sample Value:

<OTA_AirLowFareSearchRS> <PricedItineraries> <PricedItinerary> <AirItineraryPricingInfo> <TPA_Extensions> <ValidatingCarrier SettlementMethod="NSP" NewVcxProcess="true"> <Default Code="BR"> <Country Code="NL"/> <Country Code="PL"/> </Default> <Alternate Code="LO"> <Country Code="NL"/> <Country Code="PL"/> </Alternate> </ValidatingCarrier> </TPA_Extensions> </AirItineraryPricingInfo> </PricedItinerary> </PricedItineraries> </OTA_AirLowFareSearchRS>
Parameter: Default/@Code

Type: CarrierCode

Description: This parameter indicates the default carrier code for Settlement Method and IET validation check.

Sample Value:

<OTA_AirLowFareSearchRS> <PricedItineraries> <PricedItinerary> <AirItineraryPricingInfo> <TPA_Extensions> <ValidatingCarrier SettlementMethod="NSP" NewVcxProcess="true"> <Default Code="BR"> <Country Code="NL"/> <Country Code="PL"/> </Default> <Alternate Code="LO"> <Country Code="NL"/> <Country Code="PL"/> </Alternate> </ValidatingCarrier> </TPA_Extensions> </AirItineraryPricingInfo> </PricedItinerary> </PricedItineraries> </OTA_AirLowFareSearchRS>
Parameter: Alternate/@Code

Type: CarrierCode

Description: This parameter indicates the alternate carrier code for Settlement Method and IET check.

Sample Value:

<OTA_AirLowFareSearchRS> <PricedItineraries> <PricedItinerary> <AirItineraryPricingInfo> <TPA_Extensions> <ValidatingCarrier SettlementMethod="NSP" NewVcxProcess="true"> <Default Code="BR"> <Country Code="NL"/> <Country Code="PL"/> </Default> <Alternate Code="LO"> <Country Code="NL"/> <Country Code="PL"/> </Alternate> </ValidatingCarrier> </TPA_Extensions> </AirItineraryPricingInfo> </PricedItinerary> </PricedItineraries> </OTA_AirLowFareSearchRS>
Parameter: Country/@Code

Type: String

Description: Returns the country code in which IET validation was done for the default or alternate Validating Carrier. The format is a two-character country code as defined by ISO.

Sample Value:

<OTA_AirLowFareSearchRS> <PricedItineraries> <PricedItinerary> <AirItineraryPricingInfo> <TPA_Extensions> <ValidatingCarrier SettlementMethod="NSP" NewVcxProcess="true"> <Default Code="BR"> <Country Code="NL"/> <Country Code="PL"/> </Default> <Alternate Code="LO"> <Country Code="NL"/> <Country Code="PL"/> </Alternate> </ValidatingCarrier> </TPA_Extensions> </AirItineraryPricingInfo> </PricedItinerary> </PricedItineraries> </OTA_AirLowFareSearchRS>
Note: Above schema applies if no settlement method with IET validation checked in request: |-|SettlementValidation Ind="false"/|--| |-|IETValidation Ind="true"/|--|
Parameter: Country

Type: String

Description: Country code for which settlement method and IET validation was checked (other than the original POS). Format is a two-character country code as defined by ISO.

Sample Value:

<OTA_AirLowFareSearchRS> <PricedItineraries> <PricedItinerary> <AirItineraryPricingInfo> <TPA_Extensions> <ValidatingCarrier SettlementMethod="BSP" NewVcxProcess="true"> <Default Code="PS"/> </ValidatingCarrier> <ValidatingCarrier SettlementMethod="BSP" Country="PL" NewVcxProcess="true"> <Default Code="PS"/> </ValidatingCarrier> </TPA_Extensions> </AirItineraryPricingInfo> </PricedItinerary> </PricedItineraries> </OTA_AirLowFareSearchRS>
Note: This schema applies if settlement method with IET validation check was requested: |-|SettlementValidation Ind="true"/|--| |-|IETValidation Ind="true"/|--| |-|Country Code="PL"/|--|