New Features

In the Response

Optional

Parameter: PublishedFareCurrency

Type: String

Description: The element 'PublishedFareCurrency' is added under 'FareComponentDesc' in the GIR response. It returns the local three-letter currency code.

Sample Value:

GIR RS:
...
<FareComponentDesc ID="1" GoverningCarrier="WS" FareAmount="217.0812248381" FareCurrency="NUC" FareBasisCode="LBVF4QBK" FarePassengerType="ADT" PublishedFareAmount="217.08" PublishedFareCurrency="CAD" Directionality="FROM" ApplicablePricingCategories="2 3 5 8 10 12 16 31 33" AslRetailerRuleCode="HPSHFALL" VendorCode="ATP" FareTypeBitmap="00" FareType="EOU" FareTariff="45" FareRule="EL01" CabinCode="Y">
...

Note:

In the Response

Optional

Parameter: OriginDestinationInformationRef

Type: integer

Description: The element 'OriginDestinationInformationRef' is added to the GIR response. It serves as a reference number to 'OriginDestinationInformation' from the request and matches one-way itineraries into a full journey.

Sample Value:

GIR RS:
...
<Itinerary ID="1" PricingSource="ADVJR1" OriginDestinationInformationRef="1">
...

Note:

Functional Updates And Enhancements

In the Request

Required

Parameter: TravelerPersona

Type: string

Description: Due to the sunset of ASRM GUI (Air Shopping Rule Manager), the 'TravelPersona' attribute is removed with the 6.8.0/V5 release (06/30/2023).

Sample Value:

OTA RQ:
...
<TravelerPersona Name="ABCD"/>
...

Note: The traveler persona name identified the traveler profile to use in the Air Shopping Rules Manager. The name was to be used exclusively by the ASRM application.

In the Request

Required

Parameter: PseudoCityCode

Type: string

Description: The 'PseudoCityCode' attributes are updated to not allow lowercase letters.

Sample Value:

OTA RQ:
...
<POS>
<Source PseudoCityCode="ABC1" >
...
</Source>
</POS>
...

Note: 'PseudoCityCode': A four-character pseudo city code (PCC).

In the Response

Required

Parameter: OperatingAirline Code

Type: string

Description: The 'DisclosureAirline' code is no longer shown by default under the 'OperatingAirline' element. 'OperatingAirline' now represents the actual operating carrier code, and 'DisclosureAirline' shows the disclosure carrier code. This change is applied to any customer who adopts SOAP XML 6.8.0 or REST JSON V5 (and higher versions) of Bargain Finder Max or Revalidate Itinerary.

Sample Value:

RS Example:

<FlightSegment DepartureDateTime="2023-06-01T06:50:00" ... >
...
<OperatingAirline Code="KL" FlightNumber="1351"/>
...
<DisclosureAirline Code="WA"/>
...
</FlightSegment>

In the Response

Required

Parameter: FareCurrency

Type: string

Description: The 'FareCurrency' element is updated to display the "NUC" currency code and not the local currency code as in previous versions.

Sample Value:

RS example:
...
<FareComponentDesc ID="1" GoverningCarrier="WS" FareAmount="222.29" FareCurrency="NUC" FareBasisCode="LBVF4QBK" FarePassengerType="ADT" PublishedFareAmount="222.29" PublishedFareCurrency="CAD" Directionality="FROM" ApplicablePricingCategories="2 3 5 8 10 12 16 31 33" AslRetailerRuleCode="HPSHFALL" VendorCode="ATP" FareTypeBitmap="00" FareType="EOU" FareTariff="45" FareRule="EL01" CabinCode="Y">
...
 </FareComponentDesc>
...

In the Response

Required

Parameter: FareAmount

Type: integer

Description: The 'FareAmount' element is updated to display the "NUC" currency value and not the local currency value as in previous versions.

Sample Value:

RS example:
...
<FareComponentDesc ID="1" GoverningCarrier="WS" FareAmount="222.29" FareCurrency="NUC" FareBasisCode="LBVF4QBK" FarePassengerType="ADT" PublishedFareAmount="222.29" PublishedFareCurrency="CAD" Directionality="FROM" ApplicablePricingCategories="2 3 5 8 10 12 16 31 33" AslRetailerRuleCode="HPSHFALL" VendorCode="ATP" FareTypeBitmap="00" FareType="EOU" FareTariff="45" FareRule="EL01" CabinCode="Y">
...
 </FareComponentDesc>
...

New Features

In the Request

Optional

Parameter: UniversalTicketingAttributes

Type: boolean

Description: This parameter allows for the content of ATPCO Routehappy Universal Ticket Attributes to be returned in the response.

Sample Value:

<RichContent UniversalTicketingAttributes="true" Language="es"/>

Note: Universal Ticket Attributes (UTAs): Provide standardized, easy to integrate fare benefits and restrictions and can be composed by refundability, changes, baggage, carry-on allowance, seat selection, priority boarding attributes.

In the Request

Optional

Parameter: UniversalProductAttributes

Type: boolean

Description: Allows the user to return the content of ATPCO Routehappy Universal Product Attributes in the response.

Sample Value:

<RichContent UniversalProductAttributes="true"/>

Note: Universal Product Attributes (UPAs): Provide targeted messaging and visual content that showcases airline products and services eg., media, photos, videos, graphics, and captions.

In the Request

Optional

Parameter: FixedPCC

Type: boolean

Description: Prevents replacing the provided pseudo city code with recommendations from global shopping rules.

Sample Value:

RQ:
<POS>
<Source PseudoCityCode="ABC1" FixedPCC="true">
...
</Source>
</POS>
...
<AlternatePCC PseudoCityCode="ABC1" FixedPCC="true">
...
</AlternatePCC>

In the Response

Optional

Parameter: UniversalTicketingAttributes

Type: List

Description: Lists all Universal Ticket Attributes available on the returned flights in an indexed way that can be easily associated with flight components.

Sample Value:

OTA:
<UniversalTicketingAttributes>
<UTA Id="1" CategoryId="upgrade-eligibility" GroupCode="UP" SubCode="04E" Application="C" Assessment="fee" Headline="RXhhbXBsZSBCYXNlNjQgc3RyaW5n" Description="RXhhbXBsZSBCYXNlNjQgc3RyaW5n" CommercialName="ECONOMY PLUS TO BUSINESS" SmallIconUrl="RXhhbXBsZSBCYXNlNjQgc3RyaW5n" LargeIconUrl="RXhhbXBsZSBCYXNlNjQgc3RyaW5n"/>
...
</UniversalTicketingAttributes>

GIR:
<UTADesc ID="59" CategoryId="seat-selection" GroupCode="BF" SubCode="EPS" Application="C" Assessment="fee" Headline="RXhhbXBsZSBCYXNlNjQgc3RyaW5n" Description="RXhhbXBsZSBCYXNlNjQgc3RyaW5n" CommercialName="ECONOMY PLUS EXTRA LEG ROOM" SmallIconUrl="RXhhbXBsZSBCYXNlNjQgc3RyaW5n" LargeIconUrl="RXhhbXBsZSBCYXNlNjQgc3RyaW5n"/>

Note: Headline, Description, SmallIconUrl, and LargeIconUrl values are Base64-coded. This is due to the complexity of translations and multiple special characters used across available languages.

In the Response

Optional

Parameter: UniversalProductAttributes

Type: List

Description: Lists all Universal Product Attribute items available on the returned flights in an indexed way that can be easily associated with flight components.

Sample Value:

