API Information

Response Format
XML
Service Action Code
ExchangeShoppingRQ
Current Version
2.3.0
Target Audience
TN
Environment
Production
Documentation
Go to the Exchange Shopping documentation

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:

<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"/> </BrandFilters>
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>
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>
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>

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"/>