Shop Across Passenger Type

3.2.0
Air
Search
SOAP API
Travel Agency

v3.2.0 | June 15, 2017

  • Shop Across Passenger Type has been enhanced to enable more flexibility within the request and return options to provide additional information in the response as follows: • Additional response element for Validating Carrier without BSP check.
Read more

API Information

Response Format
XML
Service Action Code
BargainFinderMax_SAPTRQ
Current Version
3.2.0
Target Audience
TN
Environment
Production

What's New

  • Shop Across Passenger Type has been enhanced to enable more flexibility within the request and return options to provide additional information in the response as follows: • Additional response element for Validating Carrier without BSP check.

Relase note ID: 13049

v3.1.0 | March 30, 2017

  • Bargain Finder Max has been enhanced to enable more flexibility within the request and return additional information in the response as follows: • Baggage Enhancement – Allows you to specify in the request the number of bags returned in the response (up to 4 pieces). • VITA Enhancement – Allows you to choose the traditional Validating Carrier (VC) automatically in place of a lower priced VC. This is activated via travel journey record (TJR) with a new element in the response. • Expand Preferred Carrier – New optional parameters in the request: *To allow interline options to be returned when a preferred carrier is specified • Governing Carrier Override – Optional parameter that allows you to override the governing carrier via shopping request to get fares filed by a specified carrier. • Branded Fares Enhancement – New optional parameter in the response: *To indicate brand program code that is returned from the branding service *To indicate that a minimum of one of the legs included in the itinerary option contains a brand(s).
Read more

API Information

Response Format
XML
Service Action Code
BargainFinderMax_SAPTRQ
Current Version
3.1.0
Target Audience
TN
Environment
Production

What's New

  • Bargain Finder Max has been enhanced to enable more flexibility within the request and return additional information in the response as follows: • Baggage Enhancement – Allows you to specify in the request the number of bags returned in the response (up to 4 pieces). • VITA Enhancement – Allows you to choose the traditional Validating Carrier (VC) automatically in place of a lower priced VC. This is activated via travel journey record (TJR) with a new element in the response. • Expand Preferred Carrier – New optional parameters in the request: *To allow interline options to be returned when a preferred carrier is specified • Governing Carrier Override – Optional parameter that allows you to override the governing carrier via shopping request to get fares filed by a specified carrier. • Branded Fares Enhancement – New optional parameter in the response: *To indicate brand program code that is returned from the branding service *To indicate that a minimum of one of the legs included in the itinerary option contains a brand(s).

New Features

In the Response

Optional

Parameter: OtherTicketing

Type: Complex

Description: Other possible validating carrier information. Element introduced for VITA logic. In order to activate, customers will have to update their TJR.

Sample Value:

N/A
Note: This functionality is not activated via the request. It require a change to TJR settings.

In the Response

Optional

Parameter: Code

Type: CarrierCode

Description: Carrier code of another possible validating carrier. Re-price is required if this carrier must be used as the validating carrier at ticketing.

Sample Value:

<OTA_AirLowFareSearchRS>
  <PricedItineraries>
    <PricedItinerary>
      <AirItineraryPricingInfo>
        <TPA_Extensions>
          <ValidatingCarrier>
            <OtherTicketing Code="LH"/>
          </ValidatingCarrier>
        </TPA_Extensions>
      </AirItineraryPricingInfo>
    </PricedItinerary>
  </PricedItineraries>
</OTA_AirLowFareSearchRS>
Note:

In the Request

Optional

Parameter: VendorPrefApplicability

Type: VendorPrefApplicabilityType

Description: Indicates whether the provided carrier type preference should apply to at least one segment of the itinerary or to the entire itinerary. One instance is allowed per carrier type.

Sample Value:

N/A
Note: “VendorPrefApplicabilityType” refers to information within the “VendorPref” element.

In the Request

Required

Parameter: Value

Type: String

Description: Carrier selection method. Valid values are: • “AtLeastOneSegment” − The specified carrier should be returned for at least one segment in the itinerary. • “AllSegments” − The specified carrier should apply for the entire itinerary.

Sample Value:

<OTA_AirLowFareSearchRQ>
  <TravelPreferences>
    <VendorPref Code="LH" PreferLevel="Preferred" Type="Marketing"/>
    <VendorPrefApplicability Value="AtLeastOneSegment" Type="Marketing"/>
  </TravelPreferences>
</OTA_AirLowFareSearchRQ>
Note: This parameter is required within “VendorPrefApplicabilityType”. The value specified as “AllSegments” follows current logic for marketing vendor preference – will prefer/exclude online itineraries or a combination of specified carriers only.

In the Request

Required

Parameter: Type

Type: CarrierType

Description: Type of carrier it applies to. Valid values are: • “Marketing” • “Operating”

Sample Value:

<OTA_AirLowFareSearchRQ>
  <TravelPreferences>
    <VendorPref Code="LO" PreferLevel="Unacceptable" Type="Operating"/>
    <VendorPrefApplicability Value="AtLeastOneSegment" Type="Operating"/>
  </TravelPreferences>
</OTA_AirLowFareSearchRQ>
Note: This parameter is required within the “VendorPrefApplicabilityType”. In order to specify Vendor Preference Applicability for Operating carrier(s), the “Type” attribute must be set to “Operating” within the VendorPref element.

In the Request

Optional

Parameter: GoverningCarrierOverride

Type: GoverningCarrierOverrideType

Description: Parameter that allows you to override the governing carrier via shopping request to get fares filed by a specified carrier.

Sample Value:

N/A
Note: One carrier can be specified per request.

In the Request

Required

Parameter: AirlineCode

Type: CarrierCode

Description: Two-character airline code of the governing carrier.

Sample Value:

<OTA_AirLowFareSearchRQ>
  <TravelPreferences>
    <TPA_Extensions>
      <GoverningCarrierOverride AirlineCode="AB"/>
    </TPA_Extensions>
  </TravelPreferences>
</OTA_AirLowFareSearchRQ>
Note:

In the Response

Optional

Parameter: ProgramCode

Type: String

Description: Attribute for the brand program code that is returned from the branding service. This allows you to use this attribute returned in the shopping response in subsequent requests, for example, in a "GetMarketingText" request and correctly match brand programs.

