API Information

Response Format
XML
Service Action Code
BargainFinderMaxRQ
Current Version
5.1.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:
  • Branded Fare Attributes - Parameter to request brand attributes, allows Sabre agencies to return additional brand attributes in the response it returns the structured data filed in table 166. Brand attributes is a feature within the Branded fares capabilities and will be returned with single and multiple branded fares request
  • Exclude Non-Branded Fares - Allows for only branded fares to be returned when requesting single or multiple brands
  • Alternate Airport Cross Border Indicator - Added flexibility to determine whether alternate airports can be in other country than main pair when mileage is used
  • Credit Card Fee - The credit card amount returned with Low-Cost-Carriers options added at passenger level
  • Booking Fee - The booking fee amount returned with Low-Cost-Carriers options added at passenger level
  • Source PCC - The source PCC of the contract processed for Agency Managed Commission will be added for audit and tracking purposes
  • Fare Type Bitmap - A fare pricing component related to ancillaries offer

Business Value

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

New Features

In the Request

Required

Parameter: NonBrandedFares

Type: complexType

Description: New Parameter to allow to exclude non-branded fares in the shopping response. When the PreferLevel is set to “Preferred" this means “Use non-branded fares”. If this is single filter (no other preferred elements) the meaning is “Use ONLY non-branded fares”. If other preferred filters are also used the meaning is “Use non-branded fares or fares with given (in filters) brands”. When the PreferLevel is set to “Unacceptable" this means “Do not use non-branded fares”. If this is single filter (no other unacceptable elements) the meaning is “Use ONLY branded fares – skip all non-branded”. If other unacceptable filters are also used the meaning is “Use only branded fares excluding fares matching given (in filters) brands”.

Sample Value:

<PriceRequestInformation> <TPA_Extensions> <BrandedFareIndicators SingleBrandedFare="true"> <BrandFilters> <Brand Code="A3" PreferLevel="Unacceptable"/> <NonBrandedFares PreferLevel="Preferred"/> </BrandFilters> </BrandedFareIndicators> </TPA_Extensions> </PriceRequestInformation>
Note: In the BargainFinderMax schema version 5.1.0, the NonBrandedFares were added in all 4 levels: Main fare, Main fare leg, Flex fare, Flex fare leg. This section covers Main Fare. Used to indicate a level of preference for an associate item: unacceptable or preferred.
Parameter: NonBrandedFares

Type: complexType

Description: New Parameter to allow to exclude non-branded fares in the shopping response. When the PreferLevel is set to “Preferred" this means “Use non-branded fares”. If this is single filter (no other preferred elements) the meaning is “Use ONLY non-branded fares”. If other preferred filters are also used the meaning is “Use non-branded fares or fares with given (in filters) brands”. When the PreferLevel is set to “Unacceptable" this means “Do not use non-branded fares”. If this is single filter (no other unacceptable elements) the meaning is “Use ONLY branded fares – skip all non-branded”. If other unacceptable filters are also used the meaning is “Use only branded fares excluding fares matching given (in filters) brands”.

Sample Value:

<OriginDestinationInformation RPH="1"> <DepartureDateTime>2019-10-10T00:00:00</DepartureDateTime> <OriginLocation LocationCode="DFW"/> <DestinationLocation LocationCode="KRK"/> <TPA_Extensions> <SegmentType Code="O"/> <BrandFilters> <Brand Code="A2" PreferLevel="Preferred"/> <NonBrandedFares PreferLevel="Preferred"/> </BrandFilters> </TPA_Extensions> </OriginDestinationInformation>
Note: In the BargainFinderMax schema version 5.1.0, the NonBrandedFares were added in all 4 levels: Main fare, Main fare leg, Flex fare, Flex fare leg. This section covers Main Fare leg. Used to indicate a level of preference for an associate item: unacceptable or preferred.
Parameter: NonBrandedFares

Type: complexType

Description: New Parameter to allow to exclude non-branded fares in the shopping response. When the PreferLevel is set to “Preferred" this means “Use non-branded fares”. If this is single filter (no other preferred elements) the meaning is “Use ONLY non-branded fares”. If other preferred filters are also used the meaning is “Use non-branded fares or fares with given (in filters) brands”. When the PreferLevel is set to “Unacceptable" this means “Do not use non-branded fares”. If this is single filter (no other unacceptable elements) the meaning is “Use ONLY branded fares – skip all non-branded”. If other unacceptable filters are also used the meaning is “Use only branded fares excluding fares matching given (in filters) brands”.

Sample Value:

<FlexibleFares> <FareParameters> <BrandedFareIndicators> <BrandFilters> <NonBrandedFares PreferLevel="Preferred"/> </BrandFilters> </BrandedFareIndicators> </FareParameters> </FlexibleFares>
Note: In the BargainFinderMax schema version 5.1.0, the NonBrandedFares were added in all 4 levels: Main fare, Main fare leg, Flex fare, Flex fare leg. This section covers Flex Fare. Used to indicate a level of preference for an associate item: unacceptable or preferred.
Parameter: NonBrandedFares

