Skip to main content

Revalidate Itinerary

6.1.0
Air
Reservation
SOAP API
  • Flight type (A: Air Segment, K: ARUNK, O: Open Segment) has been changed from required to optional.
  • Deleted Passenger Type Code. NOTE: The below optional parameter is no longer available for our customers: PassengerType/@Code - more information available in SAN 15673 from 10th SEP 2019.
  • The Revalidate Itinerary API OTA and GIR Response have been enhanced with the new parameters and other changes listed below:
  • ElapsedTime attribute has been added at the ScheduleDesc and LegDesc levels.
  • The MandatoryInd indicates mandatory Offer Items that cannot be removed from the Offer. Added at the Fare and Passenger Information levels.
  • New attribute LastTicketTime added at FareType level.
  • Ancillaries Baggage information - For carriers migrated to the new ATPCO baggage processing, new ancillaryTypeCode value "C" will occur, along with new optional elements: "subgroup", "description1", "description2", "firstOccurrence", "lastOccurrence".
  • The Parameters FareAmount and FareCurrency at FareComponentDesc level have been changed to optional.
  • The Operating Carrier Code has been changed from required to optional.

API Information

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

What's New

  • Flight type (A: Air Segment, K: ARUNK, O: Open Segment) has been changed from required to optional.
  • Deleted Passenger Type Code. NOTE: The below optional parameter is no longer available for our customers: PassengerType/@Code - more information available in SAN 15673 from 10th SEP 2019.
  • The Revalidate Itinerary API OTA and GIR Response have been enhanced with the new parameters and other changes listed below:
  • ElapsedTime attribute has been added at the ScheduleDesc and LegDesc levels.
  • The MandatoryInd indicates mandatory Offer Items that cannot be removed from the Offer. Added at the Fare and Passenger Information levels.
  • New attribute LastTicketTime added at FareType level.
  • Ancillaries Baggage information - For carriers migrated to the new ATPCO baggage processing, new ancillaryTypeCode value "C" will occur, along with new optional elements: "subgroup", "description1", "description2", "firstOccurrence", "lastOccurrence".
  • The Parameters FareAmount and FareCurrency at FareComponentDesc level have been changed to optional.
  • The Operating Carrier Code has been changed from required to optional.

Business Value

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

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: A 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 the 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 it's 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.

Relase note ID: 14285


  • Revalidate Itinerary has been enhanced with the following new optional search parameters:
  • Shop by Fare Basis Code – project introduces enhancements to our Bargain Finder Max and Revalidate Itinerary API to support the capability for shopping to exclude a fare option based on Fare Basis Code.
  • Shop by – Class of Service – project introduces enhancements to our Bargain Finder Max and Revalidate Itinerary API to support the capability for shopping to exclude a fare option based on Class of Service (RBD).
  • Shop with parity mode – the project introduces enhancements to our Multiple Branded Fare shopping capabilities that allows to control the parity mode also for the lowest fare returned.
  • Enhanced Multi-Ticket – the new parameter allows to specify the requested number of One-Way solutions in Multi-Ticket processing.
  • Ancillary elements GAO - new Fare type descriptors in Bargain Finder Max. Exposure of new elements in the response to describe the fare type, the fare rule and fare tariff. The most relevant is return Fare type code descriptor in the response that indicates Basic Economy fares from the response.

API Information

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

What's New

  • Revalidate Itinerary has been enhanced with the following new optional search parameters:
  • Shop by Fare Basis Code – project introduces enhancements to our Bargain Finder Max and Revalidate Itinerary API to support the capability for shopping to exclude a fare option based on Fare Basis Code.
  • Shop by – Class of Service – project introduces enhancements to our Bargain Finder Max and Revalidate Itinerary API to support the capability for shopping to exclude a fare option based on Class of Service (RBD).
  • Shop with parity mode – the project introduces enhancements to our Multiple Branded Fare shopping capabilities that allows to control the parity mode also for the lowest fare returned.
  • Enhanced Multi-Ticket – the new parameter allows to specify the requested number of One-Way solutions in Multi-Ticket processing.
  • Ancillary elements GAO - new Fare type descriptors in Bargain Finder Max. Exposure of new elements in the response to describe the fare type, the fare rule and fare tariff. The most relevant is return Fare type code descriptor in the response that indicates Basic Economy fares from the response.

