Skip to main content

Basic Fare Shop

2.13.0
Air
Search
SOAP API
Travel Agency
  • Added ability to search by multiple PCCs.
  • Added ability to exclude specific country codes.

API Information

Response Format
XML
Service Action Code
BargainFinderPlusLLSRQ
Current Version
2.13.0
Target Audience
TN
Environment
Production

What's New

  • Added ability to search by multiple PCCs.
  • Added ability to exclude specific country codes.

Functional Updates And Enhancements

In the Request

Optional

Parameter: MultiPCC

Type: N/A

Description: Element allowing specifying multiple pseudo city codes.

Sample Value:

 
Note:

In the Request

Optional

Parameter: VendorPrefs

Type: N/A

Description: Allows including or excluding specific carriers for multiple pseudo city code search.

Sample Value:

<MultiPCC>
  <PseudoCity Code="7TZA">
    <VendorPrefs Exclude="true">
      <Airline Code="BA"/>
    </VendorPrefs>
  </PseudoCity>
  <PseudoCity Code="IH9A">
    <VendorPrefs Exclude="false">
      <Airline Code="AA"/>
    </VendorPrefs>
  </PseudoCity>
</MultiPCC>
Note:

In the Request

Optional

Parameter: CountryExclude

Type: N/A

Description: Element allowing exclusion of specific country codes from the search.

Sample Value:

 
Note:

In the Request

Optional

Parameter: DisableJumpCabinLogic

Type: boolean

Description: Attribute allowing disabling Jump Cabin logic for Multiple Fares per Itinerary search.

Sample Value:

 
Note:

In the Request

Optional

Parameter: Force

Type: boolean

Description: Attribute allowing forcing specific passenger type for Multiple Fares per Itinerary search.

Sample Value:

 
Note:

In the Request

Optional

Parameter: PassengerType

Type: N/A

Description: Element allowing specifying multiple passenger types for Multiple Fares per Itinerary search.

Sample Value:

 
Note: previously the element had zero repeat factor.

In the Request

Optional

Parameter: SpecificPenalty

Type: N/A

Description: Element allowing specifying differing penalty options for Multiple Fares per Itinerary search.

Sample Value:

 
Note:

In the Response

Optional

Parameter: AggregatedContent

Type: boolean

Description: Attribute passing information whether the shopping solution was sourced directly from the XML carriers

Sample Value:

 
Note:

In the Response

Optional

Parameter: PricingSubSource

Type: string

Description: Attribute passing information on the pricing Sub Source

Sample Value:

 
Note:

In the Response

Optional

Parameter: FulfillmentPseudoCityCode

Type: string

Description: Element passing details on the fulflillment pseudo city code.

Sample Value:

 
Note:

In the Response

Optional

Parameter: SolutionSequenceNmbr

Type: string

Description: Attribute passing number of the returned solution

Sample Value:

 
Note: Previously the attribute name was: MultiTicketSequenceNmbr

Relase note ID: 13040


  • Added a new attribute used to request the webservice to show all Agency Retailer Details
  • Added a new element that allows user to target an agency managed commission calculation from a specific business line
  • Added ability to exclude aggregated content from the services response
  • Enhanced services response to pass additional details related to validating carriers

API Information

Response Format
XML
Service Action Code
BargainFinderPlusLLSRQ
Current Version
2.12.0
Target Audience
TN
Environment
Production

What's New

  • Added a new attribute used to request the webservice to show all Agency Retailer Details
  • Added a new element that allows user to target an agency managed commission calculation from a specific business line
  • Added ability to exclude aggregated content from the services response
  • Enhanced services response to pass additional details related to validating carriers

New Features

In the Request

Optional

Parameter: HandlingFees

Type: boolean

Description: used to display the original base fare and GST (when applicable), along with new information displaying all handling fees (with applicable GST) in the shopping response

Sample Value:

<FareOptions ASLBreakdown="false" ASLIgnore="false" HandlingFees="false" Public="false" Private="false"/>
Note:

In the Request

Optional

Parameter: AggregatedContentExclude

Type: boolean

Description: used to exclude aggregated content

Sample Value:

 
Note:

In the Request

Optional

Parameter: CommissionContract

Type: string

Description: used to select specific contracts to process at a time of shopping

Sample Value:

<CommissionContract>WHOLESALERCONTRACT01</CommissionContract>
Note:

In the Response

Optional

Parameter: LayerTypeName

Type: string

Description: used to return selling fare data for each pax type

Sample Value:

 
Note:

In the Response

Optional

Parameter: Amount

Type: string

Description: used to return the applicable base fare amount for selling fare data

Sample Value:

<BaseFare Amount="100"/>
Note:

In the Response

Optional

Parameter: Amount

Type: string

Description: used to return the applicable constructed fare amount for selling fare data

Sample Value:

<ConstructedTotal Amount="100"/>
Note:

In the Response

Optional

Parameter: Amount

Type: string

Description: used to return the applicable equivalent fare amount for selling fare data

Sample Value:

<Equivalent Amount="100"/>
Note:

In the Response

Optional

Parameter: Amount

Type: string

Description: used to return the applicable total taxes amount for selling fare data

Sample Value:

<TotalTaxes Amount="10.23"/>
Note:

In the Response

Optional

Parameter: Amount

Type: string

Description: used to return the applicable total per passenger for selling fare data

Sample Value:

<TotalPerPassenger Amount="123.45"/>
Note:

In the Response

Optional

Parameter: Text

Type: string

Description: used to pass fare calculation for selling fare data

Sample Value:

<FareCalculation>
  <Text>FCXXX</Text>
</FareCalculation>
Note:

In the Response

Optional

Parameter: Code

Type: string

Description: used to pass tax code for selling fare tax data

Sample Value:

<Tax Code="US1" Description="FUEL TAX" Amount="10.5" CurrencyCode="USD" AmountPublished="5" PublishedCurrencyCode="USD" StationCode="DFW" CountryCode="US" GoodAndServicesInd="false"/>
Note:

In the Response

Optional

Parameter: Description

Type: string

Description: used to pass tax description for selling fare tax data

Sample Value:

<Tax Code="US1" Description="FUEL TAX" Amount="10.5" CurrencyCode="USD" AmountPublished="5" PublishedCurrencyCode="USD" StationCode="DFW" CountryCode="US" GoodAndServicesInd="false"/>
Note:

In the Response

Optional

Parameter: Amount

Type: string

Description: used to pass tax amount for selling fare tax data

Sample Value:

<Tax Code="US1" Description="FUEL TAX" Amount="10.5" CurrencyCode="USD" AmountPublished="5" PublishedCurrencyCode="USD" StationCode="DFW" CountryCode="US" GoodAndServicesInd="false"/>
Note:

In the Response

Optional

Parameter: CurrencyCode

Type: string

Description: used to pass tax currency code for selling fare tax data

Sample Value:

<Tax Code="US1" Description="FUEL TAX" Amount="10.5" CurrencyCode="USD" AmountPublished="5" PublishedCurrencyCode="USD" StationCode="DFW" CountryCode="US" GoodAndServicesInd="false"/>
Note:

In the Response

Optional

Parameter: AmountPublished

Type: string

Description: used to pass the published amount for selling fare tax data

Sample Value:

<Tax Code="US1" Description="FUEL TAX" Amount="10.5" CurrencyCode="USD" AmountPublished="5" PublishedCurrencyCode="USD" StationCode="DFW" CountryCode="US" GoodAndServicesInd="false"/>
Note:

In the Response

Optional

Parameter: PublishedCurrencyCode

Type: string

Description: used to pass published currency code for selling fare tax data

Sample Value:

<Tax Code="US1" Description="FUEL TAX" Amount="10.5" CurrencyCode="USD" AmountPublished="5" PublishedCurrencyCode="USD" StationCode="DFW" CountryCode="US" GoodAndServicesInd="false"/>
Note:

In the Response

Optional

Parameter: StationCode

Type: string

Description: used to pass station code for selling fare tax data

Sample Value:

<Tax Code="US1" Description="FUEL TAX" Amount="10.5" CurrencyCode="USD" AmountPublished="5" PublishedCurrencyCode="USD" StationCode="DFW" CountryCode="US" GoodAndServicesInd="false"/>
Note:

In the Response

Optional

Parameter: CountryCode

Type: string

Description: used to pass country code for selling fare tax data

Sample Value:

<Tax Code="US1" Description="FUEL TAX" Amount="10.5" CurrencyCode="USD" AmountPublished="5" PublishedCurrencyCode="USD" StationCode="DFW" CountryCode="US" GoodAndServicesInd="false"/>
Note:

In the Response

Optional

Parameter: GoodAndServicesInd

Type: boolean

Description: used to indicate that goods and services tax is present

Sample Value:

<Tax Code="US1" Description="FUEL TAX" Amount="10.5" CurrencyCode="USD" AmountPublished="5" PublishedCurrencyCode="USD" StationCode="DFW" CountryCode="US" GoodAndServicesInd="false"/>
Note:

In the Response

Optional

Parameter: Code

Type: string

Description: used to pass tax code for selling fare tax breakdown

Sample Value:

<TaxBreakDown Code="US1" Description="FUEL TAX" Amount="10.5" CurrencyCode="USD" AmountPublished="5" PublishedCurrencyCode="USD" StationCode="DFW" CountryCode="US" GoodAndServicesInd="true" AirlineCode="BA" TaxType="P"/>
Note:

In the Response

Optional

Parameter: Description

Type: string

Description: used to pass tax description for selling fare tax breakdown

Sample Value:

<TaxBreakDown Code="US1" Description="FUEL TAX" Amount="10.5" CurrencyCode="USD" AmountPublished="5" PublishedCurrencyCode="USD" StationCode="DFW" CountryCode="US" GoodAndServicesInd="true" AirlineCode="BA" TaxType="P"/>
Note:

In the Response

Optional

Parameter: Amount

Type: string

Description: used to pass tax amount for selling fare tax breakdown

Sample Value:

<TaxBreakDown Code="US1" Description="FUEL TAX" Amount="10.5" CurrencyCode="USD" AmountPublished="5" PublishedCurrencyCode="USD" StationCode="DFW" CountryCode="US" GoodAndServicesInd="true" AirlineCode="BA" TaxType="P"/>
Note:

In the Response

Optional

Parameter: CurrencyCode

Type: string

Description: used to pass currency code for selling fare tax breakdown

Sample Value:

<TaxBreakDown Code="US1" Description="FUEL TAX" Amount="10.5" CurrencyCode="USD" AmountPublished="5" PublishedCurrencyCode="USD" StationCode="DFW" CountryCode="US" GoodAndServicesInd="true" AirlineCode="BA" TaxType="P"/>
Note:

In the Response

Optional

Parameter: AmountPublished

Type: string

Description: used to pass the published amount for selling fare tax breakdown

Sample Value:

<TaxBreakDown Code="US1" Description="FUEL TAX" Amount="10.5" CurrencyCode="USD" AmountPublished="5" PublishedCurrencyCode="USD" StationCode="DFW" CountryCode="US" GoodAndServicesInd="true" AirlineCode="BA" TaxType="P"/>
Note:

In the Response

Optional

Parameter: PublishedCurrencyCode

Type: string

Description: used to pass published currency code for selling fare tax breakdown

Sample Value:

<TaxBreakDown Code="US1" Description="FUEL TAX" Amount="10.5" CurrencyCode="USD" AmountPublished="5" PublishedCurrencyCode="USD" StationCode="DFW" CountryCode="US" GoodAndServicesInd="true" AirlineCode="BA" TaxType="P"/>
Note:

In the Response

Optional

Parameter: StationCode

Type: string

Description: used to pass station code for selling fare tax breakdown

Sample Value:

<TaxBreakDown Code="US1" Description="FUEL TAX" Amount="10.5" CurrencyCode="USD" AmountPublished="5" PublishedCurrencyCode="USD" StationCode="DFW" CountryCode="US" GoodAndServicesInd="true" AirlineCode="BA" TaxType="P"/>
Note:

In the Response

Optional

Parameter: CountryCode

Type: string

Description: used to pass country code for selling fare tax breakdown

Sample Value:

<TaxBreakDown Code="US1" Description="FUEL TAX" Amount="10.5" CurrencyCode="USD" AmountPublished="5" PublishedCurrencyCode="USD" StationCode="DFW" CountryCode="US" GoodAndServicesInd="true" AirlineCode="BA" TaxType="P"/>
Note:

In the Response

Optional

Parameter: GoodAndServicesInd

Type: boolean

Description: used to indicate whether the goods and services tax is present

Sample Value:

<TaxBreakDown Code="US1" Description="FUEL TAX" Amount="10.5" CurrencyCode="USD" AmountPublished="5" PublishedCurrencyCode="USD" StationCode="DFW" CountryCode="US" GoodAndServicesInd="true" AirlineCode="BA" TaxType="P"/>
Note:

In the Response

Optional

Parameter: AirlineCode

Type: string

Description: used to pass the airline code for selling fare tax breakdown

Sample Value:

<TaxBreakDown Code="US1" Description="FUEL TAX" Amount="10.5" CurrencyCode="USD" AmountPublished="5" PublishedCurrencyCode="USD" StationCode="DFW" CountryCode="US" GoodAndServicesInd="true" AirlineCode="BA" TaxType="P"/>
Note:

In the Response

Optional

Parameter: TaxType

Type: string

Description: used to pass tax type for selling fare tax breakdown

Sample Value:

<TaxBreakDown Code="US1" Description="FUEL TAX" Amount="10.5" CurrencyCode="USD" AmountPublished="5" PublishedCurrencyCode="USD" StationCode="DFW" CountryCode="US" GoodAndServicesInd="true" AirlineCode="BA" TaxType="P"/>
Note:

In the Response

Optional

Parameter: Code

Type: string

Description: used to pass markup type code

Sample Value:

<Summary>
  <Markup Code="J" Description="ADJT" Amount="5.23"/>
</Summary>
Note:

In the Response

Optional

Parameter: Description

Type: string

Description: used to pass markup description

Sample Value:

<Summary>
  <Markup Code="J" Description="ADJT" Amount="5.23"/>
</Summary>
Note:

In the Response

Optional

Parameter: Amount

Type: string

Description: used to pass markup amount

Sample Value:

<Summary>
  <Markup Code="J" Description="ADJT" Amount="5.23"/>
</Summary>
Note:

In the Response

Optional

Parameter: NewValidatingProcess

Type: boolean

Description: used to indicate whether the validating carrier information is related to new process or not

Sample Value:

<ValidatingCarrier NewValidatingProcess="true">
  <SettlementMethod>BSP</SettlementMethod>
  <DefaultValidatingCarrier>CX</DefaultValidatingCarrier>
  <AlternateValidatingCarrier>BA</AlternateValidatingCarrier>
  <IETCheckedValidatingCarrier>AA</IETCheckedValidatingCarrier>
</ValidatingCarrier>
Note:

In the Response

Optional

Parameter: SettlementMethod

Type: string

Description: used to pass information on the settlement method type

Sample Value:

<ValidatingCarrier NewValidatingProcess="true">
  <SettlementMethod>BSP</SettlementMethod>
  <DefaultValidatingCarrier>CX</DefaultValidatingCarrier>
  <AlternateValidatingCarrier>BA</AlternateValidatingCarrier>
  <IETCheckedValidatingCarrier>AA</IETCheckedValidatingCarrier>
