FareSearch request message

Tabular overview of all nodes, which may occur in this message. See legend below for description of table columns.
Note: Some sibling elements or complete sub-trees of the hierarchy may be defined as mutually exclusive alternative choices. This information cannot be expressed in this tabular overview. Please refer to schema diagram for a graphical representation of the message schema.

NodeDescriptionValuesOccursExample
<FareSearchRQ>
Fare search request root element1
@version
Version number. 0..1 1.0 required for MasterPricer: MP2.0 (previous version MP0.9)
@NumberOfAlternates
Number of alternate fares requested. Supported in Worldspan, Sabre and Amadeus (MaterPricer).
Maximum/Default values are:
Amadeus: 200
Sabre: 19 (ATSE), 9 (Legacy system)
Worldspan: 100 (more based on tier level)
0..1
@DetailedFareType
Controls display of more detailed fare type info (only Amadeus for now, information is not returned by all GDS):
in case this attribute is set to 'Y' more detailed fare types will be displayed in the response; default value is 'N' which results in fare types PUBL, BOTH or NEGO;
(possible values are Y, N)
0..1
@QueryID
Optional, alphanumeric. Used only for internal tracking purposes.0..1
@DisregardAvailability
If set to Y will cause shopper to disregard the actual availability of the flight during the shopping.
Values are:
Y - disregard
N - considere availability while constructing recommendations. (default)

If this attribute is not present in the request - N behavior is applied.
[Y] [N] 0..1
@ScrollLimitForward
If initial request does not return all flights for specified criteria some CRS may require additional additional "scroll" requests to be sent to get flights departing at a later time and/or date. In that case ScrollLimitForward specifies the maximum number of additional requests to send to get later flights. If left out, no limit is applied. Currently only supported for AirBerlin.

0..1 1
@ScrollLimitBackward
If initial request does not return all flights for specified criteria some CRS may require additional additional "scroll" requests to be sent to get flights departing at an earlier time and/or date. In that case ScrollLimitBackward specifies the maximum number of additional requests to send to get earlier flights. If left out, no limit is applied. Currently only supported for AirBerlin.

0..1 1
@Timeout
Timeout in seconds. Only supported by some adapters which send multiple parallel backend requests to gather information for the XX/1 response.

If a timeout is specified, XX/1 will only wait for the specified number of seconds for the parallel backend requests to complete. Information from backend requests which have not completed when the timeout is reached are ignored in the XX/1 response without issuing an error message.

0..1 3
@NSFNumberOfAvailabilityAlternates
This attribute only affects FareSearchRQ requests sent with a @version="NSF*" (No Shopper FareSearch - available for GDS adapters upon request). It specifies the number of alternates to pass through to the AirAvailabilityRQ requests performed in the background.

0..1 30
@RequestServiceFeeInformations
Requesting service fee informations, can heaviliy impact the size of the response message and can also impact the performance and the response time.

Default: N
[Y] [N] 0..1
<SaleInfo>
Sale information group0..1
<CityCode/>
Origin or destination city code. City where sale takes place or city where ticket will be issued. 0..1 PAR
<CountryCode/>
Country where sale takes place or ticket issuing country. 0..1 US
<CurrencyCode>
0..1
</CurrencyCode>
</SaleInfo>
<TicketingInfo>
Ticketing information group0..1
<CityCode/>
Origin or destination city code. City where sale takes place or city where ticket will be issued. 0..1 PAR
<CountryCode/>
Country where sale takes place or ticket issuing country. 0..1 US
<Date>
Specifies departure date in ISO 8601 format (yyyy-mm-dd). 0..1 2001-12-25
</Date>
</TicketingInfo>
<TravelerInfo>
Number of passengers of the specified type. 1..N 2
@Type
Passenger type requested for pricing.

If the passenger type does not correspond to one of the normalized XX/1 values below it is passed to provider as is.

Normalized values are:
ADT= Adult
CHD = Child
INF = Infant
GOV = Government
MIL = Military
SRC = Senior citizen
STD = Student
YTH = Youth