Business Value

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

New Features

In the Request

Optional

Parameter: PreferLevel

Type: IncludeExcludePreferLevelType

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

Sample Value:

<FlexibleFares>
  <FareParameters>
    <FareBasis Code="OVAJZNB3" PreferLevel="Preferred"/>
    <FareBasis Code="ZPLAXJFK" PreferLevel="Preferred"/>
    <FareBasis Code="IP7J3" PreferLevel="Unacceptable"/>
  </FareParameters>
</FlexibleFares>
Note: In the BargainFinderMax schema the PreferLevel was added in all 4 levels: Main fare, Main fare leg, Flex fare, Flex fare leg. This section covers Main fare level. Used to indicate a level of preference for an associate item: unacceptable or preferred. Default value is Preferred.

In the Request

Optional

Parameter: PreferLevel

Type: IncludeExcludePreferLevelType

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

Sample Value:

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

In the Request

Optional

Parameter: PreferLevel

Type: IncludeExcludePreferLevelType

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

Sample Value:

<FlexibleFares>
  <FareParameters>
    <FareBasis Code="OVAJZNB3" PreferLevel="Preferred"/>
    <FareBasis Code="ZPLAXJFK" PreferLevel="Preferred"/>
    <FareBasis Code="IP7J3" PreferLevel="Unacceptable"/>
  </FareParameters>
</FlexibleFares>
Note: In the BargainFinderMax schema the PreferLevel was added in all 4 levels: Main fare, Main fare leg, Flex fare, Flex fare leg. This section covers Flex fare level. Used to indicate a level of preference for an associate item: unacceptable or preferred. Default value is Preferred.

In the Request

Optional

Parameter: PreferLevel

Type: IncludeExcludePreferLevelType

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

Sample Value:

<FlexibleFares>
  <FareParameters>
    <Leg Num="1">
      <FareBasis Code="OVAJZNB3" PreferLevel="Preferred"/>
      <FareBasis Code="IP7J4" PreferLevel="Unacceptable"/>
    </Leg>
    <Leg Num="2">
      <FareBasis Code="IP7J5" PreferLevel="Unacceptable"/>
    </Leg>
  </FareParameters>
</FlexibleFares>
Note: In the BargainFinderMax schema the PreferLevel was added in all 4 levels: Main fare, Main fare leg, Flex fare, Flex fare leg. This section covers Flex fare leg level. Used to indicate a level of preference for an associate item: unacceptable or preferred. Default value is Preferred.

In the Request

Optional

Parameter: PreferLevel

Type: IncludeExcludePreferLevelType

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

Sample Value:

<TravelPreferences>
  <TPA_Extensions>
    <ClassOfService Code="J" PreferLevel="Unacceptable"/>
  </TPA_Extensions>
</TravelPreferences>
Note: In the BargainFinderMax schema the PreferLevel was added in all 4 levels: Main fare, Main fare leg, Flex fare, Flex fare leg. This section covers Main Fare. Used to indicate a level of preference for an associate item: unacceptable or preferred. Default value is Preferred.

In the Request

Optional

Parameter: PreferLevel

Type: IncludeExcludePreferLevelType

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

Sample Value:

<OriginDestinationInformation RPH="1">
  <DepartureDateTime>2019-10-27T00:00:00</DepartureDateTime>
  <OriginLocation LocationCode="LAX"/>
  <DestinationLocation LocationCode="JFK"/>
  <TPA_Extensions>
    <ClassOfService Code="J" PreferLevel="Unacceptable"/>
  </TPA_Extensions>
</OriginDestinationInformation>
Note: In the BargainFinderMax schema the PreferLevel was added in all 4 levels: Main fare, Main fare leg, Flex fare, Flex fare leg. This section covers Main fare leg level. Used to indicate a level of preference for an associate item: unacceptable or preferred. Default value is Preferred.

In the Request

Optional

Parameter: PreferLevel

Type: IncludeExcludePreferLevelType

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

