New Features

In the Response

Optional

Parameter: elapsedTime

Type: integer

Description: This information allows customers to display travel time for NDC and ATPCO Offers.

Sample Value:

OTA Response format: 
 
<PricedItinerary>
<AirItinerary DirectionInd="Return"/>
<OriginDestinationOptions>
<OriginDestinationOption ElapsedTime="290"/>
</OriginDestinationOptions>
</PricedItinerary>
 
GIR Response format:
 
<LegDesc ID="1" ElapsedTime="471">
<Schedule Ref="35"/>
<Schedule Ref="34"/>
</LegDesc>

Note: The elapsedTime at OriginDestinationOption in OTA Response format. The elapsedTime at legDescs level in GIR format. This parameter is available on both, NDC and ATPCO path.

In the Response

Optional

Parameter: elapsedTime

Type: integer

Description: This information allows customers to display travel time for NDC and ATPCO Offers.

Sample Value:

OTA Response format:
 
<FlightSegment DepartureDateTime="2020-05-19T11:15:00" 
ArrivalDateTime="2020-05-19T12:35:00" StopQuantity="0" 
FlightNumber="2131" ResBookDesigCode="Q" ElapsedTime="80">
<DepartureAirport LocationCode="CBR"/>
<ArrivalAirport LocationCode="MEL"/>
<Equipment AirEquipType="DH4"/>
<MarketingAirline Code="QF"/>
<MarriageGrp>I</MarriageGrp>
<DepartureTimeZone GMTOffset="10"/>
<ArrivalTimeZone GMTOffset="10"/>
<TPA_Extensions>
<eTicket Ind="true"/>
</TPA_Extensions>
</FlightSegment>
 
GIR Response format:
 
<ScheduleDesc ID="35" DotRating="6" Frequency="SM*W*F*" Stops="0" 
ETicketable="true" TotalMilesFlown="2401" ElapsedTime="321">
<Departure Airport="LAX" City="LAX" State="CA" Country="US" 
Time="06:00:00-08:00" Terminal="0"/>
<Arrival Airport="PHL" City="QPH" State="PA" Country="US" 
Time="14:21:00-05:00" Terminal="0"/>
<Carrier Marketing="AA" MarketingFlightNumber="814" Operating="AA" 
OperatingFlightNumber="814" Alliances="OW ">
<Equipment Code="321" TypeForFirstLeg="N" TypeForLastLeg="N"/>
</Carrier>
</ScheduleDesc>

Note: The elapsedTime at FlightSegment in OTA Response format. The elapsedTime at the scheduleDescs level in GIR format. This parameter is available on both NDC and ATPCO paths.

In the Response

Optional

Parameter: mandatoryInd

Type: boolean

Description: If set to 'true', indicates mandatory Offer Items that cannot be removed from the Offer. Mandatory Offer Items transition into Order Items. If not present or 'false', the Offer item is optional.

Sample Value:

OTA Response format: 
 
<AirItineraryPricingInfo FareReturned="true" PricingSource="ADVJR1" PricingSubSource="NDC_CONNECTOR">
<Offer MandatoryInd="true" OfferId="dg7d9d79cd96p8926k8jt45sc0-43" Source="NDC" TimeToLive="900"/>
</AirItineraryPricingInfo>
 
GIR Response format:
 
<PricingInformation PricingSubsource="NDC_CONNECTOR">
<Offer MandatoryInd="true" ServiceId="dg7d9d79cd96p8926k8q95jjb0-5-1-1" 
OfferId="dg7d9d79cd96p8926k8q95jjb0-5" TimeToLive="900" Source="NDC"/>
</PricingInformation>

Note: Mandatory indicator at the Fare level. Applicable for ATPCO and NDC content.

In the Response

Optional

Parameter: mandatoryInd

Type: boolean

Description: If set to 'true', indicates mandatory Offer Items that cannot be removed from the Offer. Mandatory Offer Items transition into Order Items. If not present or 'false', the Offer item is optional.

Sample Value:

OTA Response format: 
 
<PTC_FareBreakdowns>
<PTC_FareBreakdown>
<OfferItem MandatoryInd="true" 
OfferItemId="dg7d9d79cd96p8926k8jt45sc0-45-1" 
ServiceId="dg7d9d79cd96p8926k8jt45sc0-45-1-1"/>
<PassengerTypeQuantity Code="ADT" Quantity="1"/>
</PTC_FareBreakdown>
</PTC_FareBreakdowns>
 
GIR Response format:
 
<PricingInformation PricingSubsource="NDC_CONNECTOR">
<Offer OfferId="dg7d9d79cd96p8926k8q95jjb0-5" TimeToLive="900" Source="NDC"/>
<Fare ValidatingCarrierCode="AA" ETicketable="true">
<PassengerInfo OfferItemId="dg7d9d79cd96p8926k8q95jjb0-5-1" MandatoryInd="true" 
ServiceId="dg7d9d79cd96p8926k8q95jjb0-5-1-1" PassengerType="ADT" PassengerNumber="1">
</PassengerInfo>
</Fare>
</PricingInformation>

Note: Mandatory indicator at the Passenger Information level. Applicable for ATPCO and NDC content.

In the Response

Optional

Parameter: lastTicketTime

Type: string

Description: New attribute added at the Fare level.

Sample Value:

OTA Response format:
 
<AirItineraryPricingInfo PricingSource="ADVJR1" PricingSubSource="MIP" 
FareReturned="true" LastTicketDate="2020-02-15" LastTicketTime="10:28">
</AirItineraryPricingInfo>
 
GIR Response format:
 
<Itinerary ID="3" PricingSource="ADVJR1">
<PricingInformation PricingSubsource="MIP">
<Fare ValidatingCarrierCode="LO" VITA="true" ETicketable="true" LastTicketDate="2020-04-07" LastTicketTime="20:19" GoverningCarriers="LO">
</Fare>
</PricingInformation>
</Itinerary>