1 CHD
</TravelerInfo>
<TravelerIDs>
If no PNR exists (shopping), this provides traveler types as well as FQTV information for each traveler.

FQTV information can impact the availability and prices of optional services.
0..N
@AssociationID
A unique traveler reference if an association to individual travelers is needed, such as for optional services.

1 T1
@PaxType
Passenger type requested for pricing.

Some IATA values are :
ADT= Adult
CHD = Child
INF = Infant
GOV = Government
MIL = Military
SRC = Senior citizen
STD = Student
YTH = Youth
1 CHD
<FQTVInfo>
0..N
<FFNumber/>
Frequent flyer number. 1 0956301007
<FFCompanyCode/>
Frequent flyer company code. 1 AF
</FQTVInfo>
</TravelerIDs>
<OriginDestination>
Origin and destination group1..N
<Departure>
Origin group1
@Area
Supported in
Amadeus MasterPricer:
Sabre Low Fare Search (TripSearch / Bargain Finder Plus)
The user has the ability to extend the low fare search up to 300 kilometers surrounding the departure airport or city specified. If a departure Area is specified, the low fare search process may consider any city whose flying distance to the specified City or Airport is lower than the specified radius in the query.
0..1 100
@CrossBorder
Only applicable in combination with @Area. If set to 'Y', also airports which are situated in a different country but within the specified radius will be considered.

Only supported in Amadeus TravelBoardSearch (0.9 and 2.0) and MasterPricerExpert(0.9 and 2.0)

Values are:
Y .. Yes
N .. No (default)
[Y] [N] 0..1
<CityCode/>
Origin city code.

1..9 PAR
</Departure>
<Arrival>
Destination group1
@Area
Supported only in Amadeus MasterPricer:
The user has the ability to extend the low fare search up to 300 kilometers surrounding the arrival airport or city specified. If an arrival Area is specified, the low fare search process may consider any city whose flying distance to the specified City or Airport is lower than the specified radius in the query.
0..1 100
@CrossBorder
Only applicable in combination with @Area. If set to 'Y', also airports which are situated in a different country but within the specified radius will be considered.

Only supported in Amadeus TravelBoardSearch (0.9 and 2.0) and MasterPricerExpert(0.9 and 2.0).

Values are:
Y .. Yes
N .. No (default)
[Y] [N] 0..1
<CityCode/>
Destination city code.

1..9 FRA
</Arrival>
<Date>
Specifies departure OR arrival date (depending on @Qualifier) in ISO 8601 format (yyyy-mm-dd).

Only some CRS support search by arrival AND departure date simultaneously. For these CRS two Date elements may be specified. In this case one must have @Qualifier="DEPARTURE" and one @Qulifier="ARRIVAL".

1..2 2001-12-25
@Qualifier
The Qualifier controls whether the search is performed for flights departing or arriving on the specified Date. At the same time it controls whether an optionally specified Time and TimeWindow (see Preferences) is applied to the departure time or the arrival time (unless overridden by Time/@Type).

Values:
DEPARTURE (default if left out)
ARRIVAL

[DEPARTURE] [ARRIVAL] 0..1 ARRIVAL
</Date>
<Preferences>
Preferences group0..1
@Sort
Specified how the response should be sorted.

Values are:
DEPARTURE = by departure time
ARRIVAL = by arrival time
ELAPSED = by elapsed time
NEUTRAL = (default) as defined by the provider.

[DEPARTURE] [ARRIVAL] [ELAPSED] [NEUTRAL] 0..1 DEPARTURE
@MultiAirport
In case a city code refers to a multi-airport city and one of the cities airports at the same time, the search will include all airports belonging to the city when set to "Y".

Values are: Y = Yes, N = No.
[Y] [N] 0..1 N
@MinStayHours
Possibility to define the minimum number of hours between arrival at the preceding destination and the departure from this origin.

If not specified, default is 0.