Sample Value:

<FlexibleFares>
  <FareParameters>
    <ClassOfService Code="O" PreferLevel="Preferred"/>
    <ClassOfService Code="J" PreferLevel="Unacceptable"/>
  </FareParameters>
</FlexibleFares>
Note: In the BargainFinderMax schema the PreferLevel was added in all 4 levels: Main fare, Main fare leg, Flex fare, Flex fare leg. This section covers Flex fare level. Used to indicate a level of preference for an associate item: unacceptable or preferred. Default value is Preferred.

In the Request

Optional

Parameter: PreferLevel

Type: IncludeExcludePreferLevelType

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

Sample Value:

<FlexibleFares>
  <FareParameters>
    <Leg Num="1">
      <ClassOfService Code="J" PreferLevel="Unacceptable"/>
    </Leg>
  </FareParameters>
</FlexibleFares>
Note: In the BargainFinderMax schema the PreferLevel was added in all 4 levels: Main fare, Main fare leg, Flex fare, Flex fare leg. This section covers Flex fare leg level. Used to indicate a level of preference for an associate item: unacceptable or preferred. Default value is Preferred.

In the Request

Optional

Parameter: ParityModeForLowest

Type: string

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

Sample Value:

<PriceRequestInformation>
  <TPA_Extensions>
    <BrandedFareIndicators SingleBrandedFare="false" ParityModeForLowest="Leg" MultipleBrandedFares="true"/>
  </TPA_Extensions>
</PriceRequestInformation>
Note: If set, given parity mode will be forced on the cheapest branded fare solution. If not specified, no parity (None) is forced on the cheapest branded fare solution. It's designed to work with MultipleBrandedFares feature only.

In the Request

Optional

Parameter: RequestedOneWays

Type: positiveInteger

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

Sample Value:

<TPA_Extensions>
  <MultiTicket DisplayPolicy="SOW" RequestedOneWays="30"/>
</TPA_Extensions>
Note: Allow to set requested number of OneWays in MultiTicket processing.

In the Request

Optional

Parameter: FareComponentFareType

Type: string

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

Sample Value:

<FareBasisCodes>
  <FareBasisCode PrivateFareType="@" BookingCode="B" AvailabilityBreak="true" DepartureAirportCode="LAX" ArrivalAirportCode="JFK" FareComponentBeginAirport="LAX" FareComponentEndAirport="JFK" FareComponentDirectionality="FROM" FareComponentVendorCode="ATP" FareComponentFareTypeBitmap="0A" FareComponentFareType="EOU" FareComponentFareTariff="770" FareComponentFareRule="XX26" GovCarrier="AA">OVAJZNB3/DRB</FareBasisCode>
</FareBasisCodes>
Note: Elements "FareType", "ATPCO_FareTariff", "ATPCO_FareRule", "FareIndicator", "PrivateTariffIndicator", and "FareTypeBitmap" are rare. They are part of fare pricing. They should be sent if the carrier uses them also in ancillaries’ records (for example, if a carrier uses private/public fare indicator in the S7 rules).

In the Request

Optional

Parameter: FareComponentFareTariff

Type: string

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

Sample Value:

<FareBasisCodes>
  <FareBasisCode PrivateFareType="@" BookingCode="B" AvailabilityBreak="true" DepartureAirportCode="LAX" ArrivalAirportCode="JFK" FareComponentBeginAirport="LAX" FareComponentEndAirport="JFK" FareComponentDirectionality="FROM" FareComponentVendorCode="ATP" FareComponentFareTypeBitmap="0A" FareComponentFareType="EOU" FareComponentFareTariff="770" FareComponentFareRule="XX26" GovCarrier="AA">OVAJZNB3/DRB</FareBasisCode>
</FareBasisCodes>
Note: Elements "FareType", "ATPCO_FareTariff", "ATPCO_FareRule", "FareIndicator", "PrivateTariffIndicator", and "FareTypeBitmap" are rare. They are part of fare pricing. They should be sent if the carrier uses them also in ancillaries’ records (for example, if a carrier uses private/public fare indicator in the S7 rules).

In the Request

Optional

Parameter: FareComponentFareRule