Note: Pattern: HH_MM

In the Response

Optional

Parameter: subgroup

Type: string

Description: Two-letter ancillary subgroup code from ATPCO filing. This is applicable only to non-standard bags, such as SP - Sporting Equipment.

Sample Value:

OTA Response format: 
 
<AncillaryFeeGroup Code="BG" Name="BAGGAGE">
<AncillaryFeeItem Amount="40.00" Description="PREPAID BAGGAGE 23KG" OriginAirport="SVO" 
DestinationAirport="LHR" Carrier="SU" PassengerCode="ADT" Date="2020-03-20" StartSegment="1" 
EndSegment="1" AncillaryTypeCode="C" Subcode="0C3" Description1="UP TO 50 POUNDS/23 KILOGRAMS" 
FirstOccurrence="1" LastOccurrence="2"/><AncillaryFeeItem Amount="50.00" 
Description="UPTO50LB 23KG AND80LI 203LCM" OriginAirport="SVO" DestinationAirport="LHR" 
Carrier="SU" PassengerCode="ADT" Date="2020-03-20" StartSegment="1" EndSegment="1" 
AncillaryTypeCode="C" Subcode="0GP" Description1="UP TO 50 POUNDS/23 KILOGRAMS" 
Description2="UP TO 80 LINEAR INCHES/203 LINEAR CENTIMETERS"/>
</AncillaryFeeGroup>
 
 
GIR Response format:
 
<AncillaryFeeGroup>
<AncillaryFee Code="BG" Name="BAGGAGE">
<Details Code="ADT" Description="PREPAID BAGGAGE 23KG" Origin="SVO" Destination="LHR" 
Carrier="SU" Amount="40.00" DepartureDate="2020-03-20" StartSegment="1" EndSegment="1" 
AncillaryTypeCode="C" Subcode="0C3" Description1="UP TO 50 POUNDS/23 KILOGRAMS" 
FirstOccurrence="1" LastOccurrence="2"/>
<Details Code="ADT" Description="UPTO50LB 23KG AND80LI 203LCM" Origin="SVO" Destination="LHR" 
Carrier="SU" Amount="50.00" DepartureDate="2020-03-20" StartSegment="1" EndSegment="1" 
AncillaryTypeCode="C" Subcode="0GP" Description1="UP TO 50 POUNDS/23 KILOGRAMS" 
Description2="UP TO 80 LINEAR INCHES/203 LINEAR CENTIMETERS"/>
</AncillaryFee>
</AncillaryFeeGroup>

Note: For standard baggage, this attribute will never be returned. The sample value represents GIR Response format, the corresponding sample for OTA Response format is available below.

In the Response

Optional

Parameter: description1 description2

Type: string

Description: Ancillary Fee description lines from ATPCO filing.

Sample Value:

OTA Response format: 
 
<AncillaryFeeGroup Code="BG" Name="BAGGAGE">
<AncillaryFeeItem Amount="40.00" Description="PREPAID BAGGAGE 23KG" OriginAirport="SVO" 
DestinationAirport="LHR" Carrier="SU" PassengerCode="ADT" Date="2020-03-20" StartSegment="1" 
EndSegment="1" AncillaryTypeCode="C" Subcode="0C3" Description1="UP TO 50 POUNDS/23 KILOGRAMS" 
FirstOccurrence="1" LastOccurrence="2"/><AncillaryFeeItem Amount="50.00" 
Description="UPTO50LB 23KG AND80LI 203LCM" OriginAirport="SVO" DestinationAirport="LHR" 
Carrier="SU" PassengerCode="ADT" Date="2020-03-20" StartSegment="1" EndSegment="1" 
AncillaryTypeCode="C" Subcode="0GP" Description1="UP TO 50 POUNDS/23 KILOGRAMS" 
Description2="UP TO 80 LINEAR INCHES/203 LINEAR CENTIMETERS"/>
</AncillaryFeeGroup>
 
 
GIR Response format:
 
<AncillaryFeeGroup>
<AncillaryFee Code="BG" Name="BAGGAGE">
<Details Code="ADT" Description="PREPAID BAGGAGE 23KG" Origin="SVO" Destination="LHR" 
Carrier="SU" Amount="40.00" DepartureDate="2020-03-20" StartSegment="1" EndSegment="1" 
AncillaryTypeCode="C" Subcode="0C3" Description1="UP TO 50 POUNDS/23 KILOGRAMS" 
FirstOccurrence="1" LastOccurrence="2"/>
<Details Code="ADT" Description="UPTO50LB 23KG AND80LI 203LCM" Origin="SVO" Destination="LHR" 
Carrier="SU" Amount="50.00" DepartureDate="2020-03-20" StartSegment="1" EndSegment="1" 
AncillaryTypeCode="C" Subcode="0GP" Description1="UP TO 50 POUNDS/23 KILOGRAMS" 
Description2="UP TO 80 LINEAR INCHES/203 LINEAR CENTIMETERS"/>
</AncillaryFee>
</AncillaryFeeGroup>

Note: Returned only for new ATPCO processing of baggage charges. The sample value represents GIR Response format, the corresponding sample for OTA Response format is available below.

In the Response

Optional

Parameter: firstOccurrence

Type: string

Description: Ancillary Baggage Information. First occurrence for which the baggage charge applies.

Sample Value:

OTA Response format: 
 
<AncillaryFeeGroup Code="BG" Name="BAGGAGE">
<AncillaryFeeItem Amount="40.00" Description="PREPAID BAGGAGE 23KG" OriginAirport="SVO" 
DestinationAirport="LHR" Carrier="SU" PassengerCode="ADT" Date="2020-03-20" StartSegment="1" 
EndSegment="1" AncillaryTypeCode="C" Subcode="0C3" Description1="UP TO 50 POUNDS/23 KILOGRAMS" 
FirstOccurrence="1" LastOccurrence="2"/><AncillaryFeeItem Amount="50.00" 
Description="UPTO50LB 23KG AND80LI 203LCM" OriginAirport="SVO" DestinationAirport="LHR" 
Carrier="SU" PassengerCode="ADT" Date="2020-03-20" StartSegment="1" EndSegment="1" 
AncillaryTypeCode="C" Subcode="0GP" Description1="UP TO 50 POUNDS/23 KILOGRAMS" 
Description2="UP TO 80 LINEAR INCHES/203 LINEAR CENTIMETERS"/>
</AncillaryFeeGroup>
 
 
GIR Response format:
 