OTA:
<UniversalProductAttributes>
<Categories>
<Category Id="1" Name="RXhhbXBsZSBCYXNlNjQgc3RyaW5n"/>
...
</Categories>
<Media>
<Photos>
<Photo Id="1" ThumbUrl="RXhhbXBsZSBCYXNlNjQgc3RyaW5n" MediumSquareUrl="RXhhbXBsZSBCYXNlNjQgc3RyaW5n" LargeUrl="RXhhbXBsZSBCYXNlNjQgc3RyaW5n" Url="RXhhbXBsZSBCYXNlNjQgc3RyaW5n" Caption="RXhhbXBsZSBCYXNlNjQgc3RyaW5n"/>
...
</Photos>
</Media>
<UPADefinitionList>
<UPA Id="1" SmallIconUrl="RXhhbXBsZSBCYXNlNjQgc3RyaW5n" LargeIconUrl="RXhhbXBsZSBCYXNlNjQgc3RyaW5n" Headline="RXhhbXBsZSBCYXNlNjQgc3RyaW5n" Description="RXhhbXBsZSBCYXNlNjQgc3RyaW5n">
<CategoryRef Id="9"/>
<PhotoRef Id="13"/>
</UPA>
...
</UPADefinitionList>
</UniversalProductAttributes>

GIR:
<UPACategoryDesc ID="1" Name="RXhhbXBsZSBCYXNlNjQgc3RyaW5n="/>
<UPAPhotoDesc ID="1" ThumbUrl="RXhhbXBsZSBCYXNlNjQgc3RyaW5n" MediumSquareUrl="RXhhbXBsZSBCYXNlNjQgc3RyaW5n" LargeUrl="RXhhbXBsZSBCYXNlNjQgc3RyaW5n" Url="RXhhbXBsZSBCYXNlNjQgc3RyaW5n" Caption="RXhhbXBsZSBCYXNlNjQgc3RyaW5n"/>
<UPADesc ID="1" SmallIconUrl="RXhhbXBsZSBCYXNlNjQgc3RyaW5n" LargeIconUrl="RXhhbXBsZSBCYXNlNjQgc3RyaW5n" Headline="RXhhbXBsZSBCYXNlNjQgc3RyaW5n" Description="RXhhbXBsZSBCYXNlNjQgc3RyaW5n">
<Category Ref="9"/>
<Photo Ref="13"/>
</UPADesc>

Note: *NOTE: Headline, Description, SmallIconUrl, ThumbUrl, MediumSquareUrl, Caption, URL, and LargeIconUrl values are Base64 coded(this is due to the complexity and multiple special characters used across the available languages translations)

In the Response

Optional

Parameter: RichContent

Type: List

Description: Lists Rich Content information (UTA, UPA) associated with returned flights containing a specific reference ID (UTARef, UPARef).

Sample Value:

OTA, GIR:
<RichContent>
<UniversalTicketingAttributes>
<UniversalTicketingAttribute>
<UTARef Id="4"/>
<UTARef Id="1"/>
</UniversalTicketingAttribute>
<UniversalTicketingAttribute>
<Segment Id="0"/>
<UTARef Id="30"/>
<UTARef Id="29"/>
</UniversalTicketingAttribute>
...
</UniversalTicketingAttributes>
<UniversalProductAttributes>
<UniversalProductAttribute>
<Segment Id="0"/>
<UPARef Id="17"/>
<UPARef Id="24"/>
</UniversalProductAttribute>
...
</UniversalProductAttributes>
</RichContent>

In the Request

Optional

Parameter: Language

Type: string

Description: Makes it possible to specify the desired translation language for Universal Ticket and Product Attributes.

Sample Value:

<RichContent UniversalTicketingAttributes="true" Language="es"/>

Note: If the language is not specified, it defaults to EN. If translations are not available in the chosen language or the language code is incorrect, it defaults to EN.

New Features

In the Request

Optional

Parameter: AvoidCabinDowngrade

Type: boolean

Description: AvoidCabinDowngrade guarantees that lower cabin class will not be applied within a single shopping option, depending on the chosen mode: All - Apply Avoid Cabin Downgrade logic on the entire itinerary; Main - Apply Avoid Cabin Downgrade logic on the main flight of every leg; None - Disable Avoid Cabin Downgrade logic (default value).

Sample Value:

…
<TravelPreferences>
    <TPA_Extensions>
      <AvoidCabinDowngrade Mode="All"/>   <----- main level
     <FlexibleFares>
        <FareParameters>
          <Cabin Type="Y"/>
          <KeepSameCabin Enabled="true"/>
          <AvoidCabinDowngrade Mode="Main"/>  <----- flex fare level
       </FareParameters>
      </FlexibleFares>
    </TPA_Extensions>
  </TravelPreferences>
…

Note: AvoidCabinDowngrade can be used on the main or flex fare level.

New Features

In the Request

Optional

Parameter: PriorityBoarding

Type: Boolean

Description: The purpose of Shop by Priority Boarding is to enable Shopping with the ability to create a more modernized way to display relevant offers from the same or different airlines for easy comparison to travelers. [Filter mode]Supports a request to filter by the FreePriorityBoarding attribute to return only an offer that matches the condition indicated in the attribute:

Sample Value:

OTA:
...
<TravelPreferences>
...
<PriorityBoarding FreePriorityBoarding="true" Info="true"/>
...
</TravelPreferences>
...

Note: Filter mode

In the Request

Optional

Parameter: Info

Type: Boolean

Description: The purpose of Shop by Priority Boarding is to enable Shopping with the ability to create a more modernized way to display relevant offers from the same or different airlines for easy comparison to travelers. [Info mode]Supports a request to return priority boarding information about what is included in the fare regarding priority boarding.

Sample Value:

…
<PriorityBoarding Info="true"/>
…

Note: Info mode

In the Request

Optional

Parameter: Seats

Type: Boolean

Description: The purpose of Shop by Seat Pitch and Seat Type is to enable Shopping to create a more modernized way to display relevant offers from the same or different airlines for easy comparison to travelers.

Sample Value:

…
<TravelPreferences>
<TPA_Extensions>
<Seats>
<Seat Type="StandardLegroom" AtLeast="10" LessThan="34"/>
</Seats>
</TPA_Extensions>
</TravelPreferences>
…

Note: Support mode to filter by Seat Type and/or Seat Pitch (measured in inches) to return only an offer that matches the condition indicated in the attribute.

In the Request

Optional

Parameter: SeatInfo

Type: Boolean

Description: Support to return Seat Type and Seat Pitch information about what is included in the offer regarding seat type and seat pitch.

Sample Value:

…
<RichContent SeatInfo="true"/>
…

In the Response

Optional

Parameter: PriorityBoardingList

Type: Boolean

Description: PriorityBoardingList provides information for whether priority boarding is free, chargeable, or information is not available (F - Free (No charge); C - Charge; N - Not available).

Sample Value:

OTA:
…
<PriorityBoardingList>
<PriorityBoarding Type="F">
<Segment ID="0"/>
<Segment ID="1"/>
</PriorityBoarding>
</PriorityBoardingList>
...

GIR:
...
<PassengerInfo>
...
<PriorityBoarding Type="F">
<Segment ID="0"/>
<Segment ID="1"/>
</PriorityBoarding>
</PassengerInfo>
...

In the Response

Optional

Parameter: Seat

Type: Boolean

Description: List of references to flight amenities. The Seat element describes properties of seats in each cabin. These elements are later referenced from Flight Amenities.

Sample Value:

OTA:
…
<FlightAmenities>
<Seat Id="1" Pitch="31" Type="standard legroom"/>
</FlightAmenities>
…

