Get Structured Fare Rules

1.1.0
Air
Pricing
SOAP API
Travel Agency
Airline Carrier

v1.1.0 | October 15, 2022

  • Penalties per Fare Component - new capability to request and return penalties information per Fare Component in addition to penalties information for Journey Level.
  • No-Show penalty - new capability of returning No-Show penalty information.
  • Taxes Before and After Departure – new feature of returning refundability information of YQ and YR tax types under TAX element.
  • Update of Index on Journey Level – enhancement to match index of FareComponentID number in Journey Level and FareComponentNumber in FareComponentData.
Read more

API Information

Response Format
XML
Service Action Code
StructureFareRulesRQ
Current Version
1.1.0
Target Audience
TN
Environment
Production

What's New

  • Penalties per Fare Component - new capability to request and return penalties information per Fare Component in addition to penalties information for Journey Level.
  • No-Show penalty - new capability of returning No-Show penalty information.
  • Taxes Before and After Departure – new feature of returning refundability information of YQ and YR tax types under TAX element.
  • Update of Index on Journey Level – enhancement to match index of FareComponentID number in Journey Level and FareComponentNumber in FareComponentData.

Business Value

  • To provide flexibility and maximize productivity for customers, Sabre introduces new enhancements to the service, such as – capabilities of presenting Penalties per Fare Component, No-Show Penalties and Refundability Tax Information for tax types YQ and YR.

New Features

In the Request

Optional

Parameter: ReturnFareComponentPenalties

Type: boolean

Description: When used return Penalties also on Fare Component level.

Sample Value:

RQ:
<StructureFareRulesRQ xmlns="http://webservices.sabre.com/sabreXML/2003/07" Version="1.1.0">
  <PriceRequestInformation>
    <PassengerTypes>
      <PassengerType Code="ADT" Count="1"/>
    </PassengerTypes>
    <PrivateFare Ind="false"/>
    <ReturnFareComponentPenalties Ind="true"/>
  </PriceRequestInformation>
  <AirItinerary>
    <OriginDestinationOptions>
      <OriginDestinationOption>
            ...
      </OriginDestinationOption>
    </OriginDestinationOptions>
  </AirItinerary>
</StructureFareRulesRQ>

RS:
<StructureFareRulesRS xmlns="http://webservices.sabre.com/sabreXML/2003/07" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" Version="1.1.0">
    <Success/>
    <Summary>
        ...
        <PassengerDetails>
          ...
                <PenaltiesInfo>
               ...
                </PenaltiesInfo>
                <FareComponentDataList>
                    <FareComponentData FareComponentNumber="1" PricingUnitNumber="1">
                        <PenaltiesInfo>
                            <Penalty Type="Exchange" Applicability="Before" ConditionsApply="true" Changeable="true">
                                <NoShowPenalty Changeable="false"/>
                            </Penalty>
                            <Penalty Type="Exchange" Applicability="After" Changeable="true" Amount="173.00">
                                <NoShowPenalty Changeable="false"/>
                            </Penalty>
                            <Penalty Type="Refund" Applicability="Before" Refundable="false">
                                <NoShowPenalty Refundable="false"/>
                            </Penalty>
                            <Penalty Type="Refund" Applicability="After" Refundable="false">
                                <NoShowPenalty Refundable="false"/>
                            </Penalty>
                        </PenaltiesInfo>
                        <MinimumStayData MinimumStayDateTime="2022-10-23T00:00:00" MinimumStayLocation="ONT"/>
                        <MaximumStayData LastCommencementDateTime="2023-10-19T23:59:00" RestrictedLocation="ONT"/>
                    </FareComponentData>
                    <FareComponentData FareComponentNumber="2" PricingUnitNumber="1">
                        <PenaltiesInfo>
                            <Penalty Type="Exchange" Applicability="Before" ConditionsApply="true" Changeable="true" >
                                <NoShowPenalty Changeable="false"/>
                            </Penalty>
                            <Penalty Type="Exchange" Applicability="After" Changeable="false">
                                <NoShowPenalty Changeable="false"/>
                            </Penalty>
                            <Penalty Type="Refund" Applicability="Before" Refundable="false">
                                <NoShowPenalty Refundable="false"/>
                            </Penalty>
                            <Penalty Type="Refund" Applicability="After" Refundable="false">
                                <NoShowPenalty Refundable="false"/>
                            </Penalty>
                        </PenaltiesInfo>
                        <MinimumStayData MinimumStayDateTime="2022-10-23T00:00:00" MinimumStayLocation="ONT"/>
                        <MaximumStayData LastCommencementDateTime="2023-10-19T23:59:00" RestrictedLocation="ONT"/>
                    </FareComponentData>
                </FareComponentDataList>
                <PricingUnitDataList>
                  ...
                </PricingUnitDataList>
            </PassengerDetail>
        </PassengerDetails>
    </Summary>