Sample Value:

<OTA_AirLowFareSearchRS>
  <PricedItineraries>
    <PricedItinerary>
      <AirItineraryPricingInfo>
        <PTC_FareBreakdowns>
          <PTC_FareBreakdown>
            <PassengerFare>
              <TPA_Extensions>
                <FareComponents>
                  <FareComponent ProgramID="129987" ProgramCode="DOMBE" ProgramDescription="AABFDOMBE1S" ProgramSystemCode="H" BrandID="A2" BrandName="MAIN CABIN"/>
                </FareComponents>
              </TPA_Extensions>
            </PassengerFare>
          </PTC_FareBreakdown>
        </PTC_FareBreakdowns>
      </AirItineraryPricingInfo>
    </PricedItinerary>
  </PricedItineraries>
</OTA_AirLowFareSearchRS>
Note:

In the Response

Optional

Parameter: BrandsOnAnyMarket

Type: Boolean

Description: Attribute that allows you to indicate that a minimum of one of the legs included in the itinerary option contains a brand(s).

Sample Value:

<OTA_AirLowFareSearchRS>
  <PricedItineraries>
    <PricedItinerary>
      <AirItineraryPricingInfo PricingSource="ADVJR1" BrandsOnAnyMarket="true" PricingSubSource="MIP" FareReturned="true" LastTicketDate="2017-02-24"/>
    </PricedItinerary>
  </PricedItineraries>
</OTA_AirLowFareSearchRS>
Note: This parameter is required within “SingleBrandedFare” only. It indicates that the itinerary can have additional branded options, so you can request them with a subsequent AllBrandsPricingRQ transaction.

Relase note ID: 13025

v3.0.0 | December 15, 2016

  • Bargain FinderSM Max has been enhanced to enable more flexibility within the request and return additional information in the response as follows: • Schedule Filtering – new elements were added to the request schema: *Search by Airport or City codes – Allows you to specify for Origin/Destination if search should be proceed for city or airport code *Preferred Operating Carrier– Allows you to narrow the search by operating carrier (following the same logic as the current element for the marketing carrier). • Baggage Enhancement - Allows you to manage baggage information search at the request level. • Non BSP check - Allows you to select a validating carrier and override the local settlement validation method and Interline Electronic Ticketing (IET) validation.
Read more

API Information

Response Format
XML
Service Action Code
BargainFinderMax_SAPTRQ
Current Version
3.0.0
Target Audience
TN
Environment
Production

What's New

  • Bargain FinderSM Max has been enhanced to enable more flexibility within the request and return additional information in the response as follows: • Schedule Filtering – new elements were added to the request schema: *Search by Airport or City codes – Allows you to specify for Origin/Destination if search should be proceed for city or airport code *Preferred Operating Carrier– Allows you to narrow the search by operating carrier (following the same logic as the current element for the marketing carrier). • Baggage Enhancement - Allows you to manage baggage information search at the request level. • Non BSP check - Allows you to select a validating carrier and override the local settlement validation method and Interline Electronic Ticketing (IET) validation.

Business Value

  • Each of these enhancements enable greater personalization and efficiency to further refine the search. Results are more relevant options, which drives higher booking conversion.

New Features

In the Request

Optional

Parameter: LocationType

Type: String

Description: Parameter to narrow origin/destination search to specified airport or city. Valid values are: • “A” - Airport code • “C” - City code

Sample Value:

<OTA_AirLowFareSearchRQ>
  <OriginDestinationInformation>
    <OriginLocation>
      <OriginLocation LocationCode="OSL" LocationType="A"/>
    </OriginLocation>
  </OriginDestinationInformation>
</OTA_AirLowFareSearchRQ>
Note: If no “LocationType” is specified, the “LocationCode” will default to a city code (if city and airport codes are the same).

In the Request

Optional

Parameter: Type

Type: PreferLevelType

Description: “Type” parameter allows you to narrow the search by carrier type. Valid values are: • “Marketing” • “Operating”

Sample Value:

<OTA_AirLowFareSearchRQ>
  <TravelPreferences>
    <VendorPref Code="K0" PreferLevel="Preferred" Type="Operating"/>
  </TravelPreferences>
</OTA_AirLowFareSearchRQ>
Note: If no “Type” parameter is added, vendor preference defaults to the marketing carrier.

In the Request

Optional

Parameter: Baggage

Type: Complex

Description: Element to request baggage information.

Sample Value:

N/A
Note: If the “Baggage” element is added, the parameter “RequestType” is required. Current baggage information, allowance only, will be returned if the “Baggage” element is not added to the request.

In the Request

Required

Parameter: RequestType

Type: BaggageRequestType

Description: Baggage information request type. Valid values are: • “A” - Allowance only • “C” - Allowance and charges • “N” - No baggage information

Sample Value:

<OTA_AirLowFareSearchRQ>
  <TravelPreferences>
    <Baggage RequestType="A" Description="true"/>
  </TravelPreferences>
</OTA_AirLowFareSearchRQ>
Note: The “RequestType” parameter is required within the “Baggage” element.

In the Request

Optional

Parameter: Description

Type: Boolean

Description: The “Description” parameter allows you to request baggage text information. Valid values are: • “true” - To request text information. • “false” – Not to request text information.

Sample Value:

<OTA_AirLowFareSearchRQ>
  <TravelPreferences>
    <Baggage RequestType="A" Description="true"/>
  </TravelPreferences>
</OTA_AirLowFareSearchRQ>
Note: If “RequestType” is set to “N”, the “Description” parameter will be ignored. If no “Description” parameter is specified in the request, it is considered as “false”.

In the Response

Optional

Parameter: ProvisionType

Type: BaggageProvisionType

Description: “ProvisionType” indicates baggage information. Valid values are: • “A” - Checked Baggage Allowance. • “C” - Day of Check-in Charges.

Sample Value:

<OTA_AirLowFareSearchRS>
  <PricedItineraries>
    <PricedItinerary>
      <AirItineraryPricingInfo>
        <ItinTotalFare>
          <TPA_Extensions>
            <BaggageInformationList>
              <BaggageInformation ProvisionType="A" AirlineCode="K0">
                <Segment Id="0"/>
                <Segment Id="1"/>
                <Allowance Pieces="1" Description1="UP TO 50 POUNDS/23 KILOGRAMS" Description2="UP TO 62 LINEAR INCHES/158 LINEAR CENTIMETERS"/>
              </BaggageInformation>
            </BaggageInformationList>
          </TPA_Extensions>
        </ItinTotalFare>
      </AirItineraryPricingInfo>
    </PricedItinerary>
  </PricedItineraries>
</OTA_AirLowFareSearchRS>
Note:

In the Response

Optional

Parameter: AirlineCode

Type: AirlineCodeType

Description: “AirlineCode” indicates the carrier whose baggage provisions apply.

Sample Value:

<OTA_AirLowFareSearchRS>
  <PricedItineraries>
    <PricedItinerary>
      <AirItineraryPricingInfo>
        <ItinTotalFare>
          <TPA_Extensions>
            <BaggageInformationList>
              <BaggageInformation ProvisionType="A" AirlineCode="K0">
                <Segment Id="0"/>
                <Segment Id="1"/>
                <Allowance Pieces="1" Description1="UP TO 50 POUNDS/23 KILOGRAMS" Description2="UP TO 62 LINEAR INCHES/158 LINEAR CENTIMETERS"/>
              </BaggageInformation>
            </BaggageInformationList>
          </TPA_Extensions>
        </ItinTotalFare>
      </AirItineraryPricingInfo>
    </PricedItinerary>
  </PricedItineraries>
</OTA_AirLowFareSearchRS>
Note:

In the Response

Optional

Parameter: Description1

Type: String

Description: Baggage text information.

Sample Value:

<OTA_AirLowFareSearchRS>
  <PricedItineraries>
    <PricedItinerary>
      <AirItineraryPricingInfo>
        <ItinTotalFare>
          <TPA_Extensions>
            <BaggageInformationList>
              <BaggageInformation ProvisionType="A" AirlineCode="K0">
                <Segment Id="0"/>
                <Segment Id="1"/>
                <Allowance Pieces="1" Description1="UP TO 50 POUNDS/23 KILOGRAMS" Description2="UP TO 62 LINEAR INCHES/158 LINEAR CENTIMETERS"/>
              </BaggageInformation>
            </BaggageInformationList>
          </TPA_Extensions>
        </ItinTotalFare>
      </AirItineraryPricingInfo>
    </PricedItinerary>
  </PricedItineraries>
</OTA_AirLowFareSearchRS>
Note:

In the Response

Optional

Parameter: Description2

Type: String

Description: Baggage text information.

Sample Value:

<OTA_AirLowFareSearchRS>
  <PricedItineraries>
    <PricedItinerary>
      <AirItineraryPricingInfo>
        <ItinTotalFare>
          <TPA_Extensions>
            <BaggageInformationList>
              <BaggageInformation ProvisionType="A" AirlineCode="K0">
                <Segment Id="0"/>
                <Segment Id="1"/>
                <Allowance Pieces="1" Description1="UP TO 50 POUNDS/23 KILOGRAMS" Description2="UP TO 62 LINEAR INCHES/158 LINEAR CENTIMETERS"/>
              </BaggageInformation>
            </BaggageInformationList>
          </TPA_Extensions>
        </ItinTotalFare>
      </AirItineraryPricingInfo>
    </PricedItinerary>
  </PricedItineraries>
</OTA_AirLowFareSearchRS>
Note:

In the Response

Optional

Parameter: Charge

Type: Complex

Description: Charge information for the first two checked bags (if applicable).

Sample Value:

N/A
Note: If the “Charge” element is applicable, the “EquivalentAmount” and “EquivalentCurrency” parameters are required.

In the Response

Required

Parameter: EquivalentAmount

Type: MonetaryAmountType

Description: Equivalent amount for baggage charges.

Sample Value:

<OTA_AirLowFareSearchRS>
  <PricedItineraries>
    <PricedItinerary>
      <AirItineraryPricingInfo>
        <ItinTotalFare>
          <TPA_Extensions>
            <BaggageInformationList>
              <BaggageInformation ProvisionType="A" AirlineCode="K0">
                <Segment Id="0"/>
                <Segment Id="1"/>
                <Allowance Weight="30" Unit="kg"/>
              </BaggageInformation>
              <BaggageInformation ProvisionType="C" AirlineCode="K0">
                <Segment Id="0"/>
                <Segment Id="1"/>
                <Charge EquivalentAmount="25.00" EquivalentCurrency="USD" FirstPiece="1" LastPiece="1" Description1="UP TO 50 POUNDS/23 KILOGRAMS" Description2="UP TO 62 LINEAR INCHES/158 LINEAR CENTIMETERS"/>
              </BaggageInformation>
            </BaggageInformationList>
          </TPA_Extensions>
        </ItinTotalFare>
      </AirItineraryPricingInfo>
    </PricedItinerary>
  </PricedItineraries>
</OTA_AirLowFareSearchRS>
Note: “EquivalentAmount” is required within the “Charge” element.

In the Response

Required

Parameter: EquivalentCurrency

Type: CurrencyCodeType

Description: Equivalent currency for baggage charges.

Sample Value:

<OTA_AirLowFareSearchRS>
  <PricedItineraries>
    <PricedItinerary>
      <AirItineraryPricingInfo>
        <ItinTotalFare>
          <TPA_Extensions>
            <BaggageInformationList>
              <BaggageInformation ProvisionType="A" AirlineCode="K0">
                <Segment Id="0"/>
                <Segment Id="1"/>
                <Allowance Weight="30" Unit="kg"/>
              </BaggageInformation>
              <BaggageInformation ProvisionType="C" AirlineCode="K0">
                <Segment Id="0"/>
                <Segment Id="1"/>
                <Charge EquivalentAmount="25.00" EquivalentCurrency="USD" FirstPiece="1" LastPiece="1" Description1="UP TO 50 POUNDS/23 KILOGRAMS" Description2="UP TO 62 LINEAR INCHES/158 LINEAR CENTIMETERS"/>
              </BaggageInformation>
            </BaggageInformationList>
          </TPA_Extensions>
        </ItinTotalFare>
      </AirItineraryPricingInfo>
    </PricedItinerary>
  </PricedItineraries>