<AncillaryFeeGroup>
<AncillaryFee Code="BG" Name="BAGGAGE">
<Details Code="ADT" Description="PREPAID BAGGAGE 23KG" Origin="SVO" Destination="LHR" 
Carrier="SU" Amount="40.00" DepartureDate="2020-03-20" StartSegment="1" EndSegment="1" 
AncillaryTypeCode="C" Subcode="0C3" Description1="UP TO 50 POUNDS/23 KILOGRAMS" 
FirstOccurrence="1" LastOccurrence="2"/>
<Details Code="ADT" Description="UPTO50LB 23KG AND80LI 203LCM" Origin="SVO" Destination="LHR" 
Carrier="SU" Amount="50.00" DepartureDate="2020-03-20" StartSegment="1" EndSegment="1" 
AncillaryTypeCode="C" Subcode="0GP" Description1="UP TO 50 POUNDS/23 KILOGRAMS" 
Description2="UP TO 80 LINEAR INCHES/203 LINEAR CENTIMETERS"/>
</AncillaryFee>
</AncillaryFeeGroup>

Note: Returned only for new ATPCO processing of baggage charges. The sample value represents GIR Response format, the corresponding sample for OTA Response format is available below.

In the Response

Optional

Parameter: lastOccurrence

Type: string

Description: Ancillary Baggage Information. Last occurrence for which the baggage charge applies. If last occurrence is not returned, baggage option has no limit of pieces that can be sold.

Sample Value:

OTA Response format: 
 
<AncillaryFeeGroup Code="BG" Name="BAGGAGE">
<AncillaryFeeItem Amount="40.00" Description="PREPAID BAGGAGE 23KG" OriginAirport="SVO" 
DestinationAirport="LHR" Carrier="SU" PassengerCode="ADT" Date="2020-03-20" StartSegment="1" 
EndSegment="1" AncillaryTypeCode="C" Subcode="0C3" Description1="UP TO 50 POUNDS/23 KILOGRAMS" 
FirstOccurrence="1" LastOccurrence="2"/><AncillaryFeeItem Amount="50.00" 
Description="UPTO50LB 23KG AND80LI 203LCM" OriginAirport="SVO" DestinationAirport="LHR" 
Carrier="SU" PassengerCode="ADT" Date="2020-03-20" StartSegment="1" EndSegment="1" 
AncillaryTypeCode="C" Subcode="0GP" Description1="UP TO 50 POUNDS/23 KILOGRAMS" 
Description2="UP TO 80 LINEAR INCHES/203 LINEAR CENTIMETERS"/>
</AncillaryFeeGroup>
 
 
GIR Response format:
 
<AncillaryFeeGroup>
<AncillaryFee Code="BG" Name="BAGGAGE">
<Details Code="ADT" Description="PREPAID BAGGAGE 23KG" Origin="SVO" Destination="LHR" 
Carrier="SU" Amount="40.00" DepartureDate="2020-03-20" StartSegment="1" EndSegment="1" 
AncillaryTypeCode="C" Subcode="0C3" Description1="UP TO 50 POUNDS/23 KILOGRAMS" 
FirstOccurrence="1" LastOccurrence="2"/>
<Details Code="ADT" Description="UPTO50LB 23KG AND80LI 203LCM" Origin="SVO" Destination="LHR" 
Carrier="SU" Amount="50.00" DepartureDate="2020-03-20" StartSegment="1" EndSegment="1" 
AncillaryTypeCode="C" Subcode="0GP" Description1="UP TO 50 POUNDS/23 KILOGRAMS" 
Description2="UP TO 80 LINEAR INCHES/203 LINEAR CENTIMETERS"/>
</AncillaryFee>
</AncillaryFeeGroup>

Note: Returned only for new ATPCO processing of baggage charges. The sample value represents GIR Response format, the corresponding sample for OTA Response format is available below

Functional Updates And Enhancements

In the Request

Optional

Parameter: Type

Type: string

Description: Flight type (A: Air Segment, K: ARUNK, O: Open Segment).

Sample Value:

<OriginDestinationInformation>
  <DepartureDateTime>2020-10-23T20:30:00</DepartureDateTime>
  <OriginLocation LocationCode="GRU"/>
  <DestinationLocation LocationCode="EZE"/>
  <Flight ArrivalDateTime="2020-10-23T23:35:00" ClassOfService="Y" DepartureDateTime="2020-10-23T20:30:00" Flown="false" Number="8014" Type="A">
       </Flight>
</OriginDestinationInformation>

Note: This is an existing parameter but it has been changed from restricted to optional, and its default value is equal to A - Air Segment. It belongs to the OriginDestinationFlightAttributeGroup.

In the Response

Optional

Parameter: fareAmount

Type: decimal

Description: An existing Fare Component parameter is now optional.

Sample Value:

<FareComponentDesc ID="17" GoverningCarrier="AA" FareAmount="67.72" FareCurrency="USD" FareBasisCode="OVAHZSB3/DRB" FarePassengerType="ADT" TicketDesignator="DRB" PublishedFareAmount="67.72" OneWayFare="true" PrivateFare="true" Directionality="FROM" Direction="WH" NotValidBefore="2020-12-25" NotValidAfter="2020-12-25" ApplicablePricingCategories="10 15 18 25" FareComponentReferenceID="1" VendorCode="ATP" FareTypeBitmap="0A" FareType="EOU" FareTariff="770" FareRule="XX26">
  <Segment/>
  <Segment/>
  <Brand Code="BASIC" BrandName="BASIC ECONOMY" ProgramID="164434" ProgramCode="AADOM" ProgramDescription="AABFDOM1S" ProgramSystemCode="A"/>