Type: complexType

Description: New Parameter to allow to exclude non-branded fares in the shopping response. When the PreferLevel is set to “Preferred" this means “Use non-branded fares”. If this is single filter (no other preferred elements) the meaning is “Use ONLY non-branded fares”. If other preferred filters are also used the meaning is “Use non-branded fares or fares with given (in filters) brands”. When the PreferLevel is set to “Unacceptable" this means “Do not use non-branded fares”. If this is single filter (no other unacceptable elements) the meaning is “Use ONLY branded fares – skip all non-branded”. If other unacceptable filters are also used the meaning is “Use only branded fares excluding fares matching given (in filters) brands”.

Sample Value:

<FlexibleFares> <FareParameters> <BrandedFareIndicators> <BrandFilters> <Brand Code="B2" PreferLevel="Unacceptable"/> <NonBrandedFares PreferLevel="Preferred"/> </BrandFilters> </BrandedFareIndicators> <Leg Num="1"> <FareType Code="EU" PreferLevel="Preferred"/> <BrandFilters> <Brand Code="A2" PreferLevel=" Preferred "/> <NonBrandedFares PreferLevel="Preferred"/> </BrandFilters> </Leg> </FareParameters> </FlexibleFares>
Note: In the BargainFinderMax schema version 5.1.0, the NonBrandedFares were added in all 4 levels: Main fare, Main fare leg, Flex fare, Flex fare leg. This section covers Flex Fare leg. Used to indicate a level of preference for an associate item: unacceptable or preferred.

Optional

Parameter: AllowBorderCross

Type: boolean

Description: New parameter set from default to true. In addition to SisterDestinationMileage, it enables to cross a given country border if an alternative Airport is in the range of mileage radius.

Sample Value:

<OriginDestinationInformation> <TPA_Extensions> <SisterDestinationMileage AllowBorderCross="true"> </SisterDestinationMileage> </TPA_Extensions> </OriginDestinationInformation>
Note: Allow to return alternate airports from other countries. Default value is true. AllowBorderCross configuration set at AlternateAirportMileage overrides values of the same parameter set at leg level.
Parameter: AllowBorderCross

Type: boolean

Description: New parameter set from default to true. In addition to SisterOriginMileage it enables to cross a given country border if an alternative Airport is in the range of requested mileage radius.

Sample Value:

<OriginDestinationInformation> <TPA_Extensions> <SisterOriginMileage AllowBorderCross="true"> </SisterOriginMileage> </TPA_Extensions> </OriginDestinationInformation>
Note: Allow to return alternate airports from other countries. Default value is true. AllowBorderCross configuration set at AlternateAirportMileage overrides values of the same parameter set at leg level.
Parameter: AllowBorderCross

Type: boolean

Description: New parameter set from default to true. In addition to AlternateAirportMileage it enables to cross a given country border if an alternative Airport is in the range of requested mileage radius.

Sample Value:

<TPA_Extensions> <AlternateAirportMileage AllowBorderCross="true"> </AlternateAirportMileage> </TPA_Extensions>
Note: Allow to return alternate airports from other countries. Default value is true. AllowBorderCross configuration set at AlternateAirportMileage overrides values of the same parameter set at leg level.
Parameter: ReturnBrandAncillaries

Type: boolean

Description: To request brand attributes, allows Sabre agencies to return additional brand attributes in the response it returns the structured data filed in table 166. Brand attributes is a feature within the Branded fares capabilities and will be returned with single and multiple branded fares request.

Sample Value:

<TravelerInfoSummary> <SeatsRequested>1</SeatsRequested> <AirTravelerAvail> <PassengerTypeQuantity Code="ADT" Quantity="1"> <TPA_Extensions> <VoluntaryChanges Match="Info"/> </TPA_Extensions> </PassengerTypeQuantity> </AirTravelerAvail> <PriceRequestInformation CurrencyCode="USD"> <TPA_Extensions> <BrandedFareIndicators MultipleBrandedFares="true" ReturnBrandAncillaries="true"/> </TPA_Extensions> </PriceRequestInformation> </TravelerInfoSummary>

In the Response

Optional

Parameter: BookingFee

Type: CurrencyAmountType

Description: BookingFee returned with LCC options, added at Passenger level.

Sample Value:

<PricedItineraries> <PricedItinerary> <AirItineraryPricingInfo> <PTC_FareBreakdowns> <PTC_FareBreakdown> <PassengerFare> <BookingFee Amount="42.94" CurrencyCode="EUR" DecimalPlaces="2"/> </PassengerFare> </PTC_FareBreakdown> </PTC_FareBreakdowns> </AirItineraryPricingInfo> </PricedItinerary> </PricedItineraries>
Note: Booking fee. Returned only if non-zero value.
Parameter: BookingFee