</OTA_AirLowFareSearchRS>
Note: “EquivalentCurrency” is required within the “Charge” element.

In the Response

Optional

Parameter: FirstPiece

Type: Byte

Description: Specify first baggage piece for which the specified charge information applies.

Sample Value:

<OTA_AirLowFareSearchRS>
  <PricedItineraries>
    <PricedItinerary>
      <AirItineraryPricingInfo>
        <ItinTotalFare>
          <TPA_Extensions>
            <BaggageInformationList>
              <BaggageInformation ProvisionType="A" AirlineCode="K0">
                <Segment Id="0"/>
                <Segment Id="1"/>
                <Allowance Weight="30" Unit="kg"/>
              </BaggageInformation>
              <BaggageInformation ProvisionType="C" AirlineCode="K0">
                <Segment Id="0"/>
                <Segment Id="1"/>
                <Charge EquivalentAmount="25.00" EquivalentCurrency="USD" FirstPiece="1" LastPiece="1" Description1="UP TO 50 POUNDS/23 KILOGRAMS" Description2="UP TO 62 LINEAR INCHES/158 LINEAR CENTIMETERS"/>
              </BaggageInformation>
            </BaggageInformationList>
          </TPA_Extensions>
        </ItinTotalFare>
      </AirItineraryPricingInfo>
    </PricedItinerary>
  </PricedItineraries>
</OTA_AirLowFareSearchRS>
Note: “FirstPiece” can be the same as “LastPiece” if the specified charge applies to one piece only.

In the Response

Optional

Parameter: LastPiece

Type: Byte

Description: Specify last baggage piece for which the specified charge information applies.

Sample Value:

<OTA_AirLowFareSearchRS>
  <PricedItineraries>
    <PricedItinerary>
      <AirItineraryPricingInfo>
        <ItinTotalFare>
          <TPA_Extensions>
            <BaggageInformationList>
              <BaggageInformation ProvisionType="A" AirlineCode="K0">
                <Segment Id="0"/>
                <Segment Id="1"/>
                <Allowance Weight="30" Unit="kg"/>
              </BaggageInformation>
              <BaggageInformation ProvisionType="C" AirlineCode="K0">
                <Segment Id="0"/>
                <Segment Id="1"/>
                <Charge EquivalentAmount="25.00" EquivalentCurrency="USD" FirstPiece="1" LastPiece="1" Description1="UP TO 50 POUNDS/23 KILOGRAMS" Description2="UP TO 62 LINEAR INCHES/158 LINEAR CENTIMETERS"/>
              </BaggageInformation>
            </BaggageInformationList>
          </TPA_Extensions>
        </ItinTotalFare>
      </AirItineraryPricingInfo>
    </PricedItinerary>
  </PricedItineraries>
</OTA_AirLowFareSearchRS>
Note: “LastPiece” can be the same as “FirstPiece” if the specified charge applies to one piece only.

In the Request

Optional

Parameter: ValidatingCarrierCheck

Type: Complex

Description: The ValidatingCarrierCheck element encompasses the elements allowing you to override the local settlement method validation and Interline Electronic Ticketing agreements.

Sample Value:

N/A
Note:

In the Request

Required

Parameter: SettlementValidation

Type: Boolean

Description: The “SettlementValidation” parameter allows you to override the local settlement plan check.

Sample Value:

<OTA_AirLowFareSearchRQ>
  <TravelPreferences>
    <TPA_Extensions>
      <ValidatingCarrierCheck>
        <SettlementValidation Ind="false"/>
        <IETValidation Ind="false"/>
        <Carrier Code="K0"/>
      </ValidatingCarrierCheck>
    </TPA_Extensions>
  </TravelPreferences>
</OTA_AirLowFareSearchRQ>
Note: When SettlementValidation/@Ind is set to false, it disables the settlement method validation in the local point of sale. When SettlementValidation/@Ind is set to true, it validates the settlement method in the local POS. If specified along with Carrier Code, the settlement validation will be disabled (if “false”) or proceed (if “true”) for the carriers specified in the request; if no Carrier Code is specified, the settlement validation will be disabled/proceed for all validating carriers. If a country code(s) is provided, the settlement validation will be triggered for the specified country/countries). The “SettlementValidation” element is required within the “ValidatingCarrierCheck” element.

In the Request

Required

Parameter: IETValidation

Type: Boolean

Description: IETValidation allows you to disable Electronic Ticketing agreements validation or specify in which points of sale and for which carriers Electronic Ticketing agreements should be checked.

Sample Value:

<OTA_AirLowFareSearchRQ>
  <TravelPreferences>
    <TPA_Extensions>
      <ValidatingCarrierCheck>
        <SettlementValidation Ind="false"/>
        <IETValidation Ind="true"/>
        <Carrier Code="K0"/>
        <Country Code="PL"/>
      </ValidatingCarrierCheck>
    </TPA_Extensions>
  </TravelPreferences>
</OTA_AirLowFareSearchRQ>
Note: When IETValidation/@Ind is set to “false,” it disables the Interline Electronic Ticketing agreements validation. When IETValidation/@Ind is set to “true,” at least one Country Code must be specified and will trigger IET validation performed in the specified countries. The “IETValidation” element is required within the “ValidatingCarrierCheck” element.

In the Request

Optional

Parameter: Code

Type: String

Description: Carrier/@Code parameter allows you to specify a carrier code(s) for which the specified settlement method and/or IET validation should (should not) be done.

Sample Value:

<OTA_AirLowFareSearchRQ>
  <TravelPreferences>
    <TPA_Extensions>
      <ValidatingCarrierCheck>
        <SettlementValidation Ind="false"/>
        <IETValidation Ind="true"/>
        <Carrier Code="K0"/>
        <Country Code="PL"/>
      </ValidatingCarrierCheck>
    </TPA_Extensions>
  </TravelPreferences>
</OTA_AirLowFareSearchRQ>
Note: If a carrier code is not added in the request, the settlement validation is enabled/disabled for all carriers.

In the Request

Required

Parameter: Country/@Code

Type: String