</StructureFareRulesRS>
Note: <ReturnFareComponentPenalties Ind="true"/>

In the Response

Optional

Parameter: NoShowPenalty

Type: boolean

Description: NoShowPenalty node was added under PenaltiesInfo/Penalty. It informs if the no-show is chargeable or not.

Sample Value:

RS:
<StructureFareRulesRS xmlns="http://webservices.sabre.com/sabreXML/2003/07" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" Version="1.1.0">
    <Success/>
    <Summary>
         ...
        <PassengerDetails>
            ...
                <PenaltiesInfo>
                 ...
                </PenaltiesInfo>
                <FareComponentDataList>
                    <FareComponentData FareComponentNumber="1" PricingUnitNumber="1">
                        <PenaltiesInfo>
                            <Penalty Type="Exchange" Applicability="Before" ConditionsApply="true" Changeable="true">
                                <NoShowPenalty Changeable="false"/>
                            </Penalty>
                            <Penalty Type="Exchange" Applicability="After" Changeable="true" Amount="173.00">
                                <NoShowPenalty Changeable="false"/>
                            </Penalty>
                            <Penalty Type="Refund" Applicability="Before" Refundable="false">
                                <NoShowPenalty Refundable="false"/>
                            </Penalty>
                            <Penalty Type="Refund" Applicability="After" Refundable="false">
                                <NoShowPenalty Refundable="false"/>
                            </Penalty>
                        </PenaltiesInfo>
                        <MinimumStayData MinimumStayDateTime="2022-10-23T00:00:00" MinimumStayLocation="ONT"/>
                        <MaximumStayData LastCommencementDateTime="2023-10-19T23:59:00" RestrictedLocation="ONT"/>
                    </FareComponentData>
                    <FareComponentData FareComponentNumber="2" PricingUnitNumber="1">
                        <PenaltiesInfo>
                            <Penalty Type="Exchange" Applicability="Before" ConditionsApply="true" Changeable="true">
                                <NoShowPenalty Changeable="false"/>
                            </Penalty>
                            <Penalty Type="Exchange" Applicability="After" Changeable="false">
                                <NoShowPenalty Changeable="false"/>
                            </Penalty>
                            <Penalty Type="Refund" Applicability="Before" Refundable="false">
                                <NoShowPenalty Refundable="false"/>
                            </Penalty>
                            <Penalty Type="Refund" Applicability="After" Refundable="false">
                                <NoShowPenalty Refundable="false"/>
                            </Penalty>
                        </PenaltiesInfo>
                        <MinimumStayData MinimumStayDateTime="2022-10-23T00:00:00" MinimumStayLocation="ONT"/>
                        <MaximumStayData LastCommencementDateTime="2023-10-19T23:59:00" RestrictedLocation="ONT"/>
                    </FareComponentData>
                </FareComponentDataList>
                <PricingUnitDataList>
                  ...
                </PricingUnitDataList>
            </PassengerDetail>
        </PassengerDetails>
    </Summary>
</StructureFareRulesRS>
Note: <NoShowPenalty Changeable="false"/>

In the Response

Optional

Parameter: Tax

Type: boolean

Description: Taxes Before and After Departure – new feature for TAX element was implemented.

Sample Value:

RS:
<StructureFareRulesRS xmlns="http://webservices.sabre.com/sabreXML/2003/07" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" Version="1.1.0">
    <Success />
    <Summary>
     ...
        <PassengerDetails>
        ...
                <PenaltiesInfo>
                ...
                    <Taxes>
                        <Tax Applicability="Before" Code="YQI" Refundable="true" FeeApplicationInd="Sector" Amount="91.80"/>
                        <Tax Applicability="Before" Code="YQI" Refundable="true" FeeApplicationInd="Sector" Amount="91.80"/>
                        <Tax Applicability="After" Code="YQI" Refundable="true" FeeApplicationInd="Sector" Amount="91.80"/>
                        <Tax Applicability="After" Code="YQI" Refundable="true" FeeApplicationInd="Sector" Amount="91.80"/>
                    </Taxes>
                </PenaltiesInfo>
                ...
            </PassengerDetail>
        </PassengerDetails>
    </Summary>
</StructureFareRulesRS>
Note: <Tax Applicability="Before".../> <Tax Applicability="After" .../>

Functional Updates And Enhancements

In the Response

Optional

Parameter: FareComponentID

Type: integer

Description: Change of Index element on Journey Level (perviously was „0”) to start count from „1” same as on Fare Component Level.

Sample Value:

RS:
<StructureFareRulesRS xmlns="http://webservices.sabre.com/sabreXML/2003/07" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" Version="1.1.0">
    <Success/>
    <Summary>
        ...
        <PassengerDetails>
            ...
                <PenaltiesInfo>
                    <Penalty Type="Exchange" Applicability="Before" Cat16Info="true">
                        <NoShowPenalty Cat16Info="true">
                            <Cat16TextOnly FareBasisCode="YB" FareComponentID="1"/>
                        </NoShowPenalty>
                        <Cat16TextOnly FareBasisCode="YB" FareComponentID="1"/>
                    </Penalty>
                    ...
                </PenaltiesInfo>
                <FareComponentDataList>
                    <FareComponentData FareComponentNumber="1" PricingUnitNumber="1">
                        <PenaltiesInfo>
                            ...
                            </Penalty>
                        </PenaltiesInfo>
                    </FareComponentData>
                </FareComponentDataList>
                ...
            </PassengerDetail>
        </PassengerDetails>
    </Summary>
</StructureFareRulesRS>
Note: FareComponentID="1" FareComponentNumber="1"

Relase note ID: 17547

v1.0.5 | December 18, 2019

  • The Get Structured Fare has been enhanced to return additional information in the response as follows:
Read more

API Information

Response Format
XML
Service Action Code
StructureFareRulesRQ
Current Version
1.0.5
Target Audience
TN
Environment
Production

What's New

  • The Get Structured Fare has been enhanced to return additional information in the response as follows:

Business Value

  • The response has been extended with additional data about fare component in the penalty section and provides information on non-refundability.

New Features

In the Response

Optional

Parameter: FareComponent FareBasisCode

Type: FareBasisCodeType

Description: FareComponent at Penalty info level.

Sample Value:

<PenaltiesInfo>
  <Penalty Type="Exchange" Applicability="Before" ConditionsApply="true" Changeable="true" Amount="70.00" CurrencyCode="EUR">
    <FareComponent FareBasisCode="HOBAS" Changeable="false"/>
  </Penalty>
  <Penalty Type="Exchange" Applicability="After" ConditionsApply="true" Changeable="true" Amount="70.00" CurrencyCode="EUR">
    <FareComponent FareBasisCode="HOBAS" Changeable="false"/>
  </Penalty>
  <Penalty Type="Refund" Applicability="Before" Refundable="true" Amount="304.00" CurrencyCode="EUR"/>
  <Penalty Type="Refund" Applicability="After" Refundable="true" Amount="304.00" CurrencyCode="EUR"/>
</PenaltiesInfo>
Note: New section in PenaltiesInfo. Additional Penalty info at fare component level, refers to FareBasisCode and informs if it's Changeable or Refundable.

Relase note ID: 13673

v1.0.4 | March 27, 2018

  • The Get Structured Fare has been enhanced to enable more flexibility within the request and return additional information in the response as follows:
  • Agency Retailer – New optional attributes at the request level.
  • Force – Provides the ability to request fares matching specified retailer rules.
  • Code – Provides the ability to specify the specific rule retailer qualifier at the request level.
  • Agency Retailer – New optional attribute at the response level.
  • Code – Matched retailer rule code.
Read more

API Information

Response Format
XML
Service Action Code
StructureFareRulesRQ
Current Version
1.0.4
Target Audience
TN
Environment
Production

What's New

  • The Get Structured Fare has been enhanced to enable more flexibility within the request and return additional information in the response as follows:
  • Agency Retailer – New optional attributes at the request level.
  • Force – Provides the ability to request fares matching specified retailer rules.
  • Code – Provides the ability to specify the specific rule retailer qualifier at the request level.
  • Agency Retailer – New optional attribute at the response level.
  • Code – Matched retailer rule code.

Business Value

  • These enhancements drive greater transparency and give more flexibility for the customers using the Retailer Rules.

New Features

In the Request

Optional

Parameter: Force

Type: Boolean

Description: If set to true, only one Rule Retailer Qualifier can be used in the request. Only fares with a matched Business Rule containing the specified Retailer Rule Qualifier will be returned.

Sample Value:

 
Note:

In the Request

Optional

Parameter: Code

Type: RetailerRuleCodeType

Description: Specific Retailer Rule code.

Sample Value:

<StructureFareRulesRQ>
  <PriceRequestInformation>
    <RetailerRules Force="false">
      <RetailerRule Code="PQD"/>
      <RetailerRule Code="UTI1"/>
      <RetailerRule Code="YYY"/>
      <RetailerRule Code="ZZZ"/>
    </RetailerRules>
  </PriceRequestInformation>
</StructureFareRulesRQ>
Note: Up to four different Retailer Rules codes can be requested when RetailerRule Force is set to “false”. If RetailerRule Force is set to “true”, then only one Retailer Rule code can be specified in the request.

In the Response

Optional

Parameter: Code

Type: RetailerRuleCodeType

Description: New parameter with the code RC1 or RC2, which identifies the matched Retailer Rule code. The RC1 (Retailer Rule) is returned for all general transactions, and the RC2 code (Retailer Rule) is returned for the Adjusted Selling Level.

Sample Value:

<FareRetailerRule TransactionType="0" Code="RC1"/>
Note:

Relase note ID: 12908