Type: CurrencyAmountType

Description: BookingFee returned with LCC options, at TotalFare level.

Sample Value:

<PricedItineraries> <PricedItinerary> <AirItineraryPricingInfo> <ItinTotalFare> <BookingFee Amount="42.94" CurrencyCode="USD" DecimalPlaces="2"/> </ItinTotalFare> </AirItineraryPricingInfo> </PricedItinerary> </PricedItineraries>
Note: Booking fee. Returned only if non-zero value.
Parameter: CreditCardFee

Type: CurrencyAmountType

Description: CreditCardFee returned with LCC options, added at passenger level.

Sample Value:

<PricedItineraries> <PricedItinerary> <AirItineraryPricingInfo> <PTC_FareBreakdowns> <PTC_FareBreakdown> <PassengerFare> <CreditCardFee Amount="10.00" CurrencyCode="EUR" DecimalPlaces="2"/> </PassengerFare> </PTC_FareBreakdown> </PTC_FareBreakdowns> </AirItineraryPricingInfo> </PricedItinerary> </PricedItineraries>
Note: CreditCardFee. Returned only if non-zero value.
Parameter: CreditCardFee

Type: CurrencyAmountType

Description: CreditCardFee returned with LCC options, at TotalFare level.

Sample Value:

<PricedItineraries> <PricedItinerary> <AirItineraryPricingInfo> <ItinTotalFare> <CreditCardFee Amount="42.94" CurrencyCode="EUR" DecimalPlaces="2"/> </ItinTotalFare> </AirItineraryPricingInfo> </PricedItinerary> </PricedItineraries>
Note: CreditCardFee. Returned only if non-zero value.
Parameter: SourcePCC

Type: String

Description: PCC of contract processed for Agency Managed Commission which is added for audit/tracking purposes.

Sample Value:

<AirItineraryPricingInfo> <ItinTotalFare> <TPA_Extensions> <CommissionData> <VCCInformation SourcePCC="FF9A"> </VCCInformation> </CommissionData> </TPA_Extensions> </ItinTotalFare> </AirItineraryPricingInfo>
Parameter: ArrivalCountry

Type: Arrival country code.

Description: CountryCodeType

Sample Value:

<PricedItineraries> <PricedItinerary> <AirItinerary> <OriginDestinationOptions> <OriginDestinationOption ArrivalCountry="UK"> </OriginDestinationOption> </OriginDestinationOptions> </AirItinerary> </PricedItinerary> </PricedItineraries>
Parameter: DepartureCountry

Type: CountryCodeType

Description: Departure country code.

Sample Value:

<PricedItineraries> <PricedItinerary> <AirItinerary> <OriginDestinationOptions> <OriginDestinationOption DepartureCountry="UK"> </OriginDestinationOption> </OriginDestinationOptions> </AirItinerary> </PricedItinerary> </PricedItineraries>
Parameter: TotalFare

Type: TotalFareType

Description: TotalFare element added at FareComponent level, similiar to TotalFare at Leg level.

Sample Value:

<PricedItinerary> <AirItineraryPricingInfo> <ItinTotalFare> <TPA_Extensions> <FareComponents> <FareComponent> <TotalFare Amount="1" CurrencyCode="USD" DecimalPlaces="1"/> </FareComponent> </FareComponents> </TPA_Extensions> </ItinTotalFare> </AirItineraryPricingInfo> </PricedItinerary>
Note: Returned if split taxes by FareComponent (only).
Parameter: SourcePCC

Type: PseudoCityCodeType

Description: The PCC of the contract processed for Agency Managed Commission which is added for audit/tracking purposes.

Sample Value:

<PricedItineraries> <PricedItinerary> <AirItineraryPricingInfo> <ItinTotalFare> <PassengerFare> <TPA_Extensions> <CommissionData> <VCCInformation SourcePCC="FF9A"> </VCCInformation> </CommissionData> </TPA_Extensions> </PassengerFare> </ItinTotalFare> </AirItineraryPricingInfo> </PricedItinerary> </PricedItineraries>
Note: Source PseudoCityCode
Parameter: FareComponentFareTypeBitmap

Type: string

Description: A fare pricing component returned by the carrier if used also in ancillaries records.

Sample Value:

<AirItineraryPricingInfo> <PTC_FareBreakdowns> <FareBasisCodes FareComponentFareTypeBitmap="06"> </FareBasisCodes> </PTC_FareBreakdowns> </AirItineraryPricingInfo>
Note: FareTypeBitmap represents sum of following possible values: 0x00 - Normal, 0x01 - Discounted, 0x02 - Fare by Rule, 0x04 - Negotiated, 0x08 - Private, Eg. 0x06 = Fare by Rule Negotiated.