</ValidatingCarrier>
Note:

In the Response

Optional

Parameter: DefaultValidatingCarrier

Type: string

Description: used to pass information on the default validating carrier

Sample Value:

<ValidatingCarrier NewValidatingProcess="true">
  <SettlementMethod>BSP</SettlementMethod>
  <DefaultValidatingCarrier>CX</DefaultValidatingCarrier>
  <AlternateValidatingCarrier>BA</AlternateValidatingCarrier>
  <IETCheckedValidatingCarrier>AA</IETCheckedValidatingCarrier>
</ValidatingCarrier>
Note:

In the Response

Optional

Parameter: AlternateValidatingCarrier

Type: string

Description: used to pass information on the alternate validating carrier

Sample Value:

<ValidatingCarrier NewValidatingProcess="true">
  <SettlementMethod>BSP</SettlementMethod>
  <DefaultValidatingCarrier>CX</DefaultValidatingCarrier>
  <AlternateValidatingCarrier>BA</AlternateValidatingCarrier>
  <IETCheckedValidatingCarrier>AA</IETCheckedValidatingCarrier>
</ValidatingCarrier>
Note:

In the Response

Optional

Parameter: IETCheckedValidatingCarrier

Type: string

Description: used to pass information on the IETChecked validating carrie

Sample Value:

<ValidatingCarrier NewValidatingProcess="true">
  <SettlementMethod>BSP</SettlementMethod>
  <DefaultValidatingCarrier>CX</DefaultValidatingCarrier>
  <AlternateValidatingCarrier>BA</AlternateValidatingCarrier>
  <IETCheckedValidatingCarrier>AA</IETCheckedValidatingCarrier>
</ValidatingCarrier>
Note:

Relase note ID: 13002


  • Added ../PriceRequestInformation/OptionalQualifiers/PricingQualifiers/FlexibleFares/FareParameters/Account/@Force to the request message to force account code on group level for flexible fares.
  • Added .../PriceRequestInformation/OptionalQualifiers/PricingQualifiers/RetailerRuleQualifier@Qualifier within the request message to be able to shop by incorporating fares linked to a specific Retailer Rule Qualifier code.
  • Added .../PricedItineraries/PricedItinerary/AirItineraryPricingInfo/FareAdditionalInfo/RetailerRules together with corresponding elements/attributes (FareBreakComponentSequenceNmbr, DepartureAirportCode, ArrivalAirportCode, FareBasisCode, AdjustmentSellingLevel and PricingTransaction) to pass information on the retailer rules.

API Information

Response Format
XML
Service Action Code
BargainFinderPlusLLSRQ
Current Version
2.11.0
Target Audience
TN
Environment
Production

What's New

  • Added ../PriceRequestInformation/OptionalQualifiers/PricingQualifiers/FlexibleFares/FareParameters/Account/@Force to the request message to force account code on group level for flexible fares.
  • Added .../PriceRequestInformation/OptionalQualifiers/PricingQualifiers/RetailerRuleQualifier@Qualifier within the request message to be able to shop by incorporating fares linked to a specific Retailer Rule Qualifier code.
  • Added .../PricedItineraries/PricedItinerary/AirItineraryPricingInfo/FareAdditionalInfo/RetailerRules together with corresponding elements/attributes (FareBreakComponentSequenceNmbr, DepartureAirportCode, ArrivalAirportCode, FareBasisCode, AdjustmentSellingLevel and PricingTransaction) to pass information on the retailer rules.

New Features

In the Request

Optional

Parameter: Force

Type: boolean

Description: Used to force an account code on a group request level.

Sample Value:

 
Note:

In the Request

Optional

Parameter: Force

Type: boolean

Description: Used to force an corporate ID code on a group request level.

Sample Value:

 
Note:

In the Request

Optional

Parameter: RetailerRuleQualifier

Type: N/A

Description: Used to shop for an itinerary incorporating fares linked to a specific Retailer Rule Qualifier code.