0..1 6
<ClassOfService/>
Restrict search to specific class(es) of service.

Not supported by Amadeus.

Multiple ClassOfService elements only supported for AirBerlin.

For CRS (ex. AirBerlin, Condor), which dont support different ClassOfService per OD, ClassOfService element(s) must be specified identically for each OriginDestination.

1..N Y
<ExcludeClassOfService/>
Exclude specific class(es) of service from the search result.

0..N Y
<Cabin>
Specifies cabin preference. Valid values are:
P = Premium First class
F = First class
J = Premium Business class
C = Business class
W = Premium Economy class
Y = Coach class

0..1 Y
@Specific
If @Specific is set to "Y", will only return results where all segments lie within the requested cabin. That is, if requested cabin is not available for any one segment required for an OriginDestination, the fare will not be returned.
If set to "Y", @Specific must be set to "Y" for all OriginDestination elements with Preferences/Cabin. Otherwise the Cabin will be ignored completely for OriginDestination elements, where @Specific is not set to "Y".

Not supported on: Worldspan

Values:
Y = Yes
N = No

Default: N

[Y] [N] 0..1 Y
</Cabin>
<Time>
The Time element is used to restrict search to flights with a specific departure or arrival time. It may be extended to a time window using the TimeWindow element. If TimeWindow is left out the behaviour is CRS dependent: Some will apply a default time window while others may only return flights for the exact time specified.

Whether Time is applied to the departure or arrival time is controlled by the @Type attribute. If @Type is left out, the Time applies to the same entity as the (first) OriginDestination/Date element.

1 14:15
</Time>
<TimeWindow>
Time window group0..1
<HoursBefore/>
Number of hours before specified Time. Value from 1 to 12.

[1] to [12]0..1 6
<HoursAfter/>
Number of hours after specified Time. Value from 1 to 12.

[1] to [12]0..1 12
<HoursTotal/>
Specifies the total number of hours the journey is not to exceed. Value from 1 to 99. [1] to [99]0..1 26
</TimeWindow>
<DayWindow>
If DayWindow is specified, response may contain fares for flights which depart (or arrive - see Date) up to the specified number of days before and/or after the Date specified.

Not all CRS support search by arrival AND departure daywindow.
0..2
@Type
attribute indicates type of day window, possible values are DEPARTURE and ARRIVAL; default value is DEPARTURE0..1
<DaysBefore/>
Number of days before specified Date to include in search.
Values: [0..3]

[0] to [6]1 3
<DaysAfter/>
Number of days after specified Date to include in search.
Values: [0..3]

[0] to [6]1 3
</DayWindow>
<Airline>
Airline preference group0..1
@Specific
Specific request for itineraries where every leg is on the specified carrier. [Y] 0..1 Y
<Include/>
Airline code for carriers to be included in the search or city code of the airport to be included in the connection. 0..N AF or MIA
<Exclude/>
Airline code for carriers to be excluded in the search, or city code of the airport to be excluded in the connection. 0..N DL or LON
</Airline>
<Connection>
Connection preference group0..1
<Include/>
Airline code for carriers to be included in the search or city code of the airport to be included in the connection. 1..2 AF or MIA
<Exclude/>
Airline code for carriers to be excluded in the search, or city code of the airport to be excluded in the connection. 1..2 DL or LON
</Connection>
<AllianceCode/>
Search by alliance code. Values are: *O = One World
*A = Star Alliance
*S = Sky Team.

NOTE: Currently only supported for Apollo/Galileo and Worldspan.