</FareComponentDesc>

Note: Changed from required to optional. The example presents GIR Response format.

In the Response

Optional

Parameter: fareCurrency

Type: CurrencyCode

Description: An existing Fare Component parameter is now optional.

Sample Value:

<FareComponentDesc ID="17" GoverningCarrier="AA" FareAmount="67.72" FareCurrency="USD" FareBasisCode="OVAHZSB3/DRB" FarePassengerType="ADT" TicketDesignator="DRB" PublishedFareAmount="67.72" OneWayFare="true" PrivateFare="true" Directionality="FROM" Direction="WH" NotValidBefore="2020-12-25" NotValidAfter="2020-12-25" ApplicablePricingCategories="10 15 18 25" FareComponentReferenceID="1" VendorCode="ATP" FareTypeBitmap="0A" FareType="EOU" FareTariff="770" FareRule="XX26">
  <Segment/>
  <Segment/>
  <Brand Code="BASIC" BrandName="BASIC ECONOMY" ProgramID="164434" ProgramCode="AADOM" ProgramDescription="AABFDOM1S" ProgramSystemCode="A"/>
</FareComponentDesc>

Note: Changed from required to optional. The example presents GIR Response format.

In the Response

Optional

Parameter: Operating

Type: CarrierCode

Description: Operating airline code.

Sample Value:

<ScheduleDesc ID="41" DotRating="5" Frequency="*M*W*F*" Stops="0" ETicketable="true" TotalMilesFlown="213" ElapsedTime="87">
  <Departure Airport="DCA" City="WAS" State="DC" Country="US" Time="19:35:00-05:00" Terminal="C"/>
  <Arrival Airport="JFK" City="NYC" State="NY" Country="US" Time="21:02:00-05:00" Terminal="8"/>
  <Carrier Marketing="AA" MarketingFlightNumber="4454" Operating="AA" OperatingFlightNumber="4454" CodeShared="REPUBLIC AIRWAYS AS AMERICAN EAGLE" Alliances="OW ">
    <Equipment Code="E75" TypeForFirstLeg="N" TypeForLastLeg="N"/>
  </Carrier>
</ScheduleDesc>

Note: Parameter already present in the schema, changed from required to optional. For the NDC offers, the operating carrier value is optional and very often might not appear in the response.

Resolved Issues

New Features

In the Request

Optional

Parameter: PreferLevel

Type: IncludeExcludePreferLevelType

Description: New parameter to support the capability for shopping to exclude a fare option based on Fare Basis Code. Allow to exclude for fares in shopping Main Fare and within MFPI (FlexFare group).

Sample Value:

<FlexibleFares>
  <FareParameters>
    <FareBasis Code="OVAJZNB3" PreferLevel="Preferred"/>
    <FareBasis Code="ZPLAXJFK" PreferLevel="Preferred"/>
    <FareBasis Code="IP7J3" PreferLevel="Unacceptable"/>
  </FareParameters>
</FlexibleFares>

Note: In the BargainFinderMax schema the PreferLevel was added in all 4 levels: Main fare, Main fare leg, Flex fare, Flex fare leg. This section covers Main fare level. Used to indicate a level of preference for an associate item: unacceptable or preferred. Default value is Preferred.

In the Request

Optional

Parameter: PreferLevel

Type: IncludeExcludePreferLevelType

Description: New parameter to support the capability for shopping to exclude a fare option based on Fare Basis Code. Allow to exclude for fares in shopping Main Fare and within MFPI (FlexFare group).

Sample Value:

Note: In the BargainFinderMax schema the PreferLevel was added in all 4 levels: Main fare, Main fare leg, Flex fare, Flex fare leg. This section covers Main fare leg level. Used to indicate a level of preference for an associate item: unacceptable or preferred. Default value is Preferred.

In the Request

Optional

Parameter: PreferLevel

Type: IncludeExcludePreferLevelType

Description: New parameter to support the capability for shopping to exclude a fare option based on Fare Basis Code. Allow to exclude for fares in shopping Main Fare and within MFPI (FlexFare group).

Sample Value:

<FlexibleFares>
  <FareParameters>
    <FareBasis Code="OVAJZNB3" PreferLevel="Preferred"/>
    <FareBasis Code="ZPLAXJFK" PreferLevel="Preferred"/>
    <FareBasis Code="IP7J3" PreferLevel="Unacceptable"/>
  </FareParameters>
</FlexibleFares>

Note: In the BargainFinderMax schema the PreferLevel was added in all 4 levels: Main fare, Main fare leg, Flex fare, Flex fare leg. This section covers Flex fare level. Used to indicate a level of preference for an associate item: unacceptable or preferred. Default value is Preferred.

In the Request

Optional

Parameter: PreferLevel

Type: IncludeExcludePreferLevelType

Description: New parameter to support the capability for shopping to exclude a fare option based on Fare Basis Code. Allow to exclude for fares in shopping Main Fare and within MFPI (FlexFare group).

Sample Value:

<FlexibleFares>
  <FareParameters>
    <Leg Num="1">
      <FareBasis Code="OVAJZNB3" PreferLevel="Preferred"/>
      <FareBasis Code="IP7J4" PreferLevel="Unacceptable"/>
    </Leg>
    <Leg Num="2">
      <FareBasis Code="IP7J5" PreferLevel="Unacceptable"/>
    </Leg>
  </FareParameters>
</FlexibleFares>

Note: In the BargainFinderMax schema the PreferLevel was added in all 4 levels: Main fare, Main fare leg, Flex fare, Flex fare leg. This section covers Flex fare leg level. Used to indicate a level of preference for an associate item: unacceptable or preferred. Default value is Preferred.