Sample Value:

 
Note:

In the Request

Optional

Parameter: Force

Type: boolean

Description: Used to force only fares with a matched Business Rule containing the specified Retailer Rule Qualifier.

Sample Value:

 
Note:

In the Request

Optional

Parameter: Qualifier

Type: string

Description: Used to specify a RetailerRuleQualifier to shop with.

Sample Value:

 
Note:

In the Response

Optional

Parameter: FareAdditionalInfo

Type: N/A

Description: Used to pass additional info on the fare.

Sample Value:

 
Note:

In the Response

Optional

Parameter: FareBreakComponentSequenceNmbr

Type: integer

Description: Used to pass the Fare Break Component Number.

Sample Value:

 
Note:

In the Response

Optional

Parameter: DepartureAirportCode

Type: string

Description: Used to return related airport code related to the specific retailer rule.

Sample Value:

 
Note:

In the Response

Optional

Parameter: ArrivalAirportCode

Type: string

Description: Used to return related airport code related to the specific retailer rule.

Sample Value:

 
Note:

In the Response

Optional

Parameter: FareBasisCode

Type: string

Description: Used to return related fare basis code related to the specific retailer rule.

Sample Value:

 
Note:

In the Response

Optional

Parameter: AdjustmentSellingLevel

Type: string

Description: Used to return retailer rule for the Adjustment Selling Level.

Sample Value:

 
Note:

In the Response

Optional

Parameter: PricingTransaction

Type: string

Description: Used to return retailer rule for the pricing transactions.

Sample Value:

 
Note:

Relase note ID: 13062


  • Ability to specify before and after departure penalties
  • Ability to ignore fare focus fares
  • Ability to specify various long connection parameters

API Information

Response Format
XML
Service Action Code
BargainFinderPlusLLSRQ
Current Version
2.10.0
Target Audience
TN
Environment
Production

What's New

  • Ability to specify before and after departure penalties
  • Ability to ignore fare focus fares
  • Ability to specify various long connection parameters

New Features

In the Request

Optional

Parameter: BeforeDeparture

Type: boolean

Description: used to query before depature fees

Sample Value:

 
Note: Parameter used at .../Changeable, .../EitherOr and .../Refundable

In the Request

Optional

Parameter: AfterDeparture

Type: boolean

Description: used to query after depature fees

Sample Value:

<EitherOr Any="true" CurrencyCode="USD" MaxPenalty="100" AfterDeparture="true"/>
Note: Parameter used at .../Changeable, .../EitherOr and .../Refundable

In the Request

Optional

Parameter: FareFocusExclude

Type: boolean

Description: used to ignore fare focus fares

Sample Value:

 
Note:

In the Request

Optional

Parameter: ConnectionTimeOverride

Type: integer

Description: used to override maximum connection time

Sample Value:

<ConnectionTimeOverride Minimum="840" Maximum="1200"/>
Note:

In the Request

Optional

Parameter: ExcludeOvernightConnection

Type: integer

Description: used to define begin and end time windon within which the connection should not take place

Sample Value:

<ExcludeOvernightConnection Begin="22:00" End="05:00"/>
Note:

In the Request

Optional

Parameter: TotalTravelTime

Type: integer

Description: used to define maximum travel time

Sample Value:

<TotalTravelTime Minimum="200" Maximum="4000"/>
Note:

In the Response

Optional

Parameter: FareBasisCode

Type: string

Description: used to return the related fare basis code

Sample Value:

 
Note:

In the Response

Optional

Parameter: FareComponent

Type: string

Description: used to return the fare component number

Sample Value:

 
Note:

Functional Updates And Enhancements

In the Request

Optional

Parameter: LongConnectTime

Type: integer

Description: used to specify minimum and maximum number of minutes for Long Connections

Sample Value:

<LongConnectTime Minimum="840" Maximum="1200"/>
Note: previously this parameter was called ConnectionTime

Relase note ID: 13097