Type: string

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

Sample Value:

<FareBasisCodes>
  <FareBasisCode PrivateFareType="@" BookingCode="B" AvailabilityBreak="true" DepartureAirportCode="LAX" ArrivalAirportCode="JFK" FareComponentBeginAirport="LAX" FareComponentEndAirport="JFK" FareComponentDirectionality="FROM" FareComponentVendorCode="ATP" FareComponentFareTypeBitmap="0A" FareComponentFareType="EOU" FareComponentFareTariff="770" FareComponentFareRule="XX26" GovCarrier="AA">OVAJZNB3/DRB</FareBasisCode>
</FareBasisCodes>
Note: Elements "FareType", "ATPCO_FareTariff", "ATPCO_FareRule", "FareIndicator", "PrivateTariffIndicator", and "FareTypeBitmap" are rare. They are part of fare pricing. They should be sent if the carrier uses them also in ancillaries’ records (for example, if a carrier uses private/public fare indicator in the S7 rules).

Relase note ID: 12845


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

API Information

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

What's New

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

Business Value

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

New Features

In the Request

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:

<TPA_Extensions>
  <AdditionalFares>
    <AirItineraryPricingInfo>
      <PTC_FareBreakdowns>
        <PTC_FareBreakdown>
          <PassengerFare>
            <CreditCardFee Amount="10.00" CurrencyCode="EUR" DecimalPlaces="2"/>
            <BookingFee Amount="42.94" CurrencyCode="EUR" DecimalPlaces="2"/>
          </PassengerFare>
        </PTC_FareBreakdown>
      </PTC_FareBreakdowns>
    </AirItineraryPricingInfo>
  </AdditionalFares>
</TPA_Extensions>
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:

<PricedItinerary>
  <TPA_Extensions>
    <AdditionalFares>
      <AirItineraryPricingInfo>
        <ItinTotalFare>
          <CreditCardFee Amount="10.00" CurrencyCode="USD" DecimalPlaces="2"/>
          <BookingFee Amount="42.94" CurrencyCode="USD" DecimalPlaces="2"/>
        </ItinTotalFare>
      </AirItineraryPricingInfo>
    </AdditionalFares>
  </TPA_Extensions>
</PricedItinerary>
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:

<DepartedItineraries>
  <OneWayItineraries>
    <SimpleOneWayItineraries>
      <PricedItinerary>
        <TPA_Extensions>
          <AdditionalFares>
            <AirItineraryPricingInfo>
              <PTC_FareBreakdowns>
                <PTC_FareBreakdown>
                  <PassengerFare>
                    <CreditCardFee Amount="42.94" CurrencyCode="EUR" DecimalPlaces="2">										</CreditCardFee>
                  </PassengerFare>
                </PTC_FareBreakdown>
              </PTC_FareBreakdowns>
            </AirItineraryPricingInfo>
          </AdditionalFares>
        </TPA_Extensions>
      </PricedItinerary>
    </SimpleOneWayItineraries>
  </OneWayItineraries>
</DepartedItineraries>
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:

<DepartedItineraries>
  <OneWayItineraries>
    <SimpleOneWayItineraries>
      <PricedItinerary>
        <TPA_Extensions>
          <AdditionalFares>
            <AirItineraryPricingInfo>
              <ItinTotalFare>
                <CreditCardFee Amount="42.94" CurrencyCode="EUR" DecimalPlaces="2">								</CreditCardFee>
              </ItinTotalFare>
            </AirItineraryPricingInfo>
          </AdditionalFares>
        </TPA_Extensions>
      </PricedItinerary>
    </SimpleOneWayItineraries>
  </OneWayItineraries>
</DepartedItineraries>
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="A1D0">				</VCCInformation>
      </CommissionData>
    </TPA_Extensions>
  </ItinTotalFare>
</AirItineraryPricingInfo>
Note:

In the Response

Optional

Parameter: ArrivalCountry

Type: Arrival country code.

Description: CountryCodeType

Sample Value:

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

In the Response

Optional

Parameter: DepartureCountry

Type: CountryCodeType

Description: Departure country code.

Sample Value:

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

In the Response

Optional

