Skip to main content

Exchange Shopping

2.4.0
Air
Ticketing
SOAP API
Travel Agency
  • Starting from version 2.4.0, the API provides capability of forcing the system to retain the original booking code for non-shopped legs.
  • Starting from version 2.4.0, the API provides capability of forcing the system to retain the originally ticketed brand for non-shopped legs. Previously, system might alter your originally ticketed brand while searching for the lowest exchange solution.

API Information

Response Format
XML
Service Action Code
ExchangeShoppingRQ
Current Version
2.4.0
Target Audience
TN
Environment
Production

What's New

  • Starting from version 2.4.0, the API provides capability of forcing the system to retain the original booking code for non-shopped legs.
  • Starting from version 2.4.0, the API provides capability of forcing the system to retain the originally ticketed brand for non-shopped legs. Previously, system might alter your originally ticketed brand while searching for the lowest exchange solution.

New Features

In the Request

Optional

Parameter: keepBookingClass

Type: boolean

Description: Forces the system to retain the original booking code for non-shopped legs

Sample Value:

<ExchangeShoppingRQ xmlns="http://services.sabre.com/sp/exchange/shopping/v2_4" version="2.4.0">
  <STL_Header.RQ>
    <OrchestrationID seq="0">744067011664091422</OrchestrationID>
  </STL_Header.RQ>
  <TicketingProvider>1S</TicketingProvider>
  <PassengerInformation>
    <PassengerWithoutPNR>
      <DocumentNumber>6077049020878</DocumentNumber>
    </PassengerWithoutPNR>
  </PassengerInformation>
  <OriginDestinationInformation shopIndicator="true">
    <DateTimeSelection>
      <DepartureDateTime>2020-11-19T13:45:00</DepartureDateTime>
    </DateTimeSelection>
    <StartLocation>AUH</StartLocation>
    <EndLocation>LHR</EndLocation>
  </OriginDestinationInformation>
  <OriginDestinationInformation shopIndicator="false">
    <DateTimeSelection>
      <DepartureDateTime>2020-11-27T14:05:00</DepartureDateTime>
    </DateTimeSelection>
    <StartLocation>LHR</StartLocation>
    <EndLocation>AUH</EndLocation>
    <RelatedSegment operatingProvider="EY" marketingProvider="EY" marketingFlightNumber="0020" startDateTime="2020-11-27T14:05:00" endDateTime="2018-11-28T01:20:00" startLocation="LHR" endLocation="AUH" bookingClass="F" reservationStatus="HK" bookingDateTime="2020-08-22T05:53:00" keepBookingCode="true"/>
  </OriginDestinationInformation>
</ExchangeShoppingRQ>
Note:

In the Request

Optional

Parameter: keepOriginalBrand

Type: boolean

Description: Forces the system to retain the originally ticketed brand for non-shopped legs.

Sample Value:

<ExchangeShoppingRQ xmlns="http://services.sabre.com/sp/exchange/shopping/v2_4" version="2.4.0">
  <STL_Header.RQ>
    <OrchestrationID seq="0">744067011664091422</OrchestrationID>
  </STL_Header.RQ>
  <TicketingProvider>1S</TicketingProvider>
  <PassengerInformation>
    <PassengerWithoutPNR>
      <DocumentNumber>6077049020878</DocumentNumber>
    </PassengerWithoutPNR>
  </PassengerInformation>
  <OriginDestinationInformation shopIndicator="true">
    <DateTimeSelection>
      <DepartureDateTime>2020-11-19T13:45:00</DepartureDateTime>
    </DateTimeSelection>
    <StartLocation>AUH</StartLocation>
    <EndLocation>LHR</EndLocation>
  </OriginDestinationInformation>
  <OriginDestinationInformation shopIndicator="false">
    <DateTimeSelection>
      <DepartureDateTime>2020-11-27T14:05:00</DepartureDateTime>
    </DateTimeSelection>
    <StartLocation>LHR</StartLocation>
    <EndLocation>AUH</EndLocation>
    <RelatedSegment operatingProvider="EY" marketingProvider="EY" marketingFlightNumber="0020" startDateTime="2020-11-27T14:05:00" endDateTime="2018-11-28T01:20:00" startLocation="LHR" endLocation="AUH" bookingClass="F" reservationStatus="HK" bookingDateTime="2020-08-22T05:53:00" keepBookingCode="true"/>
  </OriginDestinationInformation>
  <TravelPreferences>
    <PriceRequestInformation>
      <TPA_Extensions>
        <BrandedFareIndicators keepOriginalBrand="true" singleBrandedFare="true"/>
      </TPA_Extensions>
    </PriceRequestInformation>
  </TravelPreferences>
