Get Ancillary Offers (Airlines)

 

The GetAncillaryOffersRQ (v3) service retrieves ancillary offers per individual passenger as follows:

  • Catalog of ancillaries (F - flight related/all groups) based on marketing/operating carrier.
  • Disclosure information as structured data (service types: A - free baggage allowance, B - carry-on allowance, C - baggage charges, E - baggage embargoes). Baggage information for A - free baggage allowance and C - baggage charges are retrieved based on the most significant carrier. Baggage information for B - carry-on allowance and E - baggage embargoes is based on the operating carrier.
  • Baggage entitlements for piece allowance system returned always as override rule indicating the effective allowance. Override baggage entitlements rules will always override OC pricing allowance filled by carriers as 0DF - Free Baggage Allowance, but only for standard baggage
  • For stateless type of requests with PNR provided, a list of prepaid baggage is provided

API Information

Target Audience
All Sabre APIs Customers
Current Version
3.0.0
Authentication
Session Token
Service Action Code
GetAncillaryOffersRQ

Sample Request

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:eb="http://www.ebxml.org/namespaces/messageHeader" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xsd="http://www.w3.org/1999/XMLSchema">
    <SOAP-ENV:Header>
        <eb:MessageHeader SOAP-ENV:mustUnderstand="1" eb:version="1.0">
            <eb:ConversationId>ABC123@clientURL.com</eb:ConversationId>
            <eb:From>
                <eb:PartyId type="urn:x12.org:IO5:01">99999</eb:PartyId>
            </eb:From>
            <eb:To>
                <eb:PartyId type="urn:x12.org:IO5:01">123123</eb:PartyId>
            </eb:To>
            <eb:CPAId>AZ</eb:CPAId>
            <eb:Service/>
            <eb:Action>GetAncillaryOffersRQ</eb:Action>
            <eb:MessageData>
                <eb:MessageId>mid:20001209-133003-2333@clientofsabre.com</eb:MessageId>
                <eb:Timestamp>2001-02-15T11:15:12Z</eb:Timestamp>
                <eb:TimeToLive>2001-02-15T11:15:12Z</eb:TimeToLive>
            </eb:MessageData>
        </eb:MessageHeader>
        <wsse:Security xmlns:wsse="http://schemas.xmlsoap.org/ws/2002/12/secext">
            <wsse:BinarySecurityToken valueType="String" EncodingType="wsse:Base64Binary">${#TestSuite#token}</wsse:BinarySecurityToken>
        </wsse:Security>
    </SOAP-ENV:Header>
    <SOAP-ENV:Body>
        <ns9:GetAncillaryOffersRQ version="3.0.0" xmlns:ns2="http://www.ebxml.org/namespaces/messageHeader" xmlns:ns1="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns4="http://www.w3.org/2000/09/xmldsig#" xmlns:ns3="http://www.w3.org/1999/xlink" xmlns:ns6="http://schemas.xmlsoap.org/ws/2002/12/secext" xmlns:ns8="http://services.sabre.com/STL_Payload/v02_01" xmlns:ns7="urn:schemas-sabre-com:soap-header-debug" xmlns:ns13="http://services.sabre.com/merch/passenger/v03" xmlns:ns9="http://services.sabre.com/merch/ancillary/offer/v03" xmlns:ns12="http://services.sabre.com/merch/request/v03" xmlns:ns11="http://services.sabre.com/merch/common/v03" xmlns:ns10="http://services.sabre.com/merch/ancillary/v03" xmlns:ns17="http://stl.sabre.com/Merchandising/diagnostics/v2" xmlns:ns16="http://services.sabre.com/merch/flight/v03" xmlns:ns15="http://services.sabre.com/merch/ticket/v03" xmlns:ns14="http://services.sabre.com/merch/itinerary/v03">
            <ns9:RequestType>payload</ns9:RequestType>
            <!--Mandatory-->
            <!--Repeat Factor 1-1-->
            <!--Request Type: payload-->
            <ns9:RequestMode>booking</ns9:RequestMode>
            <!--Mandatory-->
            <!--Repeat Factor 1-1-->
            <!--Request Mode: booking-->
            <ns9:QueryByItinerary>
                <!--Mandatory-->
                <!--Repeat Factor 1-1-->
                <!--Mandatory for payload request type.-->
                <ns9:QueryPassengerItinerary>
                    <!--Optional-->
                    <!--Repeat Factor 0-99-->
                    <!--Passenger reference to itinerary, segment, ticket.-->
                    <ns9:Passenger id="p_01.01" nameReferenceNumber="01.01"/>
                    <!--Mandatory-->
                    <!--Repeat Factor 1-1-->
                    <!--Passenger details need to be provided. Id is required element for payload request type.-->
                    <ns9:PassengerItinerary ticketReferenceNumber="${#TestSuite#ticket1}">
                        <!--Mandatory-->
                        <!--Repeat Factor 1-99-->
                        <!--Information about ticket number required for post ticketed path.-->
                        <ns9:PassengerSegment segmentRef="seg_1"/>
                        <!--Mandatory-->
                        <!--Repeat Factor 1-99-->
                        <!--List of segments identified by segment id.-->
                    </ns9:PassengerItinerary>
                </ns9:QueryPassengerItinerary>
                <ns9:Segment id="seg_1">
                    <!--Mandatory-->
                    <!--Repeat Factor 1-99-->
                    <!--List of segments identified by segment id.-->
                    <ns14:FlightDetail id="flight_1">
                        <!--Mandatory-->
                        <!--Repeat Factor 1-1-->
                        <!--Flight details.-->
                        <ns16:Airline>AZ</ns16:Airline>
                        <!--Mandatory-->
                        <!--Repeat Factor 1-1-->
                        <!--Marketing airline code.-->
                        <ns16:FlightNumber>852</ns16:FlightNumber>
                        <!--Mandatory-->
                        <!--Repeat Factor 1-1-->
                        <!--Flight details.-->
                        <ns16:DepartureAirport>FCO</ns16:DepartureAirport>
                        <!--Mandatory-->
                        <!--Repeat Factor 1-1-->
                        <!--Departure airport.-->
                        <ns16:DepartureDate>2018-05-20</ns16:DepartureDate>
                        <!--Optional-->
                        <!--Repeat Factor 0-1-->
                        <!--Departure date.-->
                        <ns16:DepartureTime>11:15:00</ns16:DepartureTime>
                        <!--Optional-->
                        <!--Repeat Factor 0-1-->
                        <!--Departure time.-->
                        <ns16:ArrivalAirport>AUH</ns16:ArrivalAirport>
                        <!--Mandatory-->
                        <!--Repeat Factor 1-1-->
                        <!--Arrival airport.-->
                        <ns16:OperatingAirline>AZ</ns16:OperatingAirline>
                        <!--Optional-->
                        <!--Repeat Factor 0-1-->
                        <!--Flight number of the operating airline (may differ than the marketing airline).-->
                        <ns16:OperatingFlightNumber>852</ns16:OperatingFlightNumber>
                        <!--Optional-->
                        <!--Repeat Factor 0-1-->
                        <!--Flight number of the operating airline (it might be different then the marketing airline).-->
                        <ns16:ClassOfService>Y</ns16:ClassOfService>
                        <!--Optional-->
                        <!--Repeat Factor 0-1-->
                        <!--Class of service code, single upper-case letter.-->
                    </ns14:FlightDetail>
                </ns9:Segment>
            </ns9:QueryByItinerary>
        </ns9:GetAncillaryOffersRQ>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Sample Response

<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
   <soap-env:Header>
      <eb:MessageHeader eb:version="1.0" soap-env:mustUnderstand="1" xmlns:eb="http://www.ebxml.org/namespaces/messageHeader">
         <eb:From>
            <eb:PartyId eb:type="URI">123123</eb:PartyId>
         </eb:From>
         <eb:To>
            <eb:PartyId eb:type="URI">99999</eb:PartyId>
         </eb:To>
         <eb:CPAId>AZ</eb:CPAId>
         <eb:ConversationId>ABC123@clientURL.com</eb:ConversationId>
         <eb:Service/>
         <eb:Action>GetAncillaryOffersRS</eb:Action>
         <eb:MessageData>
            <eb:MessageId>555792409609590870</eb:MessageId>
            <eb:Timestamp>2018-03-06T11:22:42</eb:Timestamp>
            <eb:RefToMessageId>mid:20001209-133003-2333@clientofsabre.com</eb:RefToMessageId>
         </eb:MessageData>
      </eb:MessageHeader>
      <wsse:Security xmlns:wsse="http://schemas.xmlsoap.org/ws/2002/12/secext">
         <wsse:BinarySecurityToken valueType="String" EncodingType="wsse:Base64Binary">Shared/IDL:IceSess\/SessMgr:1\.0.IDL/Common/!ICESMS\/ACPCRTC!ICESMSLB\/CRT.LB!-3171432398985529201!1218882!0</wsse:BinarySecurityToken>
      </wsse:Security>
   </soap-env:Header>
   <soap-env:Body>
      <ns31:GetAncillaryOffersRS xmlns:ns31="http://services.sabre.com/merch/ancillary/offer/v03">
         <ns17:ApplicationResults status="Complete" xmlns:ns17="http://services.sabre.com/STL_Payload/v02_01">
            <ns17:Success timeStamp="2018-03-06T05:22:42.305-06:00"/>
         </ns17:ApplicationResults>
         <ns31:AncillaryDefinition id="ancillary_1">
            <!--Optional-->
            <!--Repeat Factor 0-unbounded-->
            <!--Ancillary definition details like ancillary commercial name, ancillary group,ancillary vendor.--> 
            <SubCode>98B</SubCode>
            <!--Mandatory-->
            <!--Repeat Factor 1-1-->
            <!--Ancillary sub code.-->
            <Airline>AZ</Airline>
            <!--Mandatory-->
            <!--Repeat Factor 1-1-->
            <!--Airline owning ancillary.-->
            <CommercialName>TRANSPORTATION CREDIT VOUCHER</CommercialName>
            <!--Mandatory-->
            <!--Repeat Factor 1-1-->
            <!--Ancillary commercial name.-->
            <Vendor>MMGR</Vendor>
            <!--Optional-->
            <!--Repeat Factor 0-1-->
            <!--Specifies the vendor or vendors providing the service.-->
            <Group>99</Group>
            <!--Optional-->
            <!--Repeat Factor 0-1-->
            <!--Type of ancillary service.-->
            <GroupDescription>MISCELLANEOUS FEES</GroupDescription>
            <!--Optional-->
            <!--Repeat Factor 0-1-->
            <!--IATA group description.-->
            <ReasonForIssuance code="D">FINANCIAL_IMPACT</ReasonForIssuance>
            <!--Mandatory-->
            <!--Repeat Factor 1-1-->
            <!--Reason for issuance code.-->
            <ElectronicMiscDocType code="1">STANDALONE</ElectronicMiscDocType>
            <!--Optional-->
            <!--Repeat Factor 0-1-->
            <!--Electronic Miscellaneous Document type.-->
            <BookingMethod code="BLANK">ANY_ALLOWED</BookingMethod>
            <!--Optional-->
            <!--Repeat Factor 0-1-->
            <!--Booking method for ancillary.-->
            <DisplayOnly>false</DisplayOnly>
            <!--Optional-->
            <!--Repeat Factor 0-1-->
            <!--Display only.-->
            <ConsumedAtIssuanceIndicator>false</ConsumedAtIssuanceIndicator>
            <!--Optional-->
            <!--Repeat Factor 0-1-->
            <!--Consumed at issuance indicator.-->
         </ns31:AncillaryDefinition>
         <ns31:Ancillary ancillaryId="ancillary_ancillary_1" ancillaryDefinitionRef="ancillary_1">
            <!--Optional-->
            <!--Repeat Factor 0-unbounded-->
            <!--Ancillary details.-->
            <ServiceType>F</ServiceType>
            <!--Mandatory-->
            <!--Repeat Factor 1-1-->
            <!--Ancillary service type for example F-flight related.-->
            <SectorPortionInd>S</SectorPortionInd>
            <!--Optional-->
            <!--Repeat Factor 0-1-->
            <!--Sector/portion/journey indicator.-->
            <SequenceNumber>2000</SequenceNumber>
            <!--Optional-->
            <!--Repeat Factor 0-1-->
            <!--Sequence number.-->
            <TravelDateEffective>2018-05-20</TravelDateEffective>
            <!--Optional-->
            <!--Repeat Factor 0-1-->
            <!--Travel date effective.-->
            <LatestTravelDatePermitted>9999-12-31</LatestTravelDatePermitted>
            <!--Optional-->
            <!--Repeat Factor 0-1-->
            <!--Latest travel date permitted.-->
            <AirExtraStatus>CONFIRMED</AirExtraStatus>
            <!--Optional-->
            <!--Repeat Factor 0-1-->
            <!--Air extra status.-->
            <Footnote>N</Footnote>
            <!--Optional-->
            <!--Repeat Factor 0-1-->
            <!--Footnote applicable only for TN channel.-->
         </ns31:Ancillary>
         <ns31:Offers offerId="offer_ancillary_1" ancillaryRef="ancillary_ancillary_1">
            <!--Optional-->
            <!--Repeat Factor 0-unbounded-->
            <!--Ancillary offers.-->  
            <ns9:Origin xmlns:ns9="http://services.sabre.com/merch/ancillary/v03">FCO</ns9:Origin>
            <!--Mandatory-->
            <!--Repeat Factor 1-1-->
            <!--Origin.-->
            <ns9:Destination xmlns:ns9="http://services.sabre.com/merch/ancillary/v03">AUH</ns9:Destination>
            <!--Mandatory-->
            <!--Repeat Factor 1-1-->
            <!--Destination.-->
            <ns9:AncillaryFee xmlns:ns9="http://services.sabre.com/merch/ancillary/v03">
                <!--Optional-->
                <!--Repeat Factor 0-1-->
                <!--Ancillary fee details.-->     
               <Unavailable>false</Unavailable>
                <!--Optional-->
                <!--Repeat Factor 0-1-->
                <!--Unavailable indicator.--> 
               <TaxExemptIndicator>false</TaxExemptIndicator>
                <!--Optional-->
                <!--Repeat Factor 0-1-->
                <!--Tax exempt indicator.--> 
               <Base>
                  <ns2:Amount currency="EUR" xmlns:ns2="http://services.sabre.com/merch/common/v03">0.00</ns2:Amount>
                <!--Optional-->
                <!--Repeat Factor 0-1-->
                <!--Information about base ancillary amount and currency.--> 
               </Base>
               <ns2:EquivAmount currency="EUR" xmlns:ns2="http://services.sabre.com/merch/common/v03">0.00</ns2:EquivAmount>
               <!--Optional-->
                <!--Repeat Factor 0-1-->
                <!--Information about equivalent ancillary amount and currency.--> 
               <TTL_Price>
                  <ns2:Amount currency="EUR" xmlns:ns2="http://services.sabre.com/merch/common/v03">0.00</ns2:Amount>
                <!--Optional-->
                <!--Repeat Factor 0-1-->
                <!--Information about total base ancillary plus taxes.-->  
               </TTL_Price>
            </ns9:AncillaryFee>
            <ns9:AncillaryRules xmlns:ns9="http://services.sabre.com/merch/ancillary/v03">
                <!--Optional-->
                <!--Repeat Factor 0-1-->
                <!--Information about ancillary rules like ancillary form of payment.--> 
               <RefundableReissuable>Y</RefundableReissuable>
                <!--Optional-->
                <!--Repeat Factor 0-1-->
                <!--Refundable, re-issuable indicator.--> 
               <Commissionable>false</Commissionable>
                <!--Optional-->
                <!--Repeat Factor 0-1-->
                <!--Commissionable indicator.--> 
               <FeeApplicationMethod code="4">TRAVEL</FeeApplicationMethod>
                <!--Optional-->
                <!--Repeat Factor 0-1-->
                <!--Fee application method.--> 
               <FeeNotGuaranteeIndicator>true</FeeNotGuaranteeIndicator>
                <!--Optional-->
                <!--Repeat Factor 0-1-->
                <!--Fee not guarantee indicator.-->
               <SimultaneousTicketIndicator>X</SimultaneousTicketIndicator>
                <!--Optional-->
                <!--Repeat Factor 0-1-->
                <!--Simultaneous ticket indicator.-->
            </ns9:AncillaryRules>
            <ns9:Segment segmentId="seg_1" xmlns:ns9="http://services.sabre.com/merch/ancillary/v03"/>
                <!--Mandatory-->
                <!--Repeat Factor 1-unbounded-->
                <!--Segment reference.-->
            <ns9:PurchaseByDate xmlns:ns9="http://services.sabre.com/merch/ancillary/v03">2018-03-07</ns9:PurchaseByDate>
                <!--Optional-->
                <!--Repeat Factor 0-1-->
                <!--Purchase by date.-->
            <ns9:IsDisclosurePart xmlns:ns9="http://services.sabre.com/merch/ancillary/v03">false</ns9:IsDisclosurePart>
                <!--Optional-->
                <!--Repeat Factor 0-1-->
                <!--Disclosure indicator retrieved only for baggage ancillary group.-->
            <ns9:PaperTicketRequired xmlns:ns9="http://services.sabre.com/merch/ancillary/v03">false</ns9:PaperTicketRequired>
                <!--Optional-->
                <!--Repeat Factor 0-1-->
                <!--Paper ticket required indicator.-->
         </ns31:Offers>
         <ns31:PassengerOffers>
            <!--Optional-->
            <!--Repeat Factor 0-99-->
            <!--Passenger offers that contain reference to passenger and to specific ancillary offer.--> 
            <ns9:PassengerReference passengerType="ADT" nameReferenceNumber="01.01" passengerId="p_01.01" xmlns:ns9="http://services.sabre.com/merch/ancillary/v03"/>
            <!--Mandatory-->
            <!--Repeat Factor 0-1-->
            <!--Details about passenger reference like passenger type and passenger id.-->
            <ns9:OfferRefs xmlns:ns9="http://services.sabre.com/merch/ancillary/v03">offer_ancillary_1</ns9:OfferRefs>
            <!--Optional-->
            <!--Repeat Factor 0-1-->
            <!--Details about ancillary offers for a given passenger.-->
         </ns31:PassengerOffers>
         <ns31:ResponseOptions>
            <ns31:EmptyGroupList>FF BD GT SB MD IE ML</ns31:EmptyGroupList>
            <!--Optional-->
            <!--Repeat Factor 0-1-->
            <!--Empty group code information returned only in TN channel.-->
         </ns31:ResponseOptions>
      </ns31:GetAncillaryOffersRS>
   </soap-env:Body>
</soap-env:Envelope>

If you are a Sabre customer currently using Sabre APIs in production, access  Resources

Docs Navigation