Parameter: TotalFare

Type: TotalFareType

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

Sample Value:

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

In the Request

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.

Relase note ID: 12827


  • Revalidate Itinerary has been enhanced with the following new optional search parameters:
  • Shop by Fare Type Code – to support the capability for shopping to include/exclude a fare option based on Fare Type Code.
  • Shop by Brand ID Code – to support the capability for shopping to include/exclude a fare option based on Brand ID code.

API Information

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

What's New

  • Revalidate Itinerary has been enhanced with the following new optional search parameters:
  • Shop by Fare Type Code – to support the capability for shopping to include/exclude a fare option based on Fare Type Code.
  • Shop by Brand ID Code – to support the capability for shopping to include/exclude a fare option based on Brand ID code.

Business Value

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

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"/>
    <FareType Code="ERU" PreferLevel="Unacceptable"/>
  </TPA_Extensions>
</TravelPreferences>
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</DepartureDateTime>
  <OriginLocation LocationCode="DFW"/>
  <DestinationLocation LocationCode="KRK"/>
  <TPA_Extensions>
    <SegmentType Code="O"/>
    <FareType Code="EOU" PreferLevel="Preferred"/>
    <FareType Code="ERU" PreferLevel="Preferred"/>
  </TPA_Extensions>
</OriginDestinationInformation>
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"/>
        <Brand Code="A2" PreferLevel="Preferred"/>
      </BrandFilters>
    </BrandedFareIndicators>
  </TPA_Extensions>
</PriceRequestInformation>
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</DepartureDateTime>
  <OriginLocation LocationCode="DFW"/>
  <DestinationLocation LocationCode="KRK"/>
  <TPA_Extensions>
    <SegmentType Code="O"/>
    <BrandFilters>
      <Brand Code="A2" PreferLevel="Preferred"/>
      <Brand Code="A3" PreferLevel="Preferred"/>
    </BrandFilters>
  </TPA_Extensions>
</OriginDestinationInformation>
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).

Relase note ID: 12868


  • Revalidate Itinerary has been enhanced with the following new optional search parameters:
  • Revalidate Itinerary – To control the availability validation for a given itinerary.
  • Branded Fares Optimization – To control the brand parity logic preference (leg or itinerary parity, number of up-sells, allow brand-less legs and fallback modes).
  • Additionally, the following information will be returned in the Revalidate Itinerary response:
  • Forced Stopover Indicator – New indicator at the segment level to denote stopover point.
  • Revalidate Itinerary – Renamed element from "repriced" to "revalidated".

API Information

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

What's New

  • Revalidate Itinerary has been enhanced with the following new optional search parameters:
  • Revalidate Itinerary – To control the availability validation for a given itinerary.
  • Branded Fares Optimization – To control the brand parity logic preference (leg or itinerary parity, number of up-sells, allow brand-less legs and fallback modes).
  • Additionally, the following information will be returned in the Revalidate Itinerary response:
  • Forced Stopover Indicator – New indicator at the segment level to denote stopover point.
  • Revalidate Itinerary – Renamed element from "repriced" to "revalidated".

Business Value

  • Each of these new parameters power new ways to market, shop and convert lookers to bookers.

New Features

In the Request

Optional

Parameter: AlwaysCheckAvailability

Type: Boolean

Description: This parameter allows customers to control the availability validation for a given itinerary.

Sample Value:

<TravelPreferences>
  <VendorPref PreferLevel="Preferred" Code="EK"/>
  <TPA_Extensions>
    <VerificationItinCallLogic Value="M" AlwaysCheckAvailability="true"/>
  </TPA_Extensions>
</TravelPreferences>
Note: Applicable only to Revalidate Itinerary functionality.

In the Request

Optional

Parameter: UpsellLimit

Type: Integer

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

Sample Value:

<PriceRequestInformation>
  <AccountCode Code="BD001"/>
  <TPA_Extensions>
    <BrandedFareIndicators MultipleBrandedFares="true" SingleBrandedFare="true" ParityMode="Leg" UpsellLimit="2"/>
  </TPA_Extensions>
</PriceRequestInformation>
Note:

In the Request

Optional

