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 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:

|-|AllBrandsPricingRQ|--|
    |-|PriceRequestInformation|--|
        |-|BrandedFareIndicators|--|
            |-|BrandFilters|--|
                |-|NonBrandedFares PreferLevel="Preferred"/|--|
            |-|/BrandFilters|--|
        |-|/BrandedFareIndicators|--|
    |-|/PriceRequestInformation|--|
|-|/AllBrandsPricingRQ|--|

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. Used to indicate a level of preference for an associate item: unacceptable or preferred.

Functional Updates And Enhancements

In the Response

Optional

Parameter: RequestedCode

Type: PassengerTypeCodeType

Description: New attribute has been added to PassangerDetail section /SUM/PXI/@B71

Sample Value:

|-|AllBrandsPricingRS|--|
    |-|Summary|--|
        |-|PassengerDetails|--|
            |-|PassengerDetail PassengerTypeCode="ADT" RequestedCode="ADT"|--|
            |-|/PassengerDetail|--|
        |-|/PassengerDetails|--|
    |-|/Summary|--|
|-|/AllBrandsPricingRS|--|

Note: New optional attribute added to PassengerTypeCode (/SUM/PXI/@B70) - RequestedCode. This enhancement enables to match the requested passenger type between Request and Response.

In the Response

Optional

Parameter: FareTypeBitmap

Type: FareTypeBitmapType

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

Sample Value:

|-|FareComponents|--|
    |-|FareComponent PricingUnitCount="1" PricingUnitType="O" GlobalDirection="AT" FareCalcDirectionality="FR" CommencementDate="2019-12-01" StopoverInd="false" CabinCode="S" BrandId="PECFL" BrandName="PREMIUM ECONOMY FLEXIBLE" ProgramCode="AAAT" ProgramName="AABFAT1S" ProgramSystemCode="B" ProgramID="154838" FareTypeBitmap="00"|--|
    |-|/FareComponent|--|
|-|/FareComponents|--|

Note: Attribute FareTypeBitmap added in 1Q Release, changed from required to optional.

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 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:

|-|AllBrandsPricingRQ|--|
    |-|PriceRequestInformation|--|
        |-|BrandedFareIndicators|--|
            |-|BrandFilters|--|
                |-|NonBrandedFares PreferredLevel="Preferred"/|--|
            |-|/BrandFilters|--|
        |-|/BrandedFareIndicators|--|
    |-|/PriceRequestInformation|--|
|-|/AllBrandsPricingRQ|--|

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. Used to indicate a level of preference for an associate item: unacceptable or preferred.

In the Response

Optional

Parameter: SourcePCC

Type: PseudoCityCodeType

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

Sample Value:

|-|AllBrandsPricingRS|--|
    |-|Summary|--|
        |-|PassengerDetails|--|
            |-|PassengerDetail|--|
                |-|ValidatingCarrierCommissions|--|
                    |-|ValidatingCarrierCommission SourcePCC="A1D0"|--|
                    |-|/ValidatingCarrierCommission|--|
                |-|/ValidatingCarrierCommissions|--|
            |-|/PassengerDetail|--|
        |-|/PassengerDetails|--|
    |-|/Summary|--|
|-|/AllBrandsPricingRS|--|

Note: Source PseudoCityCode

In the Response

Optional

Parameter: FareTypeBitmap

Type: FareTypeBitmapType

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

Sample Value:

|-|AllBrandsPricingRS|--|
    |-|Summary|--|
        |-|PassengerDetails|--|
            |-|PassengerDetail|--|
                |-|PassengerFare|--|
                    |-|FareCalculation|--|
                        |-|FareComponents|--|
                            |-|FareComponent FareTypeBitmap="04"|--|
                            |-|/FareComponent|--|
                        |-|/FareComponents|--|
                    |-|/FareCalculation|--|
                |-|/PassengerFare|--|
            |-|/PassengerDetail|--|
        |-|/PassengerDetails|--|
    |-|/Summary|--|
