Skip to main content

Revalidate Itinerary

6.6.0
Air
Reservation
SOAP API
Travel Agency
  • Revalidate Itinerary SOAP API version was upgraded to 6.6.0 to keep the same versioning as BFM SOAP API.
  • AvoidCabinDowngrade - new optional elements in the shopping request.

API Information

Response Format
XML
Service Action Code
RevalidateItinRQ
Current Version
6.6.0
Target Audience
TN
Environment
Production

What's New

  • Revalidate Itinerary SOAP API version was upgraded to 6.6.0 to keep the same versioning as BFM SOAP API.
  • AvoidCabinDowngrade - new optional elements in the shopping request.

Business Value

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

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.

Relase note ID: 17233


  • The Revalidate Itinerary Request has been enhanced with the following changes:
  • Shop by Priority boarding - new optional elements in the shopping request and response.
  • Shop by Seat type/pitch - new optional elements in the shopping request and response.

API Information

Response Format
XML
Service Action Code
RevalidateItinRQ
Current Version
6.5.0
Target Audience
TN
Environment
Production

What's New

  • The Revalidate Itinerary Request has been enhanced with the following changes:
  • Shop by Priority boarding - new optional elements in the shopping request and response.
  • Shop by Seat type/pitch - new optional elements in the shopping request and response.

Business Value

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

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

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

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

Relase note ID: 16737


  • The Revalidate Itinerary OTA and GIR Responses has been enhanced with minor fixes.

API Information

Response Format
XML
Service Action Code
RevalidateItinRQ
Current Version
6.4.0
Target Audience
TN
Environment
Production

What's New

  • The Revalidate Itinerary OTA and GIR Responses has been enhanced with minor fixes.

Business Value

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

Relase note ID: 16369


  • The Revalidate Itinerary Request has been enhanced with the following changes:
  • Flight Amenities - distribute ATPCO Routehappy rich content via Revalidate Itinerary.
  • Shop by Carry-On baggage - two new attributes added into existing baggage sections.
  • The Revalidate Itinerary OTA and GIR Response have been enhanced with the new parameters and other changes listed below:
  • Shop by Carry-On baggage - new elements in the shopping response.
  • Flight Amenities - new ATPCO Routehappy rich content in the shopping response.
  • Baggage Charge EquivalentAmount and EquivalentCurrency attributes were changed from required to optional.

API Information

Response Format
XML
Service Action Code
RevalidateItinRQ
Current Version
6.3.0
Target Audience
TN
Environment
Production

What's New

  • The Revalidate Itinerary Request has been enhanced with the following changes:
  • Flight Amenities - distribute ATPCO Routehappy rich content via Revalidate Itinerary.
  • Shop by Carry-On baggage - two new attributes added into existing baggage sections.
  • The Revalidate Itinerary OTA and GIR Response have been enhanced with the new parameters and other changes listed below:
  • Shop by Carry-On baggage - new elements in the shopping response.
  • Flight Amenities - new ATPCO Routehappy rich content in the shopping response.
  • Baggage Charge EquivalentAmount and EquivalentCurrency attributes were changed from required to optional.

Business Value

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

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

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

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

Relase note ID: 15991


  • The Revalidate Itinerary Request has been enhanced with the following changes:
  • Pre Reserved Seat Selection - Enables to return pre-reserved seat data and capability to filter by free pre-reserved seat.
  • TN Exchange & Refund - New attributes available on the Shopping Exchange path; KeepBookingCode & KeepOriginalBrand.
  • Stopover section enhancement enables indicating the amount of nights between the connections. It is possible to indicate the min. and max. time-frames (hours).
  • Functional update for the existing parameters: Qualifier & DepartureDateTime.
  • The Revalidate Itinerary OTA and GIR Response have been enhanced with the new parameters and other changes listed below:
  • Flight Amenities - Seat type. Changes to the response schema to support flight amenities information in regard to Seat type and Seat pitch.
  • Pre reserved seat selection - changes to the response schema to support pre-reserved seat information.

API Information

Response Format
XML
Service Action Code
RevalidateItinRQ
Current Version
6.2.0
Target Audience
TN
Environment
Production

What's New

  • The Revalidate Itinerary Request has been enhanced with the following changes:
  • Pre Reserved Seat Selection - Enables to return pre-reserved seat data and capability to filter by free pre-reserved seat.
  • TN Exchange & Refund - New attributes available on the Shopping Exchange path; KeepBookingCode & KeepOriginalBrand.
  • Stopover section enhancement enables indicating the amount of nights between the connections. It is possible to indicate the min. and max. time-frames (hours).
  • Functional update for the existing parameters: Qualifier & DepartureDateTime.
  • The Revalidate Itinerary OTA and GIR Response have been enhanced with the new parameters and other changes listed below:
  • Flight Amenities - Seat type. Changes to the response schema to support flight amenities information in regard to Seat type and Seat pitch.
  • Pre reserved seat selection - changes to the response schema to support pre-reserved seat information.

Business Value

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

New Features

In the Request

Optional

Parameter: SeatSelection

Type: FreeSeatSelectionAndInfoType

Description: Element that will contain parameters used for pre-reserved seat processing.

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: Parameter to obtain pre-reserved seat info: F - Free; C - Charge; N - Not Applicable.

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

In the Response

Optional

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

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

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

Optional

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

Relase note ID: 15801