AirShopping Fare Rules - British Airways 17.2 Implementation Overview

Technical Documentation

AirShopping Fare Rules

British Airways 17.2 Implementation Overview

Last Updated: 04 Mar 2021 09:49

Index

Background
Benefits
Which fare rules will be returned
What's the filter criteria for fare rules
How to request fare rules?
How are the fare rules returned in the response
XML Samples

Background

Previously, Fare Rules had only been returned in the APIs from OfferPrice and onwards. British Airways had many requests to return the most important fare rules in our AirShopping response. We have listened and have now released this functionality for you.

Key Benefits of our implementation

Fare Rules will enable you to highlight more differences between offers. It will improve your upsell opportunities
The British Airways solution enables you to filter offers by fare rule attributes
Fare Rules are returned in code-readable format
Fare Rules are optional. A seller will have to request them to be returned. We believe sellers should be able to tailor their response

Which fare rules will be returned

Voluntary Change
Voluntary Refund

What's the filter criteria for fare rules

We will return specific indicators that enable you to filter the offers based on fare rule attributes

ChangeFeeInd - Specifies if a changeable offer is subject to a change fee for voluntary changes
RefundableInd - Specifies if the offer is refundable
CancelFeeInd - Specifies if a refundable offer is subject to a cancellation fee
ApplicableFeeRemarks - The 17.2 IATA schema version has no designated element to specify if an offer is changeable or not. British Airways will provide this information here

Below an overview about the indicators for specific fare rule scenarios.

Fare Rule Scenario	Change Fee Indicator	Refundability Indicator	Cancel Fee Indicator	ApplicationFeeRemark	Amount
Change Allowed for a fee Refund not permitted	True	False	(not populated)	Refund not permitted	Value of penalty amount
Change Allowed without a fee Refund allowed without a fee	False	True	False	(not populated)	0
Change Allowed for a fee Refund allowed for a fee	True	True	True	(not populated)	Value of penalty amount
Change not permitted Refund Not permitted	(not populated)	False	(not populated)	Change not allowed Refund not permitted	0

How to request fare rules?

We have introduced a new Padis code "722" for this capability. British Airways will only return fare rules in the AirShopping response if a seller requests them with this code in the "FarePreferences" element in the AirShopping request.

XML Sample - How to request fare rules with Padis Code 722

<Preference>
        <FarePreferences>
          <Types>
            <Type>759</Type>
            <Type>722</Type>
          </Types>
        </FarePreferences>

How are the fare rules returned in the response

Our Fare Rules are returned by FareComponent in FareDetail. The flights included in each Fare Component are listed in SegmentRefs. Each Fare Component has an associated Change Rule and Cancel Rule, which are in in the penalty list

1: A reference to the fare rules in each offer item is returned under fare components.

XML Example - Reference to Fare Rules in Offer Item

 <FareComponent>
                                    <FareRules>
                                        <Penalty refs="Rule1 Rule3"/>
                                    </FareRules>
                                    <PriceClassRef>PCR_1</PriceClassRef>
                                    <SegmentRefs>BA2500</SegmentRefs>
                                </FareComponent>
                                <FareComponent>
                                    <FareRules>
                                        <Penalty refs="Rule2 Rule3"/>
                                    </FareRules>
                                    <PriceClassRef>PCR_1</PriceClassRef>
                                    <SegmentRefs>BA1465</SegmentRefs>
                                </FareComponent>

2: Fare Rules are listed in the Data List section under Penalty list

XML Sample - Voluntary Change Fare Rule in Penalty List

  <Penalty ChangeFeeInd="true" ObjectKey="Rule2" refs="BA0428 BA0430 BA0432 BA0434 BA0438 BA0440 BA0442 BA0444 BA8451 BA8455 BA8457 SH1">
            <Details>
              <Detail>
                <Type>CHANGE</Type>
                <Amounts>
                  <Amount>
                    <CurrencyAmountValue Code="GBP">100.00</CurrencyAmountValue>
                    <ApplicableFeeRemarks>
                      <Remark>Time/date changes permitted at any time before each flight departure for a change fee of 100.0GBP or an upgrade fee of 100.0GBP plus any difference in fare. All sectors may be repriced. Changes subject to availability. Fees apply per ticket</Remark>
                    </ApplicableFeeRemarks>
                  </Amount>
                </Amounts>
              </Detail>
            </Details>
          </Penalty>

Samples

XML samples can be found here

Limitations

Please note fare rules capability is fully available in the Production environment but only routes ex Spain and UAE in our Pre-Prod and Beta test environments