In the Request

Optional

Parameter: PreferLevel

Type: IncludeExcludePreferLevelType

Description: New parameter to support the capability for shopping to exclude a fare option based on Class of Service (RBD). Allow to exclude for fares in shopping Main Fare and within MFPI (FlexFare group).

Sample Value:

<TravelPreferences>
  <TPA_Extensions>
    <ClassOfService Code="J" PreferLevel="Unacceptable"/>
  </TPA_Extensions>
</TravelPreferences>

Note: In the BargainFinderMax schema the PreferLevel was 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. Default value is Preferred.

In the Request

Optional

Parameter: PreferLevel

Type: IncludeExcludePreferLevelType

Description: New parameter to support the capability for shopping to exclude a fare option based on Class of Service (RBD). Allow to exclude for fares in shopping Main Fare and within MFPI (FlexFare group).

Sample Value:

<OriginDestinationInformation RPH="1">
  <DepartureDateTime>2019-10-27T00:00:00</DepartureDateTime>
  <OriginLocation LocationCode="LAX"/>
  <DestinationLocation LocationCode="JFK"/>
  <TPA_Extensions>
    <ClassOfService Code="J" PreferLevel="Unacceptable"/>
  </TPA_Extensions>
</OriginDestinationInformation>

Note: In the BargainFinderMax schema the PreferLevel was added in all 4 levels: Main fare, Main fare leg, Flex fare, Flex fare leg. This section covers Main fare leg level. Used to indicate a level of preference for an associate item: unacceptable or preferred. Default value is Preferred.

In the Request

Optional

Parameter: PreferLevel

Type: IncludeExcludePreferLevelType

Description: New parameter to support the capability for shopping to exclude a fare option based on Class of Service (RBD). Allow to exclude for fares in shopping Main Fare and within MFPI (FlexFare group).

Sample Value:

<FlexibleFares>
  <FareParameters>
    <ClassOfService Code="O" PreferLevel="Preferred"/>
    <ClassOfService Code="J" PreferLevel="Unacceptable"/>
  </FareParameters>
</FlexibleFares>

Note: In the BargainFinderMax schema the PreferLevel was added in all 4 levels: Main fare, Main fare leg, Flex fare, Flex fare leg. This section covers Flex fare level. Used to indicate a level of preference for an associate item: unacceptable or preferred. Default value is Preferred.

In the Request

Optional

Parameter: PreferLevel

Type: IncludeExcludePreferLevelType

Description: New parameter to support the capability for shopping to exclude a fare option based on Class of Service (RBD). Allow to exclude for fares in shopping Main Fare and within MFPI (FlexFare group).

Sample Value:

<FlexibleFares>
  <FareParameters>
    <Leg Num="1">
      <ClassOfService Code="J" PreferLevel="Unacceptable"/>
    </Leg>
  </FareParameters>
</FlexibleFares>

Note: In the BargainFinderMax schema the PreferLevel was added in all 4 levels: Main fare, Main fare leg, Flex fare, Flex fare leg. This section covers Flex fare leg level. Used to indicate a level of preference for an associate item: unacceptable or preferred. Default value is Preferred.

In the Request

Optional

Parameter: ParityModeForLowest

Type: string

Description: Parity mode for lowest branded fare. This parameter gives the ability to apply parity mode for the main/primary fare.

Sample Value:

<PriceRequestInformation>
  <TPA_Extensions>
    <BrandedFareIndicators SingleBrandedFare="false" ParityModeForLowest="Leg" MultipleBrandedFares="true"/>
  </TPA_Extensions>
</PriceRequestInformation>

Note: If set, given parity mode will be forced on the cheapest branded fare solution. If not specified, no parity (None) is forced on the cheapest branded fare solution. It's designed to work with MultipleBrandedFares feature only.

In the Request

Optional

Parameter: RequestedOneWays

Type: positiveInteger

Description: The new parameter RequestedOneWays allows to specify the requested number of One-Way solutions in Multi-Ticket processing.

Sample Value:

<TPA_Extensions>
  <MultiTicket DisplayPolicy="SOW" RequestedOneWays="30"/>
</TPA_Extensions>

Note: Allow to set requested number of OneWays in MultiTicket processing.

In the Request

Optional

Parameter: FareComponentFareType

Type: string

Description: New Fare type descriptors in BargainFinderMax. Provides exposure of new elements in the response to describe the fare type, the fare rule, fare tariff and fare bitmap. The most relevant is return Fare type code descriptor in the response that indicates Basic Economy fares from the response. Fare type (e.g. FIT, RU).

Sample Value:

<FareBasisCodes>
  <FareBasisCode PrivateFareType="@" BookingCode="B" AvailabilityBreak="true" DepartureAirportCode="LAX" ArrivalAirportCode="JFK" FareComponentBeginAirport="LAX" FareComponentEndAirport="JFK" FareComponentDirectionality="FROM" FareComponentVendorCode="ATP" FareComponentFareTypeBitmap="0A" FareComponentFareType="EOU" FareComponentFareTariff="770" FareComponentFareRule="XX26" GovCarrier="AA">OVAJZNB3/DRB</FareBasisCode>
</FareBasisCodes>

Note: Elements "FareType", "ATPCO_FareTariff", "ATPCO_FareRule", "FareIndicator", "PrivateTariffIndicator", and "FareTypeBitmap" are rare. They are part of fare pricing. They should be sent if the carrier uses them also in ancillaries’ records (for example, if a carrier uses private/public fare indicator in the S7 rules).

In the Request

Optional

Parameter: FareComponentFareTariff

Type: string

Description: New Fare type descriptors in BargainFinderMax. Provides exposure of new elements in the response to describe the fare type, the fare rule, fare tariff and fare bitmap. The most relevant is return Fare type code descriptor in the response that indicates Basic Economy fares from the response. Fare tariff (e.g. 21).

Sample Value:

<FareBasisCodes>
  <FareBasisCode PrivateFareType="@" BookingCode="B" AvailabilityBreak="true" DepartureAirportCode="LAX" ArrivalAirportCode="JFK" FareComponentBeginAirport="LAX" FareComponentEndAirport="JFK" FareComponentDirectionality="FROM" FareComponentVendorCode="ATP" FareComponentFareTypeBitmap="0A" FareComponentFareType="EOU" FareComponentFareTariff="770" FareComponentFareRule="XX26" GovCarrier="AA">OVAJZNB3/DRB</FareBasisCode>
</FareBasisCodes>

Note: Elements "FareType", "ATPCO_FareTariff", "ATPCO_FareRule", "FareIndicator", "PrivateTariffIndicator", and "FareTypeBitmap" are rare. They are part of fare pricing. They should be sent if the carrier uses them also in ancillaries’ records (for example, if a carrier uses private/public fare indicator in the S7 rules).

In the Request

Optional

Parameter: FareComponentFareRule

Type: string

Description: New Fare type descriptors in BargainFinderMax. Provides exposure of new elements in the response to describe the fare type, the fare rule, fare tariff and fare bitmap. The most relevant is return Fare type code descriptor in the response that indicates Basic Economy fares from the response. FareRule, part of the fare pricing (e.g. 62DD, K0ST), expected if carrier uses them also in ancillaries’ records.

Sample Value:

<FareBasisCodes>
  <FareBasisCode PrivateFareType="@" BookingCode="B" AvailabilityBreak="true" DepartureAirportCode="LAX" ArrivalAirportCode="JFK" FareComponentBeginAirport="LAX" FareComponentEndAirport="JFK" FareComponentDirectionality="FROM" FareComponentVendorCode="ATP" FareComponentFareTypeBitmap="0A" FareComponentFareType="EOU" FareComponentFareTariff="770" FareComponentFareRule="XX26" GovCarrier="AA">OVAJZNB3/DRB</FareBasisCode>
</FareBasisCodes>

Note: Elements "FareType", "ATPCO_FareTariff", "ATPCO_FareRule", "FareIndicator", "PrivateTariffIndicator", and "FareTypeBitmap" are rare. They are part of fare pricing. They should be sent if the carrier uses them also in ancillaries’ records (for example, if a carrier uses private/public fare indicator in the S7 rules).

Functional Updates And Enhancements

In the Request

Optional

Parameter:

Type:

Description:

Sample Value:

Note:

Resolved Issues

In the Request

Optional

New Features

In the Request

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.

In the Request

Optional

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.

In the Request

Optional

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.

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.

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:

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

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:

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

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:

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

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.

In the Response

Optional

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.

In the Response

Optional

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.

In the Response

Optional

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.

In the Response

Optional

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>

Note:

In the Response

Optional

Parameter: ArrivalCountry

Type: Arrival country code.

Description: CountryCodeType

Sample Value:

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

Note:

In the Response

Optional

Parameter: DepartureCountry

Type: CountryCodeType

Description: Departure country code.

Sample Value:

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

Note:

In the Response

Optional

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).

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:

<PricedItineraries>
  <PricedItinerary>
    <AirItineraryPricingInfo>
      <ItinTotalFare>
        <PassengerFare>
          <TPA_Extensions>
            <CommissionData>
              <VCCInformation SourcePCC="FF9A">							</VCCInformation>
            </CommissionData>
          </TPA_Extensions>
        </PassengerFare>
      </ItinTotalFare>
    </AirItineraryPricingInfo>
  </PricedItinerary>
</PricedItineraries>

Note: Source PseudoCityCode

In the Response

Optional

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.

In the Request

Optional

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>

Note:

Functional Updates And Enhancements

In the Request

Optional

Parameter:

Type:

Description:

Sample Value:

Note:

Resolved Issues

In the Request

Optional

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).

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, 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).

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. 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).

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. 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).

In the Request

Optional

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).

In the Request

Optional

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).

In the Request

Optional

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).

In the Request

Optional

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).

Functional Updates And Enhancements

In the Request

Optional

Parameter:

Type:

Description:

Sample Value:

Note:

Resolved Issues

In the Request

Optional

New Features

In the Request

Optional

Parameter: FreePieceRequired

Type: Boolean

Description: Indicator to specify only fare options that include a bag in the fare filed to be returned. Exclude any fares that do not include at least one free bag. The parameter to be used in a search, at the leg level.

Sample Value:

Note: Only options with free pieces will be returned. It is required to specify the baggage Request type “A” - Allowance or “C” - Charges in the request, to shop for a free bag.

In the Request

Optional

Parameter: FreePieceRequired

Type: Boolean

Description: Indicator to specify only fare options that include a bag in the fare filed to be returned. Exclude any fares that do not include at least one free bag. The parameter to be used in a search for the whole journey.

Sample Value:

<TravelPreferences>
  <TPA_Extensions>
    <Baggage RequestType="A" FreePieceRequired="true"/>
  </TPA_Extensions>
</TravelPreferences>

Note: Only options with free pieces will be returned. It is required to specify the baggage Request type “A” - Allowance or “C” - Charges in the request, to shop for a bag.

In the Request

Optional

Parameter: FreePieceRequired

Type: Boolean

Description: Indicator to specify only fare options that include a bag in the fare filed to be returned. Exclude any fares that do not include at least one free bag. The parameter to be used in a search, at the leg level.

Sample Value:

<FlexibleFares>
  <FareParameters>
    <Leg Num="1">
      <Baggage FreePieceRequired="true"/>
    </Leg>
    <Leg Num="2">
      <Baggage FreePieceRequired="false"/>
    </Leg>
  </FareParameters>
</FlexibleFares>

Note: Only options with free pieces will be returned. It is required to specify the baggage Request type “A” - Allowance or “C” - Charges in the request, to shop for a free bag.

In the Request

Optional

Parameter: FreePieceRequired

Type: Boolean