<FareInfo>
<FareReference>M</FareReference>
<TPA_Extensions>
<SeatsRemaining Number="9" BelowMin="false"/>
<Cabin Cabin="Y"/>
<FlightAmenities SeatRef="1"/>
<Meal Code="S"/>
</TPA_Extensions>
</FareInfo>
…

GIR:
…
  <FlightAmenities>
    <Seat Id="1" Pitch="31" Type="standard legroom"/>
  </FlightAmenities>
…
<FareComponent Ref="1">
<Segment BookingCode="M" CabinCode="Y" MealCode="S" SeatsAvailable="9" AvailabilityBreak="true">
<FlightAmenities SeatRef="1"/>
</Segment>
</FareComponent>
…

New Features

In the Request

Optional

Parameter: FlightAmenities

Type: Boolean

Description: Allow distribution of the Routehappy Amenities content through BargainFinderMaxRQ and RevalidateItinRQ. The default value is false.

Sample Value:

<RichContent FlightAmenities="true"/>

Note: Amenities - Comprehensive flight amenities data about the onboard experience. Functionality requires activation. xPath: OTA_AirLowFareSearchRQ/TPA_Extensions/RichContent/@FlightAmenities

In the Request

Optional

Parameter: FreeCarryOn

Type: Boolean

Description: Allows filtering solution by availability with Free Carry-On baggage - available on Main Fare, Main Fare Leg, Flex Fares, Flex Fares Leg. Available through BargainFinderMaxRQ and RevalidateItinRQ.

Sample Value:

<TravelPreferences>
<TPA_Extensions>
<FlexibleFares>
<FareParameters>
<Baggage FreePieceRequired="true" FreeCarryOn="true"/>
<Leg Number="1">
<Baggage FreePieceRequired="false" FreeCarryOn="false"/>
</Leg>
</FareParameters>
</FlexibleFares>
</TPA_Extensions>
<Baggage Description="true" RequestType="A" RequestedPieces="4" CarryOnInfo="true" FreeCarryOn="true" FreePieceRequired="true"/>
</TravelPreferences>

Note: If one of the new attributes is specified on leg level, it is overriding the setting for the fare.

In the Request

Optional

Parameter: CarryOnInfo

Type: Boolean

Description: Show Carry-on baggage info in response - available on Main Fare. Available through BargainFinderMaxRQ and RevalidateItinRQ.

Sample Value:

<TravelPreferences>
<TPA_Extensions>
<FlexibleFares>
<FareParameters>
<Baggage FreePieceRequired="true" FreeCarryOn="true"/>
<Leg Number="1">
<Baggage FreePieceRequired="false" FreeCarryOn="false"/>
</Leg>
</FareParameters>
</FlexibleFares>
</TPA_Extensions>
<Baggage Description="true" RequestType="A" RequestedPieces="4" CarryOnInfo="true" FreeCarryOn="true" FreePieceRequired="true"/>
</TravelPreferences>

Note: If one of the new attributes is specified on leg level, it is overriding the setting for the fare.

In the Response

Required

Parameter: ProvisionType="B"

Type: BaggageProvisionType

Description: Provision Type (e.g. allowance, charges, embargo etc.) (BPT). For Carry On Allowances.

Sample Value:

OTA:

<BaggageInformationList>
<BaggageInformation ProvisionType="B" AirlineCode="DL">
<Segment Id="0"/>
<Allowance Pieces="1"/>
</BaggageInformation>
<BaggageInformation ProvisionType="B" AirlineCode="DL">
<Segment Id="1"/>
<Allowance Pieces="1"/>
</BaggageInformation>
</BaggageInformationList>


GIR:

<BaggageAllowanceDesc ID="1" Pieces="1"/>
  <BaggageAllowanceDesc ID="2" Pieces="0"/>
  <BaggageAllowanceDesc ID="3" Pieces="0"/>
  <BaggageAllowanceDesc ID="4" Pieces="1"/>
...

 <BaggageInformation ProvisionType="B" AirlineCode="DL">
             ="0"/>
              <Allowance  <Segment IDRef="4"/>
   </BaggageInformation>
   <BaggageInformation ProvisionType="B" AirlineCode="DL">
              <Segment ID="1"/>
              <Allowance Ref="4"/>
    </BaggageInformation>

Note: CarryOn in JSON response – will be returned under ProvisionType="B"  with added Allowance element or ProvisionType=“CC"  for Charge. CarryOn in GIR-JSON response – will be returned under ProvisionType=“B" with newly added Allowance element under BaggageInformation or if Charge under ProvisionType=“CC".

In the Response

Optional

Parameter: Allowance Pieces

Type: complexType / integer

Description: Allowance amount stated in pieces.

Sample Value:

OTA:

<BaggageInformationList>
<BaggageInformation ProvisionType="B" AirlineCode="DL">
<Segment Id="0"/>
<Allowance Pieces="1"/>
</BaggageInformation>
<BaggageInformation ProvisionType="B" AirlineCode="DL">
<Segment Id="1"/>
<Allowance Pieces="1"/>
</BaggageInformation>
</BaggageInformationList>


GIR:

<BaggageAllowanceDesc ID="1" Pieces="1"/>
  <BaggageAllowanceDesc ID="2" Pieces="0"/>
  <BaggageAllowanceDesc ID="3" Pieces="0"/>
  <BaggageAllowanceDesc ID="4" Pieces="1"/>
...

 <BaggageInformation ProvisionType="B" AirlineCode="DL">
             ="0"/>
              <Allowance  <Segment IDRef="4"/>
   </BaggageInformation>
   <BaggageInformation ProvisionType="B" AirlineCode="DL">
              <Segment ID="1"/>
              <Allowance Ref="4"/>
    </BaggageInformation>

Note: For OTA response the amount is returned directly with allowance, and for GIR response amount is referenced to the ID (difference shown in the sample field).

In the Request

Optional

Parameter: ProvisionType="CC"

Type: BaggageProvisionType

Description: Provision Type (e.g. allowance, charges, embargo etc.) (BPT). For Carry On Charges.

Sample Value:

OTA:

<BaggageInformationList>
<BaggageInformation ProvisionType="CC" AirlineCode="DL">
<Segment Id="0"/>
<Charge EquivalentAmount="30.00" EquivalentCurrency="USD" FirstPiece="1" LastPiece="1"/>
</BaggageInformation>
<BaggageInformation ProvisionType="CC" AirlineCode="DL">
<Segment Id="1"/>
<Charge EquivalentAmount="30.00" EquivalentCurrency="USD" FirstPiece="1" LastPiece="1"/>
</BaggageInformation>
</BaggageInformationList>


GIR:
 <BaggageChargeDesc ID="1" EquivalentAmount="40.00" EquivalentCurrency="USD" FirstPiece="2" LastPiece="2"/>
  <BaggageChargeDesc ID="2" EquivalentAmount="30.00" EquivalentCurrency="USD" FirstPiece="1" LastPiece="1"/>
  <BaggageChargeDesc ID="3" EquivalentAmount="40.00" EquivalentCurrency="USD" FirstPiece="2" LastPiece="2"/>
  <BaggageChargeDesc ID="4" EquivalentAmount="30.00" EquivalentCurrency="USD" FirstPiece="1" LastPiece="1"/>
 
…

<BaggageInformation ProvisionType=“CC" AirlineCode="DL">
              <Segment ID="0"/>
             <Charge Ref="4"/>
   </BaggageInformation>
   <BaggageInformation ProvisionType=“CC" AirlineCode="DL">
              <Segment ID="1"/>
              <Charge Ref="4"/>
    </BaggageInformation>

Note: CarryOn in OTA response – will be returned under ProvisionType="B" with added Allowance element or ProvisionType="CC" for Charge. CarryOn in GIR response – will be returned under ProvisionType="B" with new added Allowance element under BaggageInformation or if Charge under ProvisionType="CC".