Description: Country/@Code parameter allows you to specify country code(s) for which IET and/or settlement validation should be performed. At least one country code must be provided if IETValidation/@Ind is set to “true”.

Sample Value:

<OTA_AirLowFareSearchRQ>
  <TravelPreferences>
    <TPA_Extensions>
      <ValidatingCarrierCheck>
        <SettlementValidation Ind="false"/>
        <IETValidation Ind="true"/>
        <Carrier Code="K0"/>
        <Country Code="PL"/>
      </ValidatingCarrierCheck>
    </TPA_Extensions>
  </TravelPreferences>
</OTA_AirLowFareSearchRQ>
Note: Country code is a valid parameter only if IET Validation is set to “true” in the request; otherwise, it is ignored. The format is a two-character country code as defined by ISO.

In the Response

Optional

Parameter: SettlementMethod

Type: String (Length 3 characters)

Description: The “SettlementMethod” parameter describes the settlement method verified for validating carrier(s).

Sample Value:

<OTA_AirLowFareSearchRS>
  <PricedItineraries>
    <PricedItinerary>
      <AirItineraryPricingInfo>
        <TPA_Extensions>
          <ValidatingCarrier SettlementMethod="NSP" NewVcxProcess="true">
            <Default Code="BR">
              <Country Code="NL"/>
              <Country Code="PL"/>
            </Default>
            <Alternate Code="LO">
              <Country Code="NL"/>
              <Country Code="PL"/>
            </Alternate>
          </ValidatingCarrier>
        </TPA_Extensions>
      </AirItineraryPricingInfo>
    </PricedItinerary>
  </PricedItineraries>
</OTA_AirLowFareSearchRS>
Note: If no settlement method is checked (SettlementValidation Ind="false" in request), NSP appears in the response.

In the Response

Optional

Parameter: NewVcxProcess

Type: Boolean