</ExchangeShoppingRQ>
Note:

Relase note ID: 14954


  • Exchange Shopping now allows users to target specific resulting fares using a Brand ID Code. The request can include a unique Brand ID or multiple Brand IDs that can be applied to the entire itinerary or per leg.

API Information

Response Format
XML
Service Action Code
ExchangeShoppingRQ
Current Version
2.3.0
Target Audience
TN
Environment
Production

What's New

  • Exchange Shopping now allows users to target specific resulting fares using a Brand ID Code. The request can include a unique Brand ID or multiple Brand IDs that can be applied to the entire itinerary or per leg.

Functional Updates And Enhancements

In the Request

Optional

Parameter: Brand

Type: n/a

Description: Used to shop by Brand ID on a leg level

Sample Value:

 
Note:

In the Request

Optional

Parameter: NonBrandedFares

Type: n/a

Description: Used to ensure that all of the fares within the response are assigned to a brand

Sample Value:

<OriginDestinationInformation shopIndicator="true">
  <DateTimeSelection>
    <DepartureDateTime>2019-06-10T08:25:00</DepartureDateTime>
  </DateTimeSelection>
  <StartLocation>LHR</StartLocation>
  <EndLocation>JFK</EndLocation>
  <IncludeVendor>AY</IncludeVendor>
  <BrandFilters>
    <Brand code="A4" preferLevel="Preferred"/>
    <NonBrandedFares preferLevel="Unacceptable"/>
  </BrandFilters>
</OriginDestinationInformation>
Note:

In the Request

Optional

Parameter: Brand

Type: n/a

Description: Used to shop by Brand ID on an itinerary level

Sample Value:

<TravelPreferences>
  <PriceRequestInformation>
    <TPA_Extensions>
      <BrandedFareIndicators returnBrandAncillaries="true" singleBrandedFare="true">
        <BrandFilters>
          <Brand code="A4" preferLevel="Preferred"/>
          <Brand code="ECONFLEX" preferLevel="Preferred"/>
        </BrandFilters>
      </BrandedFareIndicators>
    </TPA_Extensions>
  </PriceRequestInformation>
</TravelPreferences>
Note:

In the Request

Optional

Parameter: returnBrandAncillaries

Type: boolean

Description: Used to return ancillaries from the ATPCO Branded Fares Feature Table 166

Sample Value:

<TravelPreferences>
  <PriceRequestInformation>
    <TPA_Extensions>
      <BrandedFareIndicators returnBrandAncillaries="true" singleBrandedFare="true">
        <BrandFilters>
          <Brand code="A4" preferLevel="Preferred"/>
          <Brand code="ECONFLEX" preferLevel="Preferred"/>
        </BrandFilters>
      </BrandedFareIndicators>
    </TPA_Extensions>
  </PriceRequestInformation>
</TravelPreferences>
Note:

In the Response

Optional

Parameter: BrandFeatures

Type: n/a

Description: Indicates the final list of all brand feature items

Sample Value:

<BrandFeature id="1" application="F" serviceType="Z" serviceGroup="BF" subCode="050" vendor="ATP" commercialName="SEAT RESERVATION"/>
Note:

Relase note ID: 12830


  • Added ability to verify refundability/reusability details for all EMD-A associated to the ticket being exchanged. The service also supports the inclusion of additional EMD-A that are not associated to the ticket being exchanged.
  • The service response will include a list of ancillaries available for each new itinerary option.

API Information

Response Format
XML
Service Action Code
ExchangeShoppingRQ
Current Version
2.2.0
Target Audience
TN
Environment
Production