In the Response

Optional

Parameter: FlightAmenities

Type: complexType

Description: Route Happy Amenities in OTA shopping response. List of references to flight amenities.

Sample Value:

OTA:
<FlightAmenities>
    <Beverage Id="1" AlcoholicCost="free" NonAlcoholicCost="free" Exists="true"/>
    <Entertainment Id="1" Exists="false" Type="none"/>
    <Food Id="1" Cost="free" Exists="true" Type="snack"/>
    <Layout Id="1" RowLayout="3-3" DirectAisleAccess="false"/>
    <Layout Id="2" RowLayout="2-2" DirectAisleAccess="false"/>
    <Power Id="1" Type="none"/>
    <Power Id="2" Cost="free" Distribution="all" Type="usb"/>
    <Seat Id="1" Pitch="30" Type="standard legroom"/>
    <Seat Id="2" Pitch="31" Type="standard legroom"/>
    <Wifi Id="1" Exists="false" Type="none"/>
  </FlightAmenities>

…

<FareInfo>
                <FareReference>T</FareReference>
                <TPA_Extensions>
                  <SeatsRemaining Number="9" BelowMin="false"/>
                  <Cabin Cabin="Y"/>
                  <FlightAmenities BeverageRef="1" EntertainmentRef="1" FoodRef="1" LayoutRef="2" PowerRef="1" SeatRef="2" WifiRef="1"/>
                  <Meal Code="S"/>
                </TPA_Extensions>
              </FareInfo>

Note: Seat Amenity - Type, Pitch / Beverages Amenity - Alcoholic cost, Nonalcoholic cost, exists / Food Amenity - Cost, Exists, Type / Power Amenity - Cost, Distribution, Type / Layout Amenity - Row layout, Direct Aisle Access / Entertainment Amenity - Cost, Exists, Type / Wi-Fi Amenity - Cost, Exists, Type

In the Response

Optional

Parameter: FlightAmenities

Type: complexType

Description: Route Happy Amenities in GIR shopping response. List of references to flight amenities.

Sample Value:

GIR:

<FlightAmenities>
    <Beverage Id="1" AlcoholicCost="free" NonAlcoholicCost="free" Exists="true"/>
    <Entertainment Id="1" Exists="false" Type="none"/>
    <Food Id="1" Cost="free" Exists="true" Type="snack"/>
    <Layout Id="1" RowLayout="3-3" DirectAisleAccess="false"/>
    <Layout Id="2" RowLayout="2-2" DirectAisleAccess="false"/>
    <Power Id="1" Type="none"/>
    <Power Id="2" Cost="free" Distribution="all" Type="usb"/>
    <Seat Id="1" Pitch="30" Type="standard legroom"/>
    <Seat Id="2" Pitch="31" Type="standard legroom"/>
    <Wifi Id="1" Exists="false" Type="none"/>
  </FlightAmenities>
…
<FareComponent Ref="1">
              <Segment BookingCode="T" CabinCode="Y" MealCode="S" SeatsAvailable="9"/>
              <Segment BookingCode="T" CabinCode="Y" MealCode="S" SeatsAvailable="9" AvailabilityBreak="true">
                <FlightAmenities BeverageRef="1" EntertainmentRef="1" FoodRef="1" LayoutRef="1" PowerRef="2" SeatRef="1" WifiRef="1"/>
              </Segment>
            </FareComponent>

Note: Seat Amenity - Type, Pitch / Beverages Amenity - Alcoholic cost, Nonalcoholic cost, exists / Food Amenity - Cost, Exists, Type / Power Amenity - Cost, Distribution, Type / Layout Amenity - Row layout, Direct Aisle Access / Entertainment Amenity - Cost, Exists, Type / Wi-Fi Amenity - Cost, Exists, Type

Functional Updates And Enhancements

In the Request

Optional

Parameter: RequestType

Type: BaggageRequestType

Description: This element allows users to request baggage information. It allows requesting CarryOn baggage information independently, without the need to display other baggage types.

Sample Value:

<TravelPreferences>
<TPA_Extensions>
<FlexibleFares>
<FareParameters>
<Baggage FreePieceRequired="true" FreeCarryOn="true"/>
<Leg Number="1">
<Baggage FreePieceRequired="false" FreeCarryOn="false"/>
</Leg>
</FareParameters>
</FlexibleFares>
</TPA_Extensions>
<Baggage Description="true" RequestType="A" RequestedPieces="4" CarryOnInfo="true" FreeCarryOn="true" FreePieceRequired="true"/>
</TravelPreferences>

Note: An existing attribute changed from required to optional.

In the Response

Optional

Parameter: EquivalentAmount

Type: MonetaryAmountType

Description: An existing attribute changed from required to optional.

Sample Value:

<BaggageInformationList>
<BaggageInformation ProvisionType="CC" AirlineCode="DL">
<Segment Id="0"/>
<Charge EquivalentAmount="30.00" EquivalentCurrency="USD" FirstPiece="1" LastPiece="1"/>
</BaggageInformation>
<BaggageInformation ProvisionType="CC" AirlineCode="DL">
<Segment Id="1"/>
<Charge EquivalentAmount="30.00" EquivalentCurrency="USD" FirstPiece="1" LastPiece="1"/>
</BaggageInformation>
</BaggageInformationList>

In the Response

Optional

Parameter: EquivalentCurrency

Type: CurrencyCodeType

Description: An existing attribute changed from required to optional.

Sample Value:

<BaggageInformationList>
<BaggageInformation ProvisionType="CC" AirlineCode="DL">
<Segment Id="0"/>
<Charge EquivalentAmount="30.00" EquivalentCurrency="USD" FirstPiece="1" LastPiece="1"/>
</BaggageInformation>
<BaggageInformation ProvisionType="CC" AirlineCode="DL">
<Segment Id="1"/>
<Charge EquivalentAmount="30.00" EquivalentCurrency="USD" FirstPiece="1" LastPiece="1"/>
</BaggageInformation>
</BaggageInformationList>

New Features

In the Request

Optional

Parameter: SeatSelection

Type: FreeSeatSelectionAndInfoType

Description: The element that will contain parameters used for pre-reserved seat processing. Allows to return pre-reserved seat data and capability to filter by free pre-reserved seat

Sample Value:

<TravelPreferences>
<TPA_Extensions>
<SeatSelection Info="true" FreeSeatSelection="false"/>
</TPA_Extensions>
</TravelPreferences>

Note: If SeatSelection element contains both Info and FreeSeatSelection then the applicable type is FreeSeatSelectionAndInfoType minOccurs="0" maxOccurs="1". If the element contains FreeSeatSelection only, then the applicable type is FreeSeatSelectionType. More details available below.

In the Request

Optional

Parameter: FreeSeatSelection

Type: boolean

Description: Filter parameter to return only fares that include Free Seat selection in the fare.

Sample Value:

<TravelPreferences>
<TPA_Extensions>
<SeatSelection Info="true" FreeSeatSelection="false"/>
</TPA_Extensions>
</TravelPreferences>

Note: Default value = false.

In the Request

Optional

Parameter: Info

Type: boolean

Description: The parameter to obtain pre-reserved seat info: F - Free; C - Charge; N - Not Applicable will be returned in the response if set to "true".

Sample Value:

<TravelPreferences>
<TPA_Extensions>
<SeatSelection Info="true" FreeSeatSelection="false"/>
</TPA_Extensions>
</TravelPreferences>

Note: Info & FreeSeatSelection are available together at the Main Fare level. Using both attributes at Main Fare enables seat information at every segment level in the Shopping Response.