0..1 *S
<FlightType>
Specifies the flight type preferences. If absent, get all flights. Maxi value in attributes means all below level are taken into account.0..1
@NoStopDirect
Non-stop direct flights. Values are:
Y = Yes
M = Maximum.
[Y] [M] 0..1 Y
@StopDirect
Stop direct flights. Values are: Y = Yes
M = Maximum.
[Y] [M] 0..1 Y
@OneConnectSingleAirline
Single online connection flights. Values are: Y = Yes
M = Maximum.
[Y] [M] 0..1 Y
@TwoConnectSingleAirline
Double online connection flights. Values are: Y = Yes
M = Maximum.
[Y] [M] 0..1 Y
@ThreeConnectSingleAirline
Triple online connection flights. Values are: Y = Yes
M = Maximum.
[Y] [M] 0..1 Y
@OneConnectMultipleAirline
Single interline connection flights. Values are: Y = Yes
M = Maximum.
[Y] [M] 0..1 Y
@TwoConnectMultipleAirline
Double interline connection flights. Values are: Y = Yes
M = Maximum.
[Y] [M] 0..1 Y
@ThreeConnectMultipleAirline
Triple interline connection flights. Values are: Y = Yes
M = Maximum.
[Y] [M] 0..1 Y
</FlightType>
</Preferences>
</OriginDestination>
<PricingInfo>
Fare qualifier group0..1
@FareType
Type of fare being returned. Values are:
PUBL = published fare
NEGO = negotiated/private fare
BOTH = Published and private Fares
[PUBL] [NEGO] [BOTH] 1 NEGO
@NoBreak
Specifies simple or creative pricing. If NoBreak = 'Y', simple pricing will be used for the flights returned. If NoBreak = 'N', creative pricing will be used for all flights returned. Values are: Y = Yes, N = No. [Y] [N] 0..1 Y
@Priority
Experimental. Sabe ONLY.
Will be ignored on other GDS.

Numeric. 4 digits. Order identifies priority.
1- Price
2- NonStop/Direct Flights
3- Travel time
4 - Carrier

0..1 1234 or 4123
@FullTicketingOnly
For systems which support alternative fare / ticketing flows for low cost carriers (such as LightTicketing on Amadeus), specifies whether alternative flows shall be suppressed.

Values are:
Y = Yes,
N = No.
[Y] [N] 0..1 Y Default: N
<Restrictions>
Pricing restrictions group0..1
@ExcludeAll
This attribute also excludes restrictions which are not covered by the other attributes.

Y = Excludes all fares with any kind of restriction (other attributes have no effect)
N = Don't exclude all fares with any kind of restriction (other attributes can be used to allow further restrictions)

Default: N
[Y] [N] 0..1
@MinimumStay
Y = Allow Minimum stay with fare
N = Don't Allow Minimum stay with fare
Default: Y
[Y] [N] 0..1
@MaximumStay
Y = Allow Maximum stay with fare
N = Don't Allow Maximum stay with fare
Default: Y
[Y] [N] 0..1
@Advance
Y = Allow Advance Purchase with fare
N = Don't Allow advance Purchase with fare
Default: Y
[Y] [N] 0..1
@Penalty
Y = Allow Penalties with fare
N = Don't Allow penalties with fare
Default: Y
[Y] [N] 0..1
@Refundable
Y = Return refundable fares only
N = Return non-refundable fares only

Default: If not defined mixed results can be returned, depending on the other Restriction settings.
[Y] [N] 0..1
</Restrictions>
<PrivateFares>
Negotiated fares (Private fares) group0..1
<Office>
Pseudo city under which private fares are stored. 1..N 18C6
@Provider
Code of the provider system that holds the private fares. Values are:
1A = Amadeus
1B = Abacus
1V = Apollo
1G = Galileo
1S = Sabre (also 1W)
1P = Worldspan
1U = ITA
XS = SITA
[1A] [1B] [1V] [1G] [1S] [1P] [1W] [1U] [XS] 1 1V
@Type
Future use.
Identifies if Office value is a PCC or IATA agency code/ID. Default is PCC.
[PCC] [IATA] 0..1 PCC
</Office>
<Corporate>
Corporate info group