Parameter: ItinParityBrandlessLeg

Type: Boolean

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

Sample Value:

<TPA_Extensions>
  <BrandedFareIndicators MultipleBrandedFares="true" ItinParityBrandlessLeg="true" ParityMode="Itin"/>
</TPA_Extensions>
Note:

In the Request

Optional

Parameter: ParityMode

Type: String

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

Sample Value:

<TPA_Extensions>
  <Priority>
    <Price Priority="2"/>
    <DirectFlights Priority="1"/>
    <Time Priority="3"/>
    <Vendor Priority="4"/>
  </Priority>
  <BrandedFareIndicators MultipleBrandedFares="true" SingleBrandedFare="true" ParityMode="Itin" ItinParityFallbackMode="LowestSingle"/>
</TPA_Extensions>
Note: ParityMode and ItinParityFallbackMode parameters are optional. When specifying the ParityMode=”Itin” at the request level without specifying the ItinParityFallbackMode, then the default fallback mode in the “BFM rule” level will be applied. Possible fallback modes: LowestSingle (no upsell options only lowest single possible branded solutions) or Leg (upsells generated using leg parity mode).

In the Request

Optional

Parameter: ItinParityFallbackMode

Type: String

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

Sample Value:

<TPA_Extensions>
  <Priority>
    <Price Priority="2"/>
    <DirectFlights Priority="1"/>
    <Time Priority="3"/>
    <Vendor Priority="4"/>
  </Priority>
  <BrandedFareIndicators MultipleBrandedFares="true" SingleBrandedFare="true" ParityMode="Itin" ItinParityFallbackMode="LowestSingle"/>
</TPA_Extensions>
Note: Possible FallBack modes to be used are: LowestSingle (no upsell options only lowest single possible branded solutions) or Leg (upsells generated using leg parity mode).

In the Response

Optional

Parameter: RequestedStopover Ind

Type: Boolean

Description: Indicator to identify which segment is the one departing from the stopover point in the Revalidate Itinerary response (within one leg).

Sample Value:

<FlightSegment DepartureDateTime="2018-08-12T16:50:00" ArrivalDateTime="2018-08-12T20:20:00" StopQuantity="0" FlightNumber="872" ResBookDesigCode="V" ElapsedTime="150">
  <DepartureAirport LocationCode="LHR" TerminalID="5"/>
  <ArrivalAirport LocationCode="KRK"/>
  <OperatingAirline Code="YY" FlightNumber="872"/>
  <Equipment AirEquipType="320"/>
  <MarketingAirline Code="YY"/>
  <MarriageGrp>O</MarriageGrp>
  <DepartureTimeZone GMTOffset="1"/>
  <ArrivalTimeZone GMTOffset="2"/>
  <TPA_Extensions>
    <eTicket Ind="true"/>
    <Mileage Amount="889"/>
    <RequestedStopover Ind="true"/>
  </TPA_Extensions>
</FlightSegment>
Note:

Functional Updates And Enhancements

In the Response

Optional

Parameter: Revalidated

Type: Boolean

Description: Indicator to identify the itinerary offer that was validated.

Sample Value:

<AirItineraryPricingInfo PricingSource="WPNI1_ITIN" PricingSubSource="MIP" Revalidated="true" FareReturned="true">
  <ItinTotalFare>
    <BaseFare Amount="9254.00" CurrencyCode="EUR" DecimalPlaces="2"/>
    <FareConstruction Amount="11364.48" CurrencyCode="NUC" DecimalPlaces="2"/>
    <EquivFare Amount="11070.00" CurrencyCode="USD" DecimalPlaces="2"/>
    <Taxes>
      <Tax TaxCode="TOTALTAX" Amount="1256.40" CurrencyCode="USD" DecimalPlaces="2"/>
    </Taxes>
    <TotalFare Amount="12326.40" CurrencyCode="USD" DecimalPlaces="2"/>
  </ItinTotalFare>
</AirItineraryPricingInfo>
Note: When the @Revalidated parameter is included with the ‘true’ value in the response this means the system revalidated the given itinerary with the specified flight schedule, RBD, date of travel and city-pair.

Relase note ID: 12927