In the Request

Optional

Parameter: FreeSeatSelection

Type: boolean

Description: Additional option to use FreeSeatSelection (without Info mode).

Sample Value:

<OTA_AirLowFareSearchRQ>
<TravelPreferences>
<TPA_Extensions>
<FlexibleFares>
<Leg>
<SeatSelection FreeSeatSelection="true"/>
</Leg>
</FlexibleFares>
</TPA_Extensions>
</TravelPreferences>
</OTA_AirLowFareSearchRQ>

Note: The FreeSeatSelection filter might be used at all Fare levels: Main Fare; Main Fare Leg; Flexible Fare; Flexible Fare Leg. This option allows to indicate specific part of the journey where customer is looking for Free Seats only.

In the Request

Optional

Parameter: KeepBookingCode

Type: boolean

Description: New parameter in the Shopping Exchange flow (ATPCO path).

Sample Value:

<TPA_Extensions>
<Flight Type="A" Number="445" DepartureDateTime="2021-02-20T13:00:00" ArrivalDateTime="2021-02-20T14:35:00" Shopped="false" ClassOfService="M" KeepBookingCode="true" Flown="false">
<OriginLocation LocationCode="SYD"/>
<DestinationLocation LocationCode="MEL"/>
<Airline Operating="QF" Marketing="QF"/>
<Reservation Status="OK" RealStatus="HK"/>
<BookingDateTime>2020-12-03T07:53:00</BookingDateTime>
</Flight>
<SegmentType Code="O"/>
<AlternateTime/>
<CabinPref/>
</TPA_Extensions>

Note: If set to ''true'', the original booking code will be kept for unchanged flight.

In the Request

Optional

Parameter: KeepOriginalBrand

Type: boolean

Description: New parameter in the Shopping Exchange flow (ATPCO path).

Sample Value:

<ExchangeSettings BrandedResults="false" AttachExchangeInfo="true"
ReissueExchange="A" KeepOriginalBrand="true"/>

Note: If set to ''true'', the original brand will be returned for unchanged flights.

In the Request

Optional

Parameter: Stay

Type: N/A

Description: New extension of the Stopover section,. Enhancement enables indicating the amount of nights between the connections. It is possible to indicate the min. and max. time-frames (hours).

Sample Value:

<OriginDestinationInformation>
<DepartureDateTime>2020-12-20T09:12:15</DepartureDateTime>
<OriginLocation LocationCode="JFK"/>
<DestinationLocation LocationCode="DEL"/>
<TPA_Extensions>
<Stopover>
<Stay Nights="2" MinHours="10" MaxHours="72"/>
<StopoverPoint LocationCode="AUH"/>
</Stopover>
</TPA_Extensions>
</OriginDestinationInformation>

Note: Information related to the stay at the stopover point

In the Request

Optional

Parameter: Nights

Type: nonNegativeInteger

Description: New extension of the Stopover section, enhancement to specify break between next connection. Night indicator.

Sample Value:

<OriginDestinationInformation>
<DepartureDateTime>2020-12-20T09:12:15</DepartureDateTime>
<OriginLocation LocationCode="JFK"/>
<DestinationLocation LocationCode="DEL"/>
<TPA_Extensions>
<Stopover>
<Stay Nights="2" MinHours="10" MaxHours="72"/>
<StopoverPoint LocationCode="AUH"/>
</Stopover>
</TPA_Extensions>
</OriginDestinationInformation>

Note: Number of nights spent at the stopover point.

In the Request

Optional

Parameter: MinHours

Type: nonNegativeInteger

Description: New extension of the Stopover section, enhancement to specify break between next connection. Min. hours of stay indicator.

Sample Value:

<OriginDestinationInformation>
<DepartureDateTime>2020-12-20T09:12:15</DepartureDateTime>
<OriginLocation LocationCode="JFK"/>
<DestinationLocation LocationCode="DEL"/>
<TPA_Extensions>
<Stopover>
<Stay Nights="2" MinHours="10" MaxHours="72"/>
<StopoverPoint LocationCode="AUH"/>
</Stopover>
</TPA_Extensions>
</OriginDestinationInformation>

Note: Minimum stay in hours at the stopover point.

In the Request

Optional

Parameter: MaxHours

Type: positiveInteger

Description: New extension of the Stopover section, enhancement to specify break between next connection. Max. hours of stay indicator.

Sample Value:

<OriginDestinationInformation>
<DepartureDateTime>2020-12-20T09:12:15</DepartureDateTime>
<OriginLocation LocationCode="JFK"/>
<DestinationLocation LocationCode="DEL"/>
<TPA_Extensions>
<Stopover>
<Stay Nights="2" MinHours="10" MaxHours="72"/>
<StopoverPoint LocationCode="AUH"/>
</Stopover>
</TPA_Extensions>
</OriginDestinationInformation>

Note: Maximum stay in hours at the stopover point.

In the Response

Optional

Parameter: FlightAmenities

Type: FlightAmenitiesListType

Description: Amenities are presented in an indexed way that can easily be associated with flight components.

Sample Value:

OTA Response Format:

  <FlightAmenities>
    <Seat Ref="0" Pitch="31" Type="standard legroom"/>
    <Seat Ref="1" Pitch="38" Type="cradle recliner"/>
    <Seat Ref="2" Pitch="77" Type="full flat pod"/>
    <Food Ref="0" Exists="true" Cost="paid" Type="snack"/>
    <Food Ref="1" Exists="true" Cost="free" Type="light meal"/>
    <Food Ref="2" Exists="true" Cost="free" Type="premium meal"/>
    <Food Ref="3" Exists="false"/>
  </FlightAmenities>

GIR Response Format:

   <FlightAmenities>
    <Seat Id="1" Pitch="30" Type="standard legroom"/>
    <Seat Id="2" Pitch="29" Type="below average legroom"/>
    <Seat Id="3" Pitch="31" Type="standard legroom"/>
  </FlightAmenities>

Note: List of all Flight Amenities of different types that are available on any of the returned flights.They are later referenced from other elements.

In the Response

Optional

Parameter: Seat

Type: SeatAmenityType

Description: Indicator what type of amenity has been returned.

Sample Value:

OTA Response Format:

  <FlightAmenities>
    <Seat Ref="0" Pitch="31" Type="standard legroom"/>
    <Seat Ref="1" Pitch="38" Type="cradle recliner"/>
    <Seat Ref="2" Pitch="77" Type="full flat pod"/>
    <Food Ref="0" Exists="true" Cost="paid" Type="snack"/>
    <Food Ref="1" Exists="true" Cost="free" Type="light meal"/>
    <Food Ref="2" Exists="true" Cost="free" Type="premium meal"/>
    <Food Ref="3" Exists="false"/>
  </FlightAmenities>

GIR Response Format:

   <FlightAmenities>
    <Seat Id="1" Pitch="30" Type="standard legroom"/>
    <Seat Id="2" Pitch="29" Type="below average legroom"/>
    <Seat Id="3" Pitch="31" Type="standard legroom"/>
  </FlightAmenities>

In the Response

Required

Parameter: Id

Type: nonNegativeInteger

Description: Number of the seat returned.

Sample Value:

OTA Response Format:

  <FlightAmenities>
    <Seat Ref="0" Pitch="31" Type="standard legroom"/>
    <Seat Ref="1" Pitch="38" Type="cradle recliner"/>
    <Seat Ref="2" Pitch="77" Type="full flat pod"/>
    <Food Ref="0" Exists="true" Cost="paid" Type="snack"/>
    <Food Ref="1" Exists="true" Cost="free" Type="light meal"/>
    <Food Ref="2" Exists="true" Cost="free" Type="premium meal"/>
    <Food Ref="3" Exists="false"/>
  </FlightAmenities>