Max occurance:
Amadeus: 6
Apollo/Galileo: 5
Sabre: 5
Sabre BGFM: 4
Worldspan: 5
1..N
<Account>
Specifies the corporate account number to use to price private fares. 0..1 PASS
@Code
Requests Account Code fares. Values are:
Y = Request Account Code only Fares
N = Request Account Code and Published Fares
[Y] [N] 0..1 Y
</Account>
<Contract/>
Specifies the contract code, to use to price private fares. 0..1 00001
</Corporate>
</PrivateFares>
<ServicesFilter>
Used to request a filtered list of offered services. The filter codes used are defined by ATPCO (S5 record attributes)

Note: can ONLY be used when attribute "RequestServiceFeeInformations" value="Y".
0..1
<Attributes>
0..N
<Group>
Samples:
BG = Baggage
FF = Frequent Flyer
GT = Ground Transportation
and Non Air Services
IE = In-flight entertainment
LG = Lounge
MD = Medical
ML = Meal/Beverage
PT = Pets
RO = Rule Override
SA = Prereserved Seat
Assignment
SB = Standby
ST = Store
TS = Travel Services
UN = Unaccompanied
Travel (Escort)
UP = Upgrades
1
<Code/>
1 BG
</Group>
<SubGroup>
Samples for group "BG"
CT = Container
PP = Pre-paid excess
baggage

Samples group "GT"
BU = Bus
LI = Limo, etc

Samples group "IE"
IT = Internet access
TV = Television, etc
0..N
<Code/>
1 PP
</SubGroup>
</Attributes>
</ServicesFilter>
<PriceToBeat>
Price to beat group0..1
<Amount/>
Amount price to beat. 1 30000
<CurrencyCode>
1
</CurrencyCode>
</PriceToBeat>
<ValidatingCarrier/>
Allows to specify the validating carrier for pricing. 0..1 DL
<ResidentDiscount>
0..1
<DiscountCode/>
The fare discount code.1
</ResidentDiscount>
<FormOfPayment>
Multiple form of payments can be specified here that are offered by or for the customer.
The type of form of payment can impact the price because of fees that are collected by the carrier.

Some systems will determine the cheapest form of payment type and return its fees, other systems will return the prices for all form of payments specified here.
0..N
<CreditCard>
1
<IIN/>
Issuer Identification Number (IIN), previously known as bank identification number (BIN) equals the first 6 digits of the Credit card number.1
<CCCode/>
Credit card code.
1 VI TP .. Air Plus AX .. American Express BC .. BC Card CB .. Carte Blanche R .. Carte Bleue CU .. China Union Pay XC .. Connect DC .. Diners DB .. Diners Club DS .. Discover EC .. EuroCard JC .. Japan Credit Bureau (JCB) TO .. Maestro CA .. MasterCard VI .. Visa Credit VID .. Visa Debit VIL .. Visa Delta VIE .. Visa Electron
<CCNumber/>
Credit card number. 0..1 4011236654652341 Can be returned encrypted by GDS/CRS. Example: XXXXXXXXXXXXXXXX
<CCExpiration>
Credit card expiration group0..1
<Month/>
Credit card expiration month. 1 02 Can be returned encrypted by GDS/CRS. Example: XX
<Year/>
Last two digits of the credit card expiration year. 1 06 Can be returned encrypted by GDS/CRS. Example: XX
</CCExpiration>
</CreditCard>
<Other/>
Other payment information. 1 CHECK, CASH
</FormOfPayment>
</PricingInfo>
</FareSearchRQ>

Legend

ColumnDescription
NodeName of message node (element or attribute). Nodes in bold type are mandatory, if their parent element occurs in the message. Point mouse cursor at table cell to view complete XPath.
DescriptionDescription of meaning and usage of the node.
ValuesList of predefined values (each in square brackets) or range of values ("[a] to [z]") allowed for the node, if formally defined in the schema.
OccursMinimum and maximum number of times the node must/may occur, if its parent element occurs in the message. Examples:
0..3 Node is optional and may occur up to 3 times.
1..N Node must occur at least one (mandatory) and may occur any number of times.
2 Node must occur exactly twice.
ExampleExample value for the node.

XML Schema documentation generated with XX/1 server