API Information

Response Format
JSON
Method/Endpoint
BargainFinderMaxRQ
Current Version
4.3.0
Target Audience
TN
Environment
Production
Documentation
Go to the Bargain Finder Max documentation

What's New

  • Bargain Finder Max has been enhanced with the following new optional search parameters:
  • Shop by Fare Type Code – to support the capability for shopping to include/exclude a fare option based on Fare Type Code.
  • Shop by Brand ID Code – to support the capability for shopping to include/exclude a fare option based on Brand ID code.

Business Value

  • Each of these enhancements enable greater personalization and efficiency to further refine the search.

New Features

In the Request

Optional

Parameter: FareType Code

Type: FareTypePrefType

Description: New parameters to support the capability for shopping to include/exclude a fare option based on Fare Type Code. The parameter to be used in a search for the whole journey.

Sample Value:

{ "TravelPreferences": { "TPA_Extensions": { "FareType": [ { "@Code": "EOU", "@PreferLevel": "Preferred" }, { "@Code": "ERU", "@PreferLevel": "Unacceptable" } ] } } }
Note: New parameter at the shopping, to filter fares by Fare Type Code filters out all unbundled (basic economy fares) which are fares filed with a fare type code = EOU (economy one-way unbundled) or ERU (economy return unbundled).
Parameter: FareType Code

Type: FareTypePrefType

Description: New parameters to support the capability for shopping to include/exclude a fare option based on Fare Type Code. The parameter to be used in a search, at the leg level.

Sample Value:

{ "OriginDestinationInformation": { "@RPH": 1, "DepartureDateTime": "2018-10-10T00:00:00", "OriginLocation": { "@LocationCode": "DFW" }, "DestinationLocation": { "@LocationCode": "KRK" }, "TPA_Extensions": { "SegmentType": { "@Code": "O" }, "FareType": [ { "@Code": "EOU", "@PreferLevel": "Preferred" }, { "@Code": "ERU", "@PreferLevel": "Preferred" } ] } } }
Note: New parameter at the shopping, to filter fares by Fare Type Code filters out all unbundled (basic economy fares) which are fares filed with a fare type code = EOU (economy one-way unbundled) or ERU (economy return unbundled).
Parameter: FareType Code

Type: FareTypePrefType

Description: New parameters to support the capability for shopping to include/exclude a fare option based on Fare Type Code. To be used in a search, for the whole itinerary, in the multiple fares per itinerary group definition.

Sample Value:

{ "TPA_Extensions": { "FlexibleFares": { "FareParameters": { "FareType": [ { "@Code": "EU", "@PreferLevel": "Preferred" }, { "@Code": "ERU", "@PreferLevel": "Preferred" } ], "Leg": [ { "@Num": 1, "FareType": { "@Code": "EU", "@PreferLevel": "Preferred" } }, { "@Num": 2, "FareType": { "@Code": "EOU", "@PreferLevel": "Unacceptable" } } ] } }, "FareType": [ { "@Code": "EOU", "@PreferLevel": "Preferred" }, { "@Code": "ERU", "@PreferLevel": "Preferred" } ] } }
Note: New parameter at the shopping, to filter fares by Fare Type Code filters out all unbundled (basic economy fares) which are fares filed with a fare type code = EOU (economy one-way unbundled) or ERU (economy return unbundled).
Parameter: FareType Code

Type: FareTypePrefType

Description: New parameters to support the capability for shopping to include/exclude a fare option based on Fare Type Code. To be used in a search, at the leg level, in the multiple fares per itinerary group definition.

Sample Value:

{ "FlexibleFares": { "FareParameters": { "Leg": [ { "@Num": 1, "FareType": { "@Code": "ERU", "@PreferLevel": "Preferred" } }, { "@Num": 2, "FareType": { "@Code": "EOU", "@PreferLevel": "Unacceptable" } } ] } } }
Note: New parameter at the shopping, to filter fares by Fare Type Code filters out all unbundled (basic economy fares) which are fares filed with a fare type code = EOU (economy one-way unbundled) or ERU (economy return unbundled).
Parameter: Brand Code