Description: Indicator to specify only fare options that include a bag in the fare filed to be returned. Exclude any fares that do not include at least one free bag. The parameter to be used in a search for the multiple fares per itinerary group.

Sample Value:

<FlexibleFares>
  <FareParameters>
    <Baggage FreePieceRequired="true"/>
    <Leg Num="1">
      <Cabin Type="Y"/>
    </Leg>
    <Leg Num="2">
      <Cabin Type="Y"/>
    </Leg>
  </FareParameters>
</FlexibleFares>

Note: Only options with free pieces will be returned. It is required to specify the baggage Request type “A” - Allowance or “C” - Charges in the request, to shop for a free bag.

In the Request

Optional

Parameter: FareBasis Code

Type: FareBasisType

Description: Fare basis code(s) to be used in a search, at the leg level, in the multiple fares per itinerary group definition.

Sample Value:

<FlexibleFares>
  <FareParameters>
    <ClassOfService Code="U"/>
    <Leg Num="1">
      <ClassOfService Code="Q"/>
      <FareBasis Code="YCA-"/>
    </Leg>
  </FareParameters>
</FlexibleFares>

Note: Multiple fare basis codes can be requested at the leg level in each multiple fares per itinerary group. Allows wildcards.

In the Request

Optional

Parameter: FareBasis Code

Type: FareBasisType

Description: Defines the fare basis code(s) to be used in a search, for the whole itinerary, in the multiple fares per itinerary group definition.

Sample Value:

<FlexibleFares>
  <FareParameters>
    <PassengerTypeQuantity Code="NEG" Quantity="2"/>
    <FareBasis Code="LLX-"/>
    <FareBasis Code="-1S5"/>
  </FareParameters>
</FlexibleFares>

Note: Multiple fare basis codes can be requested in each multiple fares per itinerary group. Allows wildcards.

In the Request

Optional

Parameter: CodeShareIndicator

Type: CodeShareIndicator

Description: Ability to filter out codeshare flights. The new option is available with two attributes: “ExcludeCodeshare” removes codeshare flights. The same Marketing/Operating (base flights), can be combined with “KeepOnlines” to also return the online flights that are codeshare, for more diversity.

Sample Value:

<TravelPreferences>
  <TPA_Extensions>
    <CodeShareIndicator ExcludeCodeshare="true" KeepOnlines="false"/>
  </TPA_Extensions>
</TravelPreferences>

Note:

In the Response

Optional

Parameter: NoMarkupBaseFare

Type: Boolean

Description: Applicable to Agency Retailer subscribers. Indicates the original base selling fare, which can include any Fare Retailer Net fare Markups plus any Fare Retailer Handling Fees. Excludes all Fare Retailer Selling rule adjustments.

Sample Value:

<NoMarkupBaseFare Amount="161.00" CurrencyCode="USD"/>

Note:

In the Response

Optional

Parameter: HiddenHandlingFee

Type: Boolean

Description: Applicable to Agency Retailer subscribers. Indicates whether a Fare Retailer hidden Handling fee rule was applied.

Sample Value:

<SellingFareData LayerTypeName="ART" HiddenHandlingFee="true">
  <HandlingMarkupSummary TypeCode="A" Description="3PCT" ExtendedDescription="HAND BSE" MonetaryAmountValue="0.56" HiddenHandlingFee="true"/>
  <HandlingMarkupSummary TypeCode="C" Description="HAND PTK" ExtendedDescription="HAND PTK" MonetaryAmountValue="15.00" HiddenHandlingFee="true"/>
  <HandlingMarkupSummary TypeCode="E" Description="2PCT" ExtendedDescription="HAND TTL" MonetaryAmountValue="0.97" HiddenHandlingFee="true"/>
</SellingFareData>

Note:

In the Response

Optional

Parameter: NonHiddenHandlingFee

Type: Boolean

Description: Applicable to Agency Retailer subscribers. Indicates whether a Fare Retailer non-hidden Handling Fee rule was applied.

Sample Value:

<SellingFareData LayerTypeName="ART" NonHiddenHandlingFee="true">
  <HandlingMarkupSummary TypeCode="B" Description="5PCT" ExtendedDescription="HAND BSE" MonetaryAmountValue="1.00" NonHiddenHandlingFee="true"/>
</SellingFareData>

Note:

In the Response

Optional

Parameter: FareRetailerRule

Type: Boolean

Description: Applicable to Agency Retailer subscribers. Indicates whether a Fare Retailer-Selling level rule was applied.

Sample Value:

<HandlingMarkupSummary TypeCode="J" Description="ADJT AMT" ExtendedDescription="ADJT AMT" MonetaryAmountValue="6.04" FareRetailerRule="true"/>

Note:

In the Response

Optional

Parameter: AncillaryTypeCode

Type: String

Description: An AncillaryTypeCode that corresponds to a type of ancillary, type F or P (treated as F) and is being displayed for all the ancillary groups.

Sample Value:

<AncillaryFeeGroup Code="BG" Name="BAGGAGE">
  <AncillaryFeeItem Amount="25.00" Description="1ST ADDITIONAL BAG" OriginAirport="AMS" DestinationAirport="LHR" Carrier="KL" PassengerCode="ADT" Date="2018-04-10" StartSegment="1" EndSegment="1" AncillaryTypeCode="F" Subcode="0CC" BaggageID="1"/>
  <AncillaryFeeItem Amount="45.00" Description="2ND ADDITIONAL BAG" OriginAirport="AMS" DestinationAirport="LHR" Carrier="KL" PassengerCode="ADT" Date="2018-04-10" StartSegment="1" EndSegment="1" AncillaryTypeCode="F" Subcode="0CD" BaggageID="2"/>
  <AncillaryFeeItem Amount="45.00" Description="3RD OR MORE ADDITIONAL BAG" OriginAirport="AMS" DestinationAirport="LHR" Carrier="KL" PassengerCode="ADT" Date="2018-04-10" StartSegment="1" EndSegment="1" AncillaryTypeCode="F" Subcode="0CE" BaggageID="3"/>
  <AncillaryFeeItem Amount="30.80" Description="RUCKSACK OR KNAPSACK" OriginAirport="AMS" DestinationAirport="LHR" Carrier="KL" PassengerCode="ADT" Date="2018-04-10" StartSegment="1" EndSegment="1" AncillaryTypeCode="F" Subcode="0EB" BaggageID="4"/>