|-|/AllBrandsPricingRS|--|

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.

New Features

In the Request

Optional

Parameter: Brand Code

Type: BrandCodeType

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|--|  |-|PassengerTypes|--|       |-|PassengerType Code="ADT" Count="1"/|--|  |-|/PassengerTypes|--|  |-|ApplyBrandOCFees Ind="true"/|--| |-|BrandedFareIndicators ItinParityBrandlessLeg="true" ItinParityFallbackMode="LowestSingle" ParityMode="Itin"|--|      |-|BrandFilters|--|         |-|Brand Code="Q3" PreferredLevel="Preferred"/|--|      |-|/BrandFilters|--|    |-|/BrandedFareIndicators|--||-|/PriceRequestInformation|--|

Note: When the brand filters are used, 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).

New Features

In the Request

Required

Parameter: LegNumber Id

Type: Short

Description: Identifies the leg number.

Sample Value:

|-|SegmentInformation SegmentNumber="2"|--| |-|LegNumber Id="2"/|--||-|/SegmentInformation|--|

In the Request

Optional

Parameter: UpsellLimit

Type: Integer

Description: New parameter to limit the number of branded fare upsell solutions to be returned.

Sample Value:

  |-|PriceRequestInformation|--|    |-|PassengerTypes|--|      |-|PassengerType Code="ADT" Count="1" /|--|    |-|/PassengerTypes|--|    |-|ApplyBrandOCFees Ind="true" /|--|    |-|BrandedFareIndicators ParityMode="Leg” UpsellLimit="2" /|--|  |-|/PriceRequestInformation|--|

In the Request

Optional

Parameter: ItinParityBrandlessLeg

Type: Boolean

Description: New parameter to allow for brand-less leg solutions when itinerary parity is requested.

Sample Value:

  |-|PriceRequestInformation|--|    |-|PassengerTypes|--|      |-|PassengerType Code="ADT" Count="1" /|--|    |-|/PassengerTypes|--|    |-|ApplyBrandOCFees Ind="true" /|--|    |-|BrandedFareIndicators ParityMode="Itin" ItinParityFallbackMode="LowestSingle" ItinParityBrandlessLeg="true" /|--|  |-|/PriceRequestInformation|--|

In the Request

Optional

Parameter: ParityMode

Type: String

Description: New parameter to control the brand parity logic preference (Leg Parity or Itinerary Parity).

Sample Value:

  |-|PriceRequestInformation|--|    |-|PassengerTypes|--|      |-|PassengerType Code="ADT" Count="1" /|--|    |-|/PassengerTypes|--|    |-|Account Code="TNPAR001" /|--|    |-|ApplyBrandOCFees Ind="true" /|--|    |-|BrandedFareIndicators ParityMode="Itin" /|--|  |-|/PriceRequestInformation|--|

Note: ParityMode and ItinParityFallbackMode parameters are optional. When specifying the ParityMode=”Itin” at the request level without specifying the ItinParityFallbackMode, then the default fallback mode in the “BFM rule” level will be applied. Possible fallback modes: LowestSingle (no upsell options only lowest single possible branded solutions) or Leg (upsells generated using leg parity mode).

In the Request

Optional

Parameter: ItinParityFallbackMode

Type: String

Description: New parameter to control the fall back mode logic when brand itinerary parity cannot be met (lowest single brand or leg parity).

Sample Value:

|-|PriceRequestInformation|--|    |-|PassengerTypes|--|      |-|PassengerType Code="ADT" Count="1" /|--|    |-|/PassengerTypes|--|    |-|ApplyBrandOCFees Ind="true" /|--|    |-|BrandedFareIndicators ParityMode="Itin" ItinParityFallbackMode="LowestSingle" ItinParityBrandlessLeg="true" /|--|  |-|/PriceRequestInformation|--|

Note: Possible FallBack modes to be used are: LowestSingle (no upsell options only lowest single possible branded solutions) or Leg (upsells generated using leg parity mode).