Type: BrandCodePrefType

Description: New parameter to support the capability for shopping to include/exclude a fare option based on Brand ID code. The parameter to be used in a search for the whole journey.

Sample Value:

{ "PriceRequestInformation": { "TPA_Extensions": { "BrandedFareIndicators": { "@SingleBrandedFare": "true", "BrandFilters": { "Brand": [ { "@Code": "A3", "@PreferLevel": "Preferred" }, { "@Code": "A2", "@PreferLevel": "Preferred" } ] } } } } }
Note: If brand filters are used in either single brand mode or multiple brand mode both cheapest and upsells fares will be considered for filtering. If “preferred” brands are given then only branded fares matching the brand codes will be returned. If “unacceptable” brands are given then branded fares matching this brand codes will be excluded (non-branded will stay in processing).
Parameter: Brand Code

Type: BrandCodePrefType

Description: New parameter to support the capability for shopping to include/exclude a fare option based on Brand ID code. The parameter to be used in a search, at the leg level.

Sample Value:

{ "OriginDestinationInformation": { "@RPH": 1, "DepartureDateTime": "2018-10-10T00:00:00", "OriginLocation": { "@LocationCode": "DFW" }, "DestinationLocation": { "@LocationCode": "KRK" }, "TPA_Extensions": { "SegmentType": { "@Code": "O" }, "BrandFilters": { "Brand": [ { "@Code": "A2", "@PreferLevel": "Preferred" }, { "@Code": "A3", "@PreferLevel": "Preferred" } ] } } } }
Note: If brand filters are used in either single brand mode or multiple brand mode both cheapest and upsells fares will be considered for filtering. If “preferred” brands are given then only branded fares matching the brand codes will be returned. If “unacceptable” brands are given then branded fares matching this brand codes will be excluded (non-branded will stay in processing).
Parameter: Brand Code

Type: BrandCodePrefType

Description: New parameter to support the capability for shopping to include/exclude a fare option based on Brand ID code. To be used in a search, for the whole itinerary, in the multiple fares per itinerary group definition.

Sample Value:

{ "FlexibleFares": { "FareParameters": { "BrandedFareIndicators": { "BrandFilters": { "Brand": [ { "@Code": "B2", "@PreferLevel": "Unacceptable" }, { "@Code": "A1", "@PreferLevel": "Unacceptable" } ] } } } } }
Note: If brand filters are used in multiple brand mode. The cheapest and upsells fares will be considered for filtering. If “preferred” brands are given then only branded fares matching the brand codes will be returned If “unacceptable” brands are given then branded fares matching this brand codes will be excluded (non-branded will stay in processing).
Parameter: Brand Code

Type: BrandCodePrefType

Description: New parameter to support the capability for shopping to include/exclude a fare option based on Brand ID code. To be used in a search, at the leg level, in the multiple fares per itinerary group definition.

Sample Value:

{ "FlexibleFares": { "FareParameters": { "BrandedFareIndicators": { "BrandFilters": { "Brand": [ { "@Code": "B2", "@PreferLevel": "Unacceptable" }, { "@Code": "A1", "@PreferLevel": "Unacceptable" } ] } }, "Leg": [ { "@Num": 1, "FareType": { "@Code": "EU", "@PreferLevel": "Preferred" }, "BrandFilters": { "Brand": [ { "@Code": "A1", "@PreferLevel": "Unacceptable" }, { "@Code": "A2", "@PreferLevel": "Unacceptable" } ] } }, { "@Num": 2, "FareType": { "@Code": "EU", "@PreferLevel": "Unacceptable" }, "BrandFilters": { "Brand": [ { "@Code": "B3", "@PreferLevel": "Unacceptable" }, { "@Code": "B4", "@PreferLevel": "Unacceptable" } ] } } ] } } }
Note: If brand filters are used in multiple brand mode. The cheapest and upsells fares will be considered for filtering. If “preferred” brands are given then only branded fares matching the brand codes will be returned If “unacceptable” brands are given then branded fares matching this brand codes will be excluded (non-branded will stay in processing).