Description: “NewVcxProcess” indicates whether IET validation was requested (by IETValidation Ind set as “true" or “false” in the request).

Sample Value:

<OTA_AirLowFareSearchRS>
  <PricedItineraries>
    <PricedItinerary>
      <AirItineraryPricingInfo>
        <TPA_Extensions>
          <ValidatingCarrier SettlementMethod="NSP" NewVcxProcess="true">
            <Default Code="BR">
              <Country Code="NL"/>
              <Country Code="PL"/>
            </Default>
            <Alternate Code="LO">
              <Country Code="NL"/>
              <Country Code="PL"/>
            </Alternate>
          </ValidatingCarrier>
        </TPA_Extensions>
      </AirItineraryPricingInfo>
    </PricedItinerary>
  </PricedItineraries>
</OTA_AirLowFareSearchRS>
Note:

In the Response

Optional

Parameter: Default/@Code

Type: CarrierCode

Description: This parameter indicates the default carrier code for Settlement Method and IET validation check.

Sample Value:

<OTA_AirLowFareSearchRS>
  <PricedItineraries>
    <PricedItinerary>
      <AirItineraryPricingInfo>
        <TPA_Extensions>
          <ValidatingCarrier SettlementMethod="NSP" NewVcxProcess="true">
            <Default Code="BR">
              <Country Code="NL"/>
              <Country Code="PL"/>
            </Default>
            <Alternate Code="LO">
              <Country Code="NL"/>
              <Country Code="PL"/>
            </Alternate>
          </ValidatingCarrier>
        </TPA_Extensions>
      </AirItineraryPricingInfo>
    </PricedItinerary>
  </PricedItineraries>
</OTA_AirLowFareSearchRS>
Note:

In the Response

Optional

Parameter: Alternate/@Code

Type: CarrierCode

Description: This parameter indicates the alternate carrier code for Settlement Method and IET check.

Sample Value:

<OTA_AirLowFareSearchRS>
  <PricedItineraries>
    <PricedItinerary>
      <AirItineraryPricingInfo>
        <TPA_Extensions>
          <ValidatingCarrier SettlementMethod="NSP" NewVcxProcess="true">
            <Default Code="BR">
              <Country Code="NL"/>
              <Country Code="PL"/>
            </Default>
            <Alternate Code="LO">
              <Country Code="NL"/>
              <Country Code="PL"/>
            </Alternate>
          </ValidatingCarrier>
        </TPA_Extensions>
      </AirItineraryPricingInfo>
    </PricedItinerary>
  </PricedItineraries>
</OTA_AirLowFareSearchRS>
Note:

In the Response

Optional

Parameter: Country/@Code

Type: String

Description: Returns the country code in which IET validation was done for the default or alternate Validating Carrier. The format is a two-character country code as defined by ISO.

Sample Value:

<OTA_AirLowFareSearchRS>
  <PricedItineraries>
    <PricedItinerary>
      <AirItineraryPricingInfo>
        <TPA_Extensions>
          <ValidatingCarrier SettlementMethod="NSP" NewVcxProcess="true">
            <Default Code="BR">
              <Country Code="NL"/>
              <Country Code="PL"/>
            </Default>
            <Alternate Code="LO">
              <Country Code="NL"/>
              <Country Code="PL"/>
            </Alternate>
          </ValidatingCarrier>
        </TPA_Extensions>
      </AirItineraryPricingInfo>
    </PricedItinerary>
  </PricedItineraries>
</OTA_AirLowFareSearchRS>
Note: Above schema applies if no settlement method with IET validation checked in request: |-|SettlementValidation Ind="false"/|--| |-|IETValidation Ind="true"/|--|

In the Response

Optional

Parameter: Country

Type: String

Description: Country code for which settlement method and IET validation was checked (other than the original POS). Format is a two-character country code as defined by ISO.

Sample Value:

<OTA_AirLowFareSearchRS>
  <PricedItineraries>
    <PricedItinerary>
      <AirItineraryPricingInfo>
        <TPA_Extensions>
          <ValidatingCarrier SettlementMethod="BSP" NewVcxProcess="true">
            <Default Code="PS"/>
          </ValidatingCarrier>
          <ValidatingCarrier SettlementMethod="BSP" Country="PL" NewVcxProcess="true">
            <Default Code="PS"/>
          </ValidatingCarrier>
        </TPA_Extensions>
      </AirItineraryPricingInfo>
    </PricedItinerary>
  </PricedItineraries>
</OTA_AirLowFareSearchRS>
Note: This schema applies if settlement method with IET validation check was requested: |-|SettlementValidation Ind="true"/|--| |-|IETValidation Ind="true"/|--| |-|Country Code="PL"/|--|

Relase note ID: 13081

v1.9.7 | September 28, 2016

  • Bargain Finder Max service has been enhanced to enable more flexibility within the request and return additional information in the response as follows: • Agency Retailer – allows you to create selling levels for your authorized Category 35 negotiated fares or adjust the selling level of any fare in compliance with the agencies carrier agreements. - Applies to limited release customers only.
Read more

API Information

Response Format
XML
Service Action Code
BargainFinderMax_SAPTRQ
Current Version
1.9.7
Target Audience
TN
Environment
Production

What's New

  • Bargain Finder Max service has been enhanced to enable more flexibility within the request and return additional information in the response as follows: • Agency Retailer – allows you to create selling levels for your authorized Category 35 negotiated fares or adjust the selling level of any fare in compliance with the agencies carrier agreements. - Applies to limited release customers only.

New Features

In the Request

Optional

Parameter: SellingLevels

Type: Complex

Description: Element controlling Mark Up Any Fare functionality. When SellingLevels element is defined, one of its sub-elements must be provided, either SellingLevelRules or ShowFareAmounts.

Sample Value:

N/A
Note:

In the Request

Required

Parameter: SellingLevelRules/@Ignore

Type: Boolean

Description: If ignore set to “true,” adjustment SellingLevelRules will be ignored. To use this element, the ORGFQD EPR keyword is required.

Sample Value:

<OTA_AirLowFareSearchRQ>
  <TravelPreferences>
    <TPA_Extensions>
      <SellingLevels>
        <SellingLevelRules Ignore="true"/>
      </SellingLevels>
    </TPA_Extensions>
  </TravelPreferences>
</OTA_AirLowFareSearchRQ>
Note:

In the Request

Required

Parameter: ShowFareAmounts

Type: Complex

Description: The ShowFareAmounts element defines which FareLevel should be returned in the response. When the ShowFareAmounts element is defined, only one of its attributes can be defined, either Original or Adjusted. At least one is required.

Sample Value:

N/A
Note:

In the Request

Optional

Parameter: ShowFareAmounts/@Original

Type: Boolean

Description: When ShowFareAmounts/@Original is set to “true,” the original fare amount will be returned in the total fare amount, and additional MarkUp information will be returned in the SellingFareData element. To use this attribute, the ORGFQD EPR keyword is required.

Sample Value:

<OTA_AirLowFareSearchRQ>
  <TravelPreferences>
    <TPA_Extensions>
      <SellingLevels>
        <ShowFareAmounts Original="true"/>
      </SellingLevels>
    </TPA_Extensions>
  </TravelPreferences>
</OTA_AirLowFareSearchRQ>
Note:

In the Request

Optional

Parameter: ShowFareAmounts/@Adjusted

Type: Boolean

Description: When ShowFareAmounts/@Adjusted is set to “true,” the selling fare level amount and total adjusted fare amount will be returned. To use this attribute, the AGYRET EPR keyword is required.

Sample Value:

 
Note:

In the Request

Optional

Parameter: RetailerRules

Type: Complex

Description: Provides the capability to request fares matching the specified retailer rules.

Sample Value:

N/A
Note:

In the Request

Optional

Parameter: RetailerRules/@Force

Type: Boolean

Description: If RetailerRules/@Force is set to “true,” only fares with a matched Business Rule containing the specified Retailer Rule Qualifier will be returned.

Sample Value:

<OTA_AirLowFareSearchRQ>
  <TravelPreferences>
    <TPA_Extensions>
      <RetailerRules Force="true">
        <RetailerRule Code=" CAT35WOITBT"/>
      </RetailerRules>
    </TPA_Extensions>
  </TravelPreferences>
</OTA_AirLowFareSearchRQ>
Note:

In the Request

Required

Parameter: RetailerRule/@Code

Type: String (restriction: maximum length 20 characters)

Description: This attribute is used to provide the code(s) of retailer rules that should be matched by returned fares.

Sample Value:

<OTA_AirLowFareSearchRQ>
  <TravelPreferences>
    <TPA_Extensions>
      <RetailerRules Force="false">
        <RetailerRule Code=" CAT35WOITBT"/>
      </RetailerRules>
    </TPA_Extensions>
  </TravelPreferences>
</OTA_AirLowFareSearchRQ>
Note:

In the Response

Optional

Parameter: HandlingMarkupDetail

Type: Complex

Description: Provides information about handling markup details if applicable on the fare component level.

Sample Value:

N/A
Note:

In the Response

Optional

Parameter: HandlingMarkupDetail/@MarkupHandlingFeeAppID

Type: String

Description: HandlingMarkupDetail/@MarkupHandlingFeeAppID is a markup handling fee application ID.

Sample Value:

<OTA_AirLowFareSearchRS>
  <PricedItineraries>
    <PricedItinerary>
      <AirItineraryPricingInfo>
        <ItinTotalFare>
          <TPA_Extensions>
            <FareComponents>
              <FareComponent>
                <HandlingMarkupDetail MarkupHandlingFeeAppID="NT" MarkupTypeCode="J" FareAmountAfterMarkup="968.00" MarkupAmount="168.00" AmountCurrency="USD" MarkupRuleSourcePCC="A1D0" MarkupRuleItemNumber="7485"/>
              </FareComponent>
            </FareComponents>
          </TPA_Extensions>
        </ItinTotalFare>
      </AirItineraryPricingInfo>
    </PricedItinerary>
  </PricedItineraries>
</OTA_AirLowFareSearchRS>
Note:

In the Response

Optional

Parameter: HandlingMarkupDetail/@MarkupTypeCode

Type: String

Description:

Sample Value:

<OTA_AirLowFareSearchRS>
  <PricedItineraries>
    <PricedItinerary>
      <AirItineraryPricingInfo>
        <ItinTotalFare>
          <TPA_Extensions>
            <FareComponents>
              <FareComponent>
                <HandlingMarkupDetail MarkupHandlingFeeAppID="NT" MarkupTypeCode="J" FareAmountAfterMarkup="968.00" MarkupAmount="168.00" AmountCurrency="USD" MarkupRuleSourcePCC="A1D0" MarkupRuleItemNumber="7485"/>
              </FareComponent>
            </FareComponents>
          </TPA_Extensions>
        </ItinTotalFare>
      </AirItineraryPricingInfo>
    </PricedItinerary>
  </PricedItineraries>
</OTA_AirLowFareSearchRS>
Note:

In the Response

Optional

Parameter: HandlingMarkupDetail/@FareAmountAfterMarkup

Type: Decimal

Description: HandlingMarkupDetail/@FareAmountAfterMarkup is the fare amount after the applied markup.

Sample Value:

<OTA_AirLowFareSearchRS>
  <PricedItineraries>
    <PricedItinerary>
      <AirItineraryPricingInfo>
        <ItinTotalFare>
          <TPA_Extensions>
            <FareComponents>
              <FareComponent>
                <HandlingMarkupDetail MarkupHandlingFeeAppID="NT" MarkupTypeCode="J" FareAmountAfterMarkup="968.00" MarkupAmount="168.00" AmountCurrency="USD" MarkupRuleSourcePCC="A1D0" MarkupRuleItemNumber="7485"/>
              </FareComponent>
            </FareComponents>
          </TPA_Extensions>
        </ItinTotalFare>
      </AirItineraryPricingInfo>
    </PricedItinerary>
  </PricedItineraries>
</OTA_AirLowFareSearchRS>
Note:

In the Response

Optional

Parameter: HandlingMarkupDetail/@MarkupAmount

Type: Decimal

Description: HandlingMarkupDetail/@MarkupAmount is the amount of the applied markup.

Sample Value:

<OTA_AirLowFareSearchRS>
  <PricedItineraries>
    <PricedItinerary>
      <AirItineraryPricingInfo>
        <ItinTotalFare>
          <TPA_Extensions>
            <FareComponents>
              <FareComponent>
                <HandlingMarkupDetail MarkupHandlingFeeAppID="NT" MarkupTypeCode="J" FareAmountAfterMarkup="968.00" MarkupAmount="168.00" AmountCurrency="USD" MarkupRuleSourcePCC="A1D0" MarkupRuleItemNumber="7485"/>
              </FareComponent>
            </FareComponents>
          </TPA_Extensions>
        </ItinTotalFare>
      </AirItineraryPricingInfo>
    </PricedItinerary>
  </PricedItineraries>
</OTA_AirLowFareSearchRS>
Note:

In the Response

Optional

Parameter: HandlingMarkupDetail/@AmountCurrency

Type: String

Description: HandlingMarkupDetail/@AmountCurrency is the currency of a given markup amount.

Sample Value:

<OTA_AirLowFareSearchRS>
  <PricedItineraries>
    <PricedItinerary>
      <AirItineraryPricingInfo>
        <ItinTotalFare>
          <TPA_Extensions>
            <FareComponents>
              <FareComponent>
                <HandlingMarkupDetail MarkupHandlingFeeAppID="NT" MarkupTypeCode="J" FareAmountAfterMarkup="968.00" MarkupAmount="168.00" AmountCurrency="USD" MarkupRuleSourcePCC="A1D0" MarkupRuleItemNumber="7485"/>
              </FareComponent>
            </FareComponents>
          </TPA_Extensions>
        </ItinTotalFare>
      </AirItineraryPricingInfo>
    </PricedItinerary>
  </PricedItineraries>
</OTA_AirLowFareSearchRS>
Note:

In the Response

Optional

Parameter: HandlingMarkupDetail/@MarkupRuleSourcePCC

Type: String (restriction: minimum three maximum four characters)

Description: HandlingMarkupDetail/@MarkupRuleSourcePCC is code of PCC who crated given markup rule.

Sample Value:

<OTA_AirLowFareSearchRS>
  <PricedItineraries>
    <PricedItinerary>
      <AirItineraryPricingInfo>
        <ItinTotalFare>
          <TPA_Extensions>
            <FareComponents>
              <FareComponent>
                <HandlingMarkupDetail MarkupHandlingFeeAppID="NT" MarkupTypeCode="J" FareAmountAfterMarkup="968.00" MarkupAmount="168.00" AmountCurrency="USD" MarkupRuleSourcePCC="A1D0" MarkupRuleItemNumber="7485"/>
              </FareComponent>
            </FareComponents>
          </TPA_Extensions>
        </ItinTotalFare>
      </AirItineraryPricingInfo>
    </PricedItinerary>
  </PricedItineraries>
</OTA_AirLowFareSearchRS>
Note:

In the Response

Optional

Parameter: HandlingMarkupDetail/@MarkupRuleItemNumber

Type: Unsigned Long

Description: HandlingMarkupDetail/@MarkupRuleItemNumber is a number identifying a markup rule item.

Sample Value:

<OTA_AirLowFareSearchRS>
  <PricedItineraries>
    <PricedItinerary>
      <AirItineraryPricingInfo>
        <ItinTotalFare>
          <TPA_Extensions>
            <FareComponents>
              <FareComponent>
                <HandlingMarkupDetail MarkupHandlingFeeAppID="NT" MarkupTypeCode="J" FareAmountAfterMarkup="968.00" MarkupAmount="168.00" AmountCurrency="USD" MarkupRuleSourcePCC="A1D0" MarkupRuleItemNumber="7485"/>
              </FareComponent>
            </FareComponents>
          </TPA_Extensions>
        </ItinTotalFare>
      </AirItineraryPricingInfo>
    </PricedItinerary>
  </PricedItineraries>
</OTA_AirLowFareSearchRS>
Note:

In the Response

Optional

Parameter: SellingFareDataList

Type: Complex

Description: Agency retailer MarkUp information if applicable.

Sample Value:

N/A
Note:

In the Response

Required

Parameter: SellingFareData/@LayerTypeName

Type: String

Description: Indicates that the returned fare level is the adjusted selling fare, meaning that the agency retailer markup was applied

Sample Value:

<OTA_AirLowFareSearchRS>
  <PricedItineraries>
    <PricedItinerary>
      <AirItineraryPricingInfo>
        <PTC_FareBreakdowns>
          <PTC_FareBreakdown>
            <PassengerFare>
              <TPA_Extensions>
                <SellingFareDataList>
                  <SellingFareData LayerTypeName="ADS"/>
                </SellingFareDataList>
              </TPA_Extensions>
            </PassengerFare>
          </PTC_FareBreakdown>
        </PTC_FareBreakdowns>
      </AirItineraryPricingInfo>
    </PricedItinerary>
  </PricedItineraries>
</OTA_AirLowFareSearchRS>
Note:

In the Response

Optional

Parameter: HandlingMarkupSummary

Type: Complex

Description: This is a summary information about the Agency Retailer MarkUp amount, markUp type, and MarkUp description.

Sample Value:

N/A
Note:

In the Response

Required

Parameter: HandlingMarkupSummary/@TypeCode

Type: String (restricted to one character)

Description: HandlingMarkupSummary/@TypeCode defines the Agency Retailer markup type. Valid values are: • M − Embedded Mark Up • J − Adjusted Selling • H − Handling Fee • G − GST Taxes

Sample Value:

<OTA_AirLowFareSearchRS>
  <PricedItineraries>
    <PricedItinerary>
      <AirItineraryPricingInfo>
        <PTC_FareBreakdowns>
          <PTC_FareBreakdown>
            <PassengerFare>
              <TPA_Extensions>
                <SellingFareDataList>
                  <SellingFareData LayerTypeName="ADS"/>
                  <HandlingMarkupSummary TypeCode="J" Description="ADJT AMT" MonetaryAmountValue="12.00"/>
                </SellingFareDataList>
              </TPA_Extensions>
            </PassengerFare>
          </PTC_FareBreakdown>
        </PTC_FareBreakdowns>
      </AirItineraryPricingInfo>
    </PricedItinerary>
  </PricedItineraries>
</OTA_AirLowFareSearchRS>
Note:

In the Response

Required

Parameter: HandlingMarkupSummary/@Description

Type: String (restriction: maximum 10 characters)

Description: HandlingMarkupSummary/@Description is a description of the selling fare data.

Sample Value:

<OTA_AirLowFareSearchRS>
  <PricedItineraries>
    <PricedItinerary>
      <AirItineraryPricingInfo>
        <PTC_FareBreakdowns>
          <PTC_FareBreakdown>
            <PassengerFare>
              <TPA_Extensions>
                <SellingFareDataList>
                  <SellingFareData LayerTypeName="ADS"/>
                  <HandlingMarkupSummary TypeCode="J" Description="ADJT AMT" MonetaryAmountValue="12.00"/>
                </SellingFareDataList>
              </TPA_Extensions>
            </PassengerFare>
          </PTC_FareBreakdown>
        </PTC_FareBreakdowns>
      </AirItineraryPricingInfo>
    </PricedItinerary>
  </PricedItineraries>
</OTA_AirLowFareSearchRS>
Note:

In the Response

Required

Parameter: HandlingMarkupSummary/@MonetaryAmountValue

Type: Decimal (up to three fractional digits)

Description: HandlingMarkupSummary/@MonetaryAmountValue is the Agency Retailer markup amount in the equivalent currency.

Sample Value:

<OTA_AirLowFareSearchRS>
  <PricedItineraries>
    <PricedItinerary>
      <AirItineraryPricingInfo>
        <PTC_FareBreakdowns>
          <PTC_FareBreakdown>
            <PassengerFare>
              <TPA_Extensions>
                <SellingFareDataList>
                  <SellingFareData LayerTypeName="ADS"/>
                  <HandlingMarkupSummary TypeCode="J" Description="ADJT AMT" MonetaryAmountValue="12.00"/>
                </SellingFareDataList>
              </TPA_Extensions>
            </PassengerFare>
          </PTC_FareBreakdown>
        </PTC_FareBreakdowns>
      </AirItineraryPricingInfo>
    </PricedItinerary>
  </PricedItineraries>
</OTA_AirLowFareSearchRS>
Note:

In the Response

Optional

Parameter: FareRetailerRule

Type: Complex

Description: Matched general retailer rule code or adjusted selling level retailer rule code.

Sample Value:

N/A
Note:

In the Response

Required

Parameter: FareRetailerRule/@TransactionType

Type: String

Description: FareRetailerRule/@TransactionType specifies the general or adjusted selling level.

Sample Value:

<OTA_AirLowFareSearchRS>
  <PricedItineraries>
    <PricedItinerary>
      <AirItineraryPricingInfo>
        <PTC_FareBreakdowns>
          <PTC_FareBreakdown>
            <PassengerFare>
              <TPA_Extensions>
                <FareComponents>
                  <FareComponent>
                    <FareRetailerRule TransactionType="AdjustedSellingLevel" Code="MBRKERRQ"/>
                  </FareComponent>
                </FareComponents>
              </TPA_Extensions>
            </PassengerFare>
          </PTC_FareBreakdown>
        </PTC_FareBreakdowns>
      </AirItineraryPricingInfo>
    </PricedItinerary>
  </PricedItineraries>
</OTA_AirLowFareSearchRS>
Note:

In the Response

Required

Parameter: FareRetailerRule/@Code

Type: String

Description: FareRetailerRule/@Code returns the matched Agency Retailer rule code.

Sample Value:

<OTA_AirLowFareSearchRS>
  <PricedItineraries>
    <PricedItinerary>
      <AirItineraryPricingInfo>
        <PTC_FareBreakdowns>
          <PTC_FareBreakdown>
            <PassengerFare>
              <TPA_Extensions>
                <FareComponents>
                  <FareComponent>
                    <FareRetailerRule TransactionType="AdjustedSellingLevel" Code="MBRKERRQ"/>
                  </FareComponent>
                </FareComponents>
              </TPA_Extensions>
            </PassengerFare>
          </PTC_FareBreakdown>
        </PTC_FareBreakdowns>
      </AirItineraryPricingInfo>
    </PricedItinerary>
  </PricedItineraries>
</OTA_AirLowFareSearchRS>
Note:

Relase note ID: 13113