</AncillaryFeeGroup>

Note: If one of the records is F type and another P (treated as F) and both have the same subcode, P type will take precedence.

In the Response

Optional

Parameter: Subcode

Type: String

Description: Optional service industry subcodes that are being displayed for all ancillary groups.

Sample Value:

<AncillaryFeeGroup Code="BG" Name="BAGGAGE">
  <AncillaryFeeItem Amount="25.00" Description="1ST ADDITIONAL BAG" OriginAirport="AMS" DestinationAirport="LHR" Carrier="KL" PassengerCode="ADT" Date="2018-04-10" StartSegment="1" EndSegment="1" AncillaryTypeCode="F" Subcode="0CC" BaggageID="1"/>
  <AncillaryFeeItem Amount="45.00" Description="2ND ADDITIONAL BAG" OriginAirport="AMS" DestinationAirport="LHR" Carrier="KL" PassengerCode="ADT" Date="2018-04-10" StartSegment="1" EndSegment="1" AncillaryTypeCode="F" Subcode="0CD" BaggageID="2"/>
  <AncillaryFeeItem Amount="45.00" Description="3RD OR MORE ADDITIONAL BAG" OriginAirport="AMS" DestinationAirport="LHR" Carrier="KL" PassengerCode="ADT" Date="2018-04-10" StartSegment="1" EndSegment="1" AncillaryTypeCode="F" Subcode="0CE" BaggageID="3"/>
  <AncillaryFeeItem Amount="30.80" Description="RUCKSACK OR KNAPSACK" OriginAirport="AMS" DestinationAirport="LHR" Carrier="KL" PassengerCode="ADT" Date="2018-04-10" StartSegment="1" EndSegment="1" AncillaryTypeCode="F" Subcode="0EB" BaggageID="4"/>
</AncillaryFeeGroup>

Note: List of standard ATPCO subcodes: 0CC, 0CD, 0CE, 0CF, 0CG, 0CH, 0CI, 0CJ, 0CK, 0EN.

In the Response

Optional

Parameter: BaggageID

Type: BaggageIDType

Description: Baggage ID number that follows the current hierarchy in sorting Air Extras.

Sample Value:

<AncillaryFeeGroup Code="BG" Name="BAGGAGE">
  <AncillaryFeeItem Amount="25.00" Description="1ST ADDITIONAL BAG" OriginAirport="AMS" DestinationAirport="LHR" Carrier="KL" PassengerCode="ADT" Date="2018-04-10" StartSegment="1" EndSegment="1" AncillaryTypeCode="F" Subcode="0CC" BaggageID="1"/>
  <AncillaryFeeItem Amount="45.00" Description="2ND ADDITIONAL BAG" OriginAirport="AMS" DestinationAirport="LHR" Carrier="KL" PassengerCode="ADT" Date="2018-04-10" StartSegment="1" EndSegment="1" AncillaryTypeCode="F" Subcode="0CD" BaggageID="2"/>
  <AncillaryFeeItem Amount="45.00" Description="3RD OR MORE ADDITIONAL BAG" OriginAirport="AMS" DestinationAirport="LHR" Carrier="KL" PassengerCode="ADT" Date="2018-04-10" StartSegment="1" EndSegment="1" AncillaryTypeCode="F" Subcode="0CE" BaggageID="3"/>
  <AncillaryFeeItem Amount="30.80" Description="RUCKSACK OR KNAPSACK" OriginAirport="AMS" DestinationAirport="LHR" Carrier="KL" PassengerCode="ADT" Date="2018-04-10" StartSegment="1" EndSegment="1" AncillaryTypeCode="F" Subcode="0EB" BaggageID="4"/>
</AncillaryFeeGroup>

Note:

In the Response

Optional

Parameter: Code

Type: PassengerCodeType

Description: A passenger type code related to a specific baggage sequence order with applicable hints.

Sample Value:

<OrderStandardBag>
  <PassengerBags Code="ADT">
    <BaggageSequenceOrder BaggageID="1" StandardBag="1"/>
    <BaggageSequenceOrder BaggageID="2" StandardBag="2"/>
    <BaggageSequenceOrder BaggageID="3" StandardBag="3"/>
  </PassengerBags>
</OrderStandardBag>

Note:

In the Response

Required

Parameter: BaggageID

Type: BaggageIDType

Description: Baggage ID number for the applicable baggage hints.

Sample Value:

<OrderStandardBag>
  <PassengerBags Code="ADT">
    <BaggageSequenceOrder BaggageID="1" StandardBag="1"/>
    <BaggageSequenceOrder BaggageID="2" StandardBag="2"/>
    <BaggageSequenceOrder BaggageID="3" StandardBag="3"/>
  </PassengerBags>
</OrderStandardBag>

Note:

In the Response

Required

Parameter: StandardBag

Type: Short

Description: Standard baggage hint: for example, “1” is the first standard baggage, “2” is the second standard baggage.

Sample Value:

<OrderStandardBag>
  <PassengerBags Code="ADT">
    <BaggageSequenceOrder BaggageID="1" StandardBag="1"/>
    <BaggageSequenceOrder BaggageID="2" StandardBag="2"/>
    <BaggageSequenceOrder BaggageID="3" StandardBag="3"/>
  </PassengerBags>
</OrderStandardBag>

Note:

Functional Updates And Enhancements

In the Request

Optional

Parameter:

Type:

Description:

Sample Value:

Note:

Resolved Issues

In the Request

Optional