What's New

  • Added ability to verify refundability/reusability details for all EMD-A associated to the ticket being exchanged. The service also supports the inclusion of additional EMD-A that are not associated to the ticket being exchanged.
  • The service response will include a list of ancillaries available for each new itinerary option.

Functional Updates And Enhancements

In the Request

Optional

Parameter: validateAssociatedEMDs

Type: boolean

Description: used to validate associated EMDs for refundability or exchangeability.

Sample Value:

 
Note:

In the Request

Optional

Parameter: ElectronicMiscellaneousDocumentNumber

Type: n/a

Description: allows to pass EMD numbers to be validated for refundability or exchangeability.

Sample Value:

 
Note:

In the Request

Optional

Parameter: AncillaryFees

Type: n/a

Description: used to query for ancillary fees options

Sample Value:

 
Note:

In the Request

Optional

Parameter: Baggage

Type: n/a

Description: used to request baggage information.

Sample Value:

<ExchangeShoppingRQ xmlns="http://services.sabre.com/sp/exchange/shopping/v2_2" version="2.2.0">
  <STL_Header.RQ>
    <OrchestrationID seq="0">744067011664091422</OrchestrationID>
  </STL_Header.RQ>
  <TicketingProvider>1S</TicketingProvider>
  <PassengerInformation>
    <PassengerWithoutPNR>
      <DocumentNumber validateAssociatedEMDs="true">6077049020878</DocumentNumber>
    </PassengerWithoutPNR>
  </PassengerInformation>
  <OriginDestinationInformation shopIndicator="true">
    <DateTimeSelection>
      <DepartureDateTime>2018-11-19T13:45:00</DepartureDateTime>
    </DateTimeSelection>
    <StartLocation>AUH</StartLocation>
    <EndLocation>LHR</EndLocation>
  </OriginDestinationInformation>
  <TravelPreferences>
    <Baggage RequestType="A"/>
  </TravelPreferences>
</ExchangeShoppingRQ>
Note:

In the Response

Optional

Parameter: AncillaryFeeGroups

Type: n/a

Description: Element used to pass details on ancilary options available for the shopped itinerary.

Sample Value:

 
Note:

In the Response

Optional

Parameter: BaggageInformationList

Type: n/a

Description: used to pass baggage information available for the shopped itinerary

Sample Value:

 
Note:

In the Response

Optional

Parameter: ValidateEMDForExchange

Type: n/a

Description: Detailed information about passenger ElectronicMiscellaneousDocuments validated for refundability or exchangeability

Sample Value:

 
Note:

Relase note ID: 12895


  • Added new parameter to the service response schema to notify the user that the non-shopped segment requires rebooking

API Information

Response Format
XML
Service Action Code
ExchangeShoppingRQ
Current Version
2.1.0
Target Audience
TN
Environment
Production

What's New

  • Added new parameter to the service response schema to notify the user that the non-shopped segment requires rebooking

Functional Updates And Enhancements

In the Response

Optional

Parameter: book

Type: boolean

Description: used to indicate that the flight segments require rebooking or not. book="false" is returned when flight segment details (including booking class) match values passed within /ExchangeShoppingRQ/OriginDestinationInformation/RelatedSegment

Sample Value:

...<ReservationSegment elapsedTime="85" electronicTicketingIndicator="true" endDateTime="2016-11-29T17:30:00" endLocation="ORD" marketingFlightNumber="233" marketingProvider="LH" marriageGroup="O" operatingProvider="LO" segmentNumber="1" startDateTime="2016-11-29T16:35:00" startLocation="KRK" stopQuantity="0" book="false">...
Note:

Relase note ID: 12990


  • The service has redesigned request and response schema
  • It is no longer necessary to provide PNR locator, the API will not modify the current PNR if provided.
  • Service now supports up to 9 ticket numbers (passengers)
  • Service response will return up to 50 solutions

API Information

Response Format
XML
Service Action Code
ExchangeShoppingRQ
Current Version
2.0.0
Target Audience
TN
Environment
Production

What's New

  • The service has redesigned request and response schema
  • It is no longer necessary to provide PNR locator, the API will not modify the current PNR if provided.
  • Service now supports up to 9 ticket numbers (passengers)
  • Service response will return up to 50 solutions

Relase note ID: 13031