GIR Response Format:

   <FlightAmenities>
    <Seat Id="1" Pitch="30" Type="standard legroom"/>
    <Seat Id="2" Pitch="29" Type="below average legroom"/>
    <Seat Id="3" Pitch="31" Type="standard legroom"/>
  </FlightAmenities>

In the Response

Optional

Parameter: Pitch

Type: simpleType

Description: The size of the returned seat type.

Sample Value:

OTA Response Format:

  <FlightAmenities>
    <Seat Ref="0" Pitch="31" Type="standard legroom"/>
    <Seat Ref="1" Pitch="38" Type="cradle recliner"/>
    <Seat Ref="2" Pitch="77" Type="full flat pod"/>
    <Food Ref="0" Exists="true" Cost="paid" Type="snack"/>
    <Food Ref="1" Exists="true" Cost="free" Type="light meal"/>
    <Food Ref="2" Exists="true" Cost="free" Type="premium meal"/>
    <Food Ref="3" Exists="false"/>
  </FlightAmenities>

GIR Response Format:

   <FlightAmenities>
    <Seat Id="1" Pitch="30" Type="standard legroom"/>
    <Seat Id="2" Pitch="29" Type="below average legroom"/>
    <Seat Id="3" Pitch="31" Type="standard legroom"/>
  </FlightAmenities>

Note: Value returned in inches.

In the Response

Optional

Parameter: Type

Type: string

Description: Name of seat type, the returned list is from Rich Content. Example values below.

Sample Value:

OTA Response Format:

  <FlightAmenities>
    <Seat Ref="0" Pitch="31" Type="standard legroom"/>
    <Seat Ref="1" Pitch="38" Type="cradle recliner"/>
    <Seat Ref="2" Pitch="77" Type="full flat pod"/>
    <Food Ref="0" Exists="true" Cost="paid" Type="snack"/>
    <Food Ref="1" Exists="true" Cost="free" Type="light meal"/>
    <Food Ref="2" Exists="true" Cost="free" Type="premium meal"/>
    <Food Ref="3" Exists="false"/>
  </FlightAmenities>

GIR Response Format:

   <FlightAmenities>
    <Seat Id="1" Pitch="30" Type="standard legroom"/>
    <Seat Id="2" Pitch="29" Type="below average legroom"/>
    <Seat Id="3" Pitch="31" Type="standard legroom"/>
  </FlightAmenities>

Note: Possible values: "middle seat free" ; "standard legroom" ; "below average legroom" ; "above average legroom" ; "skycouch" ; "recliner seat" ; "full flat seat" ; "full flat pod" ; "private suite" ; "angle flat seat" ; "cradle recliner" .

In the Response

Optional

Parameter: FlightAmenities

Type: complexType

Description: Amenities references will be returned inside FareInfos, to easily reference the amenities for each cabin and only show amenities for the cabins for which price has been also provided.

Sample Value:

OTA Response Format:

<FareInfo>
<TPA_Extensions>
<Cabin Cabin="Y"/>
<FlightAmenities Subsegment="1" SeatRef="0" FoodRef="3"/>
<!-- more flight Amenities if there are hiddeen stops -->
</TPA_Extensions>
</FareInfo>

OTA Response Format:

<FareComponent Ref="7">
<Segment BookingCode="J" CabinCode="C" MealCode="R" SeatsAvailable="9" AvailabilityBreak="true">
<FlightAmenities SeatRef="2"/>
</Segment>
</FareComponent>

Note: OTA_AirLowFareSearchRS/PricedItineraries/PricedItinerary/AirItineraryPricingInfo/PTC_FareBreakdowns/PTC_FareBreakdown/FareInfos/FareInfo/TPA_Extensions/FlightAmenities

In the Response

Optional

Parameter: Subsegment

Type: positiveInteger

Description: 1-based number of the flight "subsegment" the referred amenity applies to.

Sample Value:

OTA Response Format:

<FareInfo>
<TPA_Extensions>
<Cabin Cabin="Y"/>
<FlightAmenities Subsegment="1" SeatRef="0" FoodRef="3"/>
<!-- more flight Amenities if there are hiddeen stops -->
</TPA_Extensions>
</FareInfo>

OTA Response Format:

<FareComponent Ref="7">
<Segment BookingCode="J" CabinCode="C" MealCode="R" SeatsAvailable="9" AvailabilityBreak="true">
<FlightAmenities SeatRef="2"/>
</Segment>
</FareComponent>

Note: "Subsegment" is a portion of flight separated by a hidden stop. This attribute is omitted for flights without hidden stops.

In the Response

Optional

Parameter: SeatRef

Type: nonNegativeInteger

Description: Seat reference.

Sample Value:

OTA Response Format:

<FareInfo>
<TPA_Extensions>
<Cabin Cabin="Y"/>
<FlightAmenities Subsegment="1" SeatRef="0" FoodRef="3"/>
<!-- more flight Amenities if there are hiddeen stops -->
</TPA_Extensions>
</FareInfo>

OTA Response Format:

<FareComponent Ref="7">
<Segment BookingCode="J" CabinCode="C" MealCode="R" SeatsAvailable="9" AvailabilityBreak="true">
<FlightAmenities SeatRef="2"/>
</Segment>
</FareComponent>

In the Response

Optional

Parameter: SeatSelectionList

Type: complexType

Description: Seat Selection Information List.

Sample Value:

OTA Response Format:  
<...>
   <SeatSelectionList>
     <SeatSelection Type="N">
      <Segment ID="0"/>
      <Segment ID="1"/>
     </SeatSelection>
    </SeatSelectionList>
  <...>
  </PricedItineraries>
</OTA_AirLowFareSearchRS>

GIR Response Format:

<SeatSelection Type="F">
<Segment ID="0"/>
<Segment ID="1"/>
</SeatSelection>

Note: FlexibleFares / MFPI seat information functionality. MinOccurs="0" maxOccurs="1".

In the Response

Optional

Parameter: SeatSelection

Type: complexType

Description: Contains information if pre-reserved seat selection is free, chargeable, or if it is not applicable.

Sample Value:

OTA Response Format:  
<...>
   <SeatSelectionList>
     <SeatSelection Type="N">
      <Segment ID="0"/>
      <Segment ID="1"/>
     </SeatSelection>
    </SeatSelectionList>
  <...>
  </PricedItineraries>
</OTA_AirLowFareSearchRS>

GIR Response Format:

<SeatSelection Type="F">
<Segment ID="0"/>
<Segment ID="1"/>
</SeatSelection>

Note: FlexibleFares / MFPI seat information functionality. MinOccurs="1" maxOccurs="unbounded".

In the Response

Required

Parameter: Type

Type: string

Description: A character of one-letter seat response code.

Sample Value:

OTA Response Format:  
<...>
   <SeatSelectionList>
     <SeatSelection Type="N">
      <Segment ID="0"/>
      <Segment ID="1"/>
     </SeatSelection>
    </SeatSelectionList>
  <...>
  </PricedItineraries>
</OTA_AirLowFareSearchRS>

GIR Response Format:

<SeatSelection Type="F">
<Segment ID="0"/>
<Segment ID="1"/>
</SeatSelection>

Note: F - Free (No charge). Seat selection on listed segment is Free. ; C - Charge. Seat selection on listed segment is paid. ; N - Not applicable. Seat selection on listed segments is Not Allowed.

In the Response

Optional

Parameter: Segment ID

Type: nonNegativeInteger

Description: Segment reference ID for seat selection type.

Sample Value:

OTA Response Format:  
<...>
   <SeatSelectionList>
     <SeatSelection Type="N">
      <Segment ID="0"/>
      <Segment ID="1"/>
     </SeatSelection>
    </SeatSelectionList>
  <...>
  </PricedItineraries>
</OTA_AirLowFareSearchRS>

GIR Response Format:

<SeatSelection Type="F">
<Segment ID="0"/>
<Segment ID="1"/>
</SeatSelection>

Note: FlexibleFares / MFPI seat information functionality.

Functional Updates And Enhancements

In the Request

Optional

Parameter: Qualifier

Type: QualifierType

Description: Technical rename of an existing attribute: Qualifier to QualifierType.

Sample Value:

<TPA_Extensions>
<DataSources ATPCO="Disable" LCC="Disable" NDC="Enable"/>
<NDCIndicators>
<CarrierSpecificQualifiers CarrierCode="QF">
<AccountCode Code="FLX50"/>
</CarrierSpecificQualifiers>
<Qualifier>
<AccountCode Code="FLX50"/>
</Qualifier>
</NDCIndicators>
</TPA_Extensions>

Note: The location of the atribute in schema: OTA_AirLowFareSearchRQ/TravelPreferences/TPA_Extensions/NDCIndicators/CarrierSpecificQualifiers/Qualifier

In the Request

Optional

Parameter: DepartureDateTime

Type: IntDateTime

Description: Technical change to an existing attribute, no more required in the request.

Sample Value:

<TPA_Extensions>
<DateFlexibility NbrOfDays="0"/>
<Stopover>
<DepartureDateTime>2021-02-16T00:00:00</DepartureDateTime>
<StopoverPoint LocationCode="AUH" LocationType="A"/>
<Stay Nights="3"/>
</Stopover>
</TPA_Extensions>

Note: OTA_AirLowFareSearchRQ/OriginDestinationInformation/TPA_Extensions/Stopover/DepartureDateTime

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.

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:

|-|OriginDestinationInformation RPH="1"|--| |-|DepartureDateTime|--|2020-01-01T00:00:00|-|/DepartureDateTime|--|    |-|OriginLocation LocationCode="LAX"/|--|   |-|DestinationLocation LocationCode="JFK"/|--|  |-|TPA_Extensions|--|       |-|FareBasis Code="OVAJZNB3" PreferLevel="Preferred"/|--|       |-|FareBasis Code=“^ZP-" PreferLevel="Unacceptable"/|--|      |-|FareBasis Code="IP7J1" PreferLevel="Preferred"/|--|  |-|/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 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).

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

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

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

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

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

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:

|-|OriginDestinationInformation RPH="1"|--| |-|DepartureDateTime|--|2018-09-20T00:00:00|-|/DepartureDateTime|--|    |-|OriginLocation LocationCode="LHR"/|--|   |-|DestinationLocation LocationCode="JFK"/|--|  |-|TPA_Extensions|--|       |-|SegmentType Code="O"/|--|        |-|Baggage FreePieceRequired="true"/|--|    |-|/TPA_Extensions|--||-|/OriginDestinationInformation|--||-|TravelPreferences|--|  |-|TPA_Extensions|--|   |-|/TPA_Extensions|--|  |-|Baggage FreePieceRequired="false" RequestType="A"/|--||-|/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 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|--|

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"/|--|

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

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

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"/|--|

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

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

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

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

New Features

In the Request

Optional

Parameter: Stopover

Type: StopoverType

Description: Enforce a specific stopover point within the leg of the requested journey without separating the leg itself, preserving the original trip type (such as round trip).

Sample Value:

|-|OriginDestinationInformation RPH="1"|--|    |-|DepartureDateTime|--|2018-01-01T00:00:00|-|/DepartureDateTime|--|    |-|DepartureWindow|--|10001200|-|/DepartureWindow|--|    |-|OriginLocation LocationCode="LAX"/|--|    |-|DestinationLocation LocationCode="LGA"/|--|    |-|TPA_Extensions|--|        |-|Stopover|--|            |-|DepartureDateTime|--|2018-01-06T00:00:00|-|/DepartureDateTime|--|            |-|DepartureWindow|--|10001200|-|/DepartureWindow|--|             |-|StopoverPoint LocationCode="JFK" LocationType="A"/|--|         |-|/Stopover|--|    |-|/TPA_Extensions|--||-|/OriginDestinationInformation|--|

Note: The DepartureDateTime element is required and contains text in date plus time format: YYYY-MM-DDTHH:MM:SS. The DepartureWindow element is optional and contains text in range format: HHMMHHMM. The StopoverPoint element is required. The LocationCode attribute is required airport/city code. The LocationType attribute is optional 'A' (airport) or 'C' (city) value.

Functional Updates And Enhancements

In the Request

Optional

Parameter: Cabin

Type: CabinType

Description: Preferred cabin to be used in a search, at the leg level, in multiple fares per itinerary group definition.

Sample Value:

|-|FlexibleFares|--|    |-|FareParameters|--|       |-|Leg Num="1"|--|          |-|Cabin Type="Y"/|--|      |-|/Leg|--|     |-|Leg Num="2"|--|          |-|Cabin Type="C"/|--|      |-|/Leg|--| |-|/FareParameters|--|  |-|/FlexibleFares|--|

Note: Multiple preferred cabins can be requested at the leg level in each multiple fares per itinerary group.

New Features

In the Response

Optional

Parameter: NoChargeNotAvailable

Type: CharacterType

Description: This attribute will be returned in the response whenever there are no charge or charges are unavailable when requesting baggage information. The response might contain one of the below possible description: X - Service not available F - no charge for service (free) and an EMD is not issued to reflect free service E - No charge for service (free) and an EMD is issued to reflect the fee service. G - No charge for service (free), booking is not required and an EMD is not issued to reflect free service. H - No charge for service (free), booking is not required, and an EMD is issued to reflect the free service.

Sample Value:

|-|BaggageInformation ProvisionType="C" AirlineCode="S7"|--|    |-|Segment Id="0"/|--|  |-|Charge EquivalentAmount="0" EquivalentCurrency="RUB" Description1="UP TO 70 POUNDS/32 KILOGRAMS" Description2="UP TO 80 LINEAR INCHES/203 LINEAR CENTIMETERS" NoChargeNotAvailable="X"/|--||-|/BaggageInformation|--|

Functional Updates And Enhancements

In the Response

Optional

Parameter: NoChargeNotAvailable

Type: CharacterType

Description: This attribute will be returned in the response whenever there are no charge or charges are unavailable when requesting baggage information. The response might contain one of the below possible description: X - Service not available F - no charge for service (free) and an EMD is not issued to reflect free service E - No charge for service (free) and an EMD is issued to reflect the fee service. G - No charge for service (free), booking is not required and an EMD is not issued to reflect free service. H - No charge for service (free), booking is not required, and an EMD is issued to reflect the free service.

Sample Value:

|-|BaggageInformation ProvisionType="C" AirlineCode="S7"|--|    |-|Segment Id="0"/|--|  |-|Charge EquivalentAmount="0" EquivalentCurrency="RUB" Description1="UP TO 70 POUNDS/32 KILOGRAMS" Description2="UP TO 80 LINEAR INCHES/203 LINEAR CENTIMETERS" NoChargeNotAvailable="X"/|--||-|/BaggageInformation|--|

In the Request

Optional

Parameter: VerificationItinCallLogic

Type: VerificationItinCallLogicType

Description: The new parameter VerificationItinCallLogic and value attribute were added, which defines how the current itinerary is priced. Valid values are: • L − Look for the lowest fare (default). • M − Look in the requested RBD and requested pricing qualifiers. • B − Perform both L and M searches, and return both fares.

Sample Value:

|-|TravelPreferences|--|    |-|TPA_Extensions|--|       |-|VerificationItinCallLogic Value="L"/|--| |-|/TPA_Extensions|--||-|/TravelPreferences|--|

In the Request

Optional

Parameter: LookForAlternatives

Type: Boolean

Description: Indicator to specify to return alternative options or the lowest fare in the response.

Sample Value:

|-|TravelPreferences LookForAlternatives="true"|--| |-|VendorPref Code="K0" PreferLevel="Preferred"/|--|    |-|CabinPref Cabin="J"/|--| |-|TPA_Extensions|--|       |-|NumTrips Number="30"/|--|    |-|/TPA_Extensions|--||-|/TravelPreferences|--|

Note: If set to false, no alternative solutions will be returned in the response.

In the Response

Optional

Parameter: Repriced

Type: Boolean

Description: Indicator to identify the re-priced itinerary. The WPNI1_ITIN attribute is used to identify the alternative option returned.

Sample Value:

|-|AirItineraryPricingInfo PricingSource="WPNI1_ITIN" PricingSubSource="MIP" Repriced="true" FareReturned="true" LastTicketDate="2017-08-18"|--|    |-|ItinTotalFare|--|        |-|BaseFare Amount="947.91" CurrencyCode="USD" DecimalPlaces="2"/|--|       |-|FareConstruction Amount="947.91" CurrencyCode="USD" DecimalPlaces="2"/|--|       |-|EquivFare Amount="1210.00" CurrencyCode="AUD" DecimalPlaces="2"/|--|     |-|Taxes|--|            |-|Tax TaxCode="TOTALTAX" Amount="109.10" CurrencyCode="AUD" DecimalPlaces="2"/|--|         |-|/Taxes|--|   |-|/ItinTotalFare|--||-|/AirItineraryPricingInfo|--|

Note: When the @Repriced parameter is included with the "true” value in the response, this means the system re-priced the given itinerary with the specified flight schedule, RBD, date, and city pair.

In the Request

Required

Parameter: UsePassengerFares

Type: Boolean

Description: Indicates that at least one fare component must be applicable the passenger type specified.

Sample Value:

|-|TravelPreferences|--|    |-|TPA_Extensions|--|       |-|FlexibleFares|--|            |-|FareParameters|--|               |-|UsePassengerFares Ind="true"/|--|            |-|/FareParameters|--|      |-|/FlexibleFares|--|   |-|/TPA_Extensions|--||-|/TravelPreferences|--|

Note: This parameter can be specified by the customer at the multiple fares per itinerary group level.

In the Request

Required

Parameter: UseNegotiatedFares

Type: Boolean

Description: Indicates returned fares must match the AccountCode/CorporateID specified on at least one fare component.

Sample Value:

|-|TPA_Extensions|--|   |-|NumTrips Number="50"/|--|    |-|FlexibleFares|--|        |-|FareParameters|--|           |-|UsePassengerFares Ind="true"/|--|        |-|/FareParameters|--|      |-|FareParameters|--|           |-|UseNegotiatedFares Ind="false"/|--|      |-|/FareParameters|--|  |-|/FlexibleFares|--||-|/TPA_Extensions|--|

Note: This parameter can be specified by the customer at the multiple fares per itinerary group level.

In the Request

Optional

Parameter: ClassOfService Code

Type: ClassOfServiceType

Description: Defines the class of service to be used in a search at the leg level.

Sample Value:

|-|OriginDestinationInformation RPH="1"|--| |-|DepartureDateTime|--|2017-09-01T00:00:00|-|/DepartureDateTime|--|    |-|OriginLocation LocationCode="LAX"/|--|   |-|DestinationLocation LocationCode="JFK"/|--|  |-|TPA_Extensions|--|       |-|SegmentType Code="O"/|--|        |-|ClassOfService Code="A"/|--|     |-|ClassOfService Code="B"/|--| |-|/TPA_Extensions|--||-|/OriginDestinationInformation|--|

Note: Multiple class of services can be requested per leg in Main request and multiple fares per itinerary groups

In the Request

Optional

Parameter: ClassofService Code

Type: ClassOfServiceType

Description: This parameter is used to specify the class of service to apply to entire itinerary.

Sample Value:

|-|TravelPreferences|--|    |-|TPA_Extensions|--|       |-|ClassOfService Code="Q"/|--|     |-|ClassOfService Code="R"/|--| |-|/TPA_Extensions|--||-|/TravelPreferences|--|

Note: Multiple class of services can be requested for the entire itinerary.

In the Request

Optional

Parameter: ClassofService Code

Type: ClassOfServiceType

Description: Defines the class of service to be used in a search at the leg level in flex fare group.

Sample Value:

|-|FlexibleFares|--|    |-|FareParameters|--|       |-|Leg Num="1"|--|          |-|ClassOfService Code="F"/|--|     |-|/Leg|--|     |-|Leg Num="2"|--|          |-|ClassOfService Code="G"/|--|         |-|ClassOfService Code="H"/|--|     |-|/Leg|--| |-|/FareParameters|--||-|/FlexibleFares|--|

Note: Multiple class of services can be requested at the leg level in each multiple fares per itinerary group.

In the Request

Optional

Parameter: ClassofService Code

Type: ClassOfServiceType

Description: Defines the class of service to be used in a search for the entire multiple fares per itinerary group.

Sample Value:

|-|TravelPreferences|--|    |-|TPA_Extensions|--|       |-|FlexibleFares|--|            |-|FareParameters|--|               |-|PassengerType Code="JCB"/|--|                |-|ClassOfService Code="D"/|--|             |-|ClassOfService Code="E"/|--|         |-|/FareParameters|--|      |-|/FlexibleFares|--|   |-|/TPA_Extensions|--||-|/TravelPreferences|--|

Note: Multiple class of services can be requested in each multiple fares per itinerary group.

In the Request

Optional

Parameter: Fixed

Type: Boolean

Description: This attribute has been added to the OriginDestinationInformation element. It allows to indicate the OriginDestination node, with flight information, should be fixed from a shopping response

Sample Value:

|-|OriginDestinationInformation Fixed="true" RPH="1"|--|    |-|DepartureDateTime|--|2017-09-01T00:00:00|-|/DepartureDateTime|--|    |-|OriginLocation LocationCode="SYD"/|--|   |-|DestinationLocation LocationCode="PER"/|--|  |-|TPA_Extensions|--|       |-|Flight ArrivalDateTime="2017-08-01T06:30:00" DepartureDateTime="2015-08-01T09:50:00" Number="1" Type="A"|--|         |-|OriginLocation LocationCode="SYD"/|--|           |-|DestinationLocation LocationCode="LAX"/|--|          |-|Airline Marketing="K0" Operating="K0"/|--|       |-|/Flight|--|  |-|/TPA_Extensions|--||-|/OriginDestinationInformation|--|

In the Request

Optional

Parameter: VendorPrefPairing

Type: VendorPrefPairingType

Description: This element “VendorPrefPairing”, has been added at request level, next to the already existing “VendorPref” element. This element allows to specify which marketing and operating airline pairs are preferred or unacceptable.

Sample Value:

|-|TravelPreferences|--|    |-|VendorPrefPairing Applicability="AllSegments" PreferLevel="Preferred"|--|        |-|VendorPref Code="K0" Type="Marketing"/|--|       |-|VendorPref Code="K0" Type="Operating"/|--|   |-|/VendorPrefPairing|--|   |-|TPA_Extensions/|--||-|/TravelPreferences|--|