FlightPrice 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
<FlightPriceRQ>
Flight price request root element1
@version
Version number. 0..1 1.0
@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
<SaleInfo>
Sale Information group0..1
<CityCode/>
City where sale takes place or City where ticket will be issued. 0..1 MIA
<CountryCode/>
Country where sale takes place or Ticket issuing country. 0..1 US
<CurrencyCode>
0..1
</CurrencyCode>
</SaleInfo>
<TicketingInfo>
Ticketing Information group0..1
<CityCode/>
City where sale takes place or City where ticket will be issued. 0..1 MIA
<CountryCode/>
Country where sale takes place or Ticket issuing country. 0..1 US
</TicketingInfo>
<RecordLocator/>
PNR record locator hosting the segments used in this request in order to provide additional PNR data.

For internal tracking purposes only (no GDS PNR retrieval will take place)
0..1 XJUATR
<TravelerInfo>
Number of passengers of the specified type. 1..N 2
@Type
Passenger type requested for pricing. If the passenger type sent to the GDS is not in the below predefined list, then it is passed as is to the GDS.
Predefined 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
@Source
Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. 0..1 1A, 1V, or other.
<Flight>
Flight Info group1..N
@Source
Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. 0..1 1A, 1V, or other.
@AssociationID
Unique flight ID used to associate pricing information to the flight element. 0..1 F1
@MarriedSegment
Married connection indicator. Values:
B = Beginning of a group of married segments
E = End of a group of married segments
[B] [E] 0..1
@Type
Optional flight type. This is used to specify passive or open segments, and in the case of flown the segment is only added for historical pricing purposes.
Values are:
P = Passive
O = Open
F = Flown (for pricing only)
[P] [O] [F] 0..1 P
<AirlineCode/>
Airline Code. 1 DL
<FlightNumber>
Flight number - an integer value within the range of [0,9999].

1 1234
@Suffix
Flight number alpha qualifier.
Values are:
A
B
C
D

[A] [B] [C] [D] 0..1 A
</FlightNumber>
<Cabin/>
Cabin preference for this flight segment. To specify a cabin preference for the complete itinerary, use PricingInfo/@Cabin instead.

Valid values are :
P = Premium First class
F = First class
J = Premium Business class
C = Business class
W = Premium Economy class
Y = Coach class

[P] [F] [J] [C] [W] [Y] 0..1 F
<ClassOfService/>
Class of service. 1 B
<Departure>
Departure Information group1
<AirportCode/>
Origin or destination Airport Code. 1 MIA
<Date/>
Specifies departure date in ISO 8601 format (yyyy-mm-dd). 1 2001-12-25
<Time/>
Departure time in ISO 8601 twenty-four hour clock format. 1 14:00
</Departure>
<Arrival>
Arrival Information group1
<AirportCode/>
Origin or destination Airport Code. 1 MIA
<Date/>
Specifies arrival date in ISO 8601 format (yyyy-mm-dd). 1 2001-12-25
<Time/>
Arrival time in ISO 8601 twenty-four hour clock format. 1 14:00
</Arrival>
<ActionCode/>
FUTURE USE. NONE OF GDS SUPPORTS IT YET. IF ENTERED WILL BE IGNORED FOR GDS.
HOWEVER, CAN BE USED W/ EXTERNAL PRICING ENGINES.

Action code for the sell of a segment. This a standard defined action code used by different airlines and reservation systems. If omitted the default value is NN.
0..1 GK
<NumberOfStops/>
Number of stops. [0] to [9]0..1 0
<ReservationsDateTime>
Date/time when the entire booking was reserved. Alternatively this date/time may be set independently for each flight - see ReservationsDateTime element in the Flight element of the OriginDestination element(s).0..1
<Date/>
Specifies date in ISO 8601 format (yyyy-mm-dd). 1 2001-12-25
<Time/>
Specifies time in ISO 8601 twenty-four hour clock format. 0..1 14:00
</ReservationsDateTime>
</Flight>
</OriginDestination>
<OptionalServices>
Optional Services group0..1
<Service>
Service details1..N
@AssociationID
Unique ID used to associate to this element at PNR creation time. 1 S1
@SaleStatus
Allowed Values:

"Issued"
"Booked"

"Issued" represents those services which have been issued and have a valid EMDInfo node

"Booked" represent items sold/booked but not yet issued

Values are returned in the response
[Issued] [Booked] 0..1
@ReasonCode
IATA RFIC (ReasonFor IssuanceCode, a 1-character main code)
Example of RFIC: A

Note: Only services of same RFIC code can be combined on an EMD-A document. For example, if there are services of RFIC code "A" and "B", two separate EMD documents are needed, issuing all services of "A" and "B" on seperate docs.
1
@SubCode
ATPCO RFIS (ReasonForIssuance Subcode).
Example of RFIS: 0CC
1
@ServiceCode
Additional unique ATPCO code.
0..1 OC
@FareBrand
Service is part of a bundle associated to this fare brand0..1
@Quantity
This attribute provides how many service/items of the same type have been ordered. Possible Values: 1-99; 1 being the default [1] to [99]0..1 3
<SegmentIDRef/>
ID reference used to associate this item to a segment. No comma separated lists and no ranges supported. 0..N F1
<TravelerIDRef/>
Unique association ID reference of the traveler associated to this item. No comma separated lists and no ranges allowed. 0..1 T1
<ServiceLocation/>
Optionally used for non-flight related services, such as airline lounge pass, pre-paid booklets for drinks/meals or WiFi.

This is the 3-letter IATA city- or airport code related to the service. For example, an airport lounge pass may only be valid for one location.

0..1 DFW
<ServiceDate/>
Service date in ISO 8601 format (yyyy-mm-dd). 0..1 2010-12-25
<Description/>
Title description (Commercial Name) of this service - normally a one liner, e.g. "3rd Bag Fee"0..1
<DescriptionVariable/>
This value is used to provide a variable value for an selected service.

Sample: for a Premium Seat this will be a seat number; for a annual pass of onboard WiFi this will be the credentials, etc.

Examples:
"9D"
"UID: GO8978 PW: 1234"
0..1
<ReferenceKey/>
Unique reference key. If present in pricing response messages, must be included.0..1
</Service>
</OptionalServices>
<ExcludedServices>
This node is used exclusively for services which have been offered as INCLUDED but can be deselected by the user. This currently only applies to branded fares were a bundle of services can be included in the brand.0..1
<Service>
Service details1..N
@ReasonCode
IATA RFIC (ReasonFor IssuanceCode, a 1-character main code)
Example of RFIC: A

Note: Only services of same RFIC code can be combined on an EMD-A document. For example, if there are services of RFIC code "A" and "B", two separate EMD documents are needed, issuing all services of "A" and "B" on seperate docs.
1
@SubCode
ATPCO RFIS (ReasonForIssuance Subcode).
Example of RFIS: 0CC
1
@ServiceCode
Additional unique ATPCO code.
0..1 OC
@FareBrand
Service is part of a bundle associated to this fare brand0..1
<SegmentIDRef/>
ID reference used to associate this item to a segment. No comma separated lists and no ranges supported. 0..N F1
<TravelerIDRef/>
Unique association ID reference of the traveler associated to this item. No comma separated lists and no ranges allowed. 0..1 T1
<ReferenceKey/>
Unique reference key. If present in pricing response messages, must be included.0..1
</Service>
</ExcludedServices>
<PricingInfo>
Fare Qualifier group0..N
@FareType
Specifies the type of fare.
PUBL = Published Fare
NEGO = Negotiated / Private Fare
BOTH = Published and Negotiated Fares
[NEGO] [PUBL] [BOTH] 1
@BestPricing
Used to find the best fare available regardless of the class of service requested. Possible values are:
Y = get the best fare available within the same cabin as the class of service specified (for each segment respectively)
C = get the best fare available across all cabin classes (not supported on Sabre and Worldspan)
N = price with classes of service specified for segments

[Y] [C] [N] 0..1 Y
@Cabin
A cabin preference for the complete itinerary. Will only be applied if @BestPricing is set to "C" (cross-cabin best pricing) and ignored otherwise.

Values:
P = Premium First class
F = First class
J = Premium Business class
C = Business class
W = Premium Economy class
Y = Coach class

[P] [F] [J] [C] [W] [Y] 0..1 C
@RequestOptions
Used to request optional services offered by the airline(s) such as (flight, ticket, merchandising) options, e.g. premium seats, in-flight WiFi, baggage charge, etc.

Possible values are:
Y = get PricingOptions if available, otherwise return fare only.

[Y] [N] 0..1 Y
@Images
Used to request images for optional services. To be set by any front end application supporting the display of images returned in a base64 structure.

Possible values are:
Y = get Images (if available)

[Y] [N] 0..1 Y
@ConnectionSelection
Indicates if a connection selection pricing must be applied in Sabre. Possible values are:
- Y: apply connection selection pricing
- N: do not apply connection selection pricing (default)
[Y] [N] 0..1 Y
@AlternateFares
Used to request a list of alternate fares which can have different classes of services and prices because of different restrictions, e.g. refundable or changeable fares which are only a bit more expensive but more flexible. Or fares in business class with more comfort which are cheaper or only a bit more expensive.

Possible values are:
- Y: return alternate fares
- N: return requested fare only (default)
[Y] [N] 0..1
@GetAdditionalRuleInfo
Used to trigger additional requests for all fares to retrieve detailed fare rules, which are used to return additional rule informations e.g. penalty information about refundability or changeability of a fare.

If AlternateFares=Y this can be several additional requests that are send in parallel to the backend system.

Possible values are:
- Y: return additional rule informations
- N: dont return additional rule informations (default)
0..1
@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
<SegmentIDRef>
ID reference used to associate this item to a segment. No comma separated lists and no ranges supported. 0..N F1
@ClassOfService
Can be used to override the ClassOfService in OriginDestination/Flight.

0..1 B
</SegmentIDRef>
<ServiceIDRef>
Allows to price selected (optional) services.

Use the attribute AssociationID of the service element within this message, e.g. "S1"
0..N
</ServiceIDRef>
<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 "RequestOption" 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>
<Restrictions>
Pricing Restriction 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>
<AgencyType>
Agency predefined pricing type code. 0..1 LMG
@QFees
Q Fees. Possible values are: Y = Request Q Fees to be returned N = Do not request Q Fees to be returned. [Y] [N] 0..1 Y
</AgencyType>
<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] [1S] [1V] [1G] [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 group1..N
<Account>
Specifies the corporate account number to use to price private fares. 0..1 PASS
@Code
The Code attribute controls whether fares filed for the specified corporate account should be taken into respect for the pricing *in addition* to other applicable fares or exclusively.

Values are:
N = take fares filed for the specified corporate account into respect *in addition* to other applicable fares (Default)

Y = only take fares into respect filed for the specified corporate account

[Y] [N] 0..1 Y
</Account>
<Contract/>
Specifies the contract code, to use to price private fares. 0..1 00001
</Corporate>
</PrivateFares>
<ReservationsDateTime>
Date/time when the entire booking was reserved. Alternatively this date/time may be set independently for each flight - see ReservationsDateTime element in the Flight element of the OriginDestination element(s).0..1
<Date/>
Specifies date in ISO 8601 format (yyyy-mm-dd). 1 2001-12-25
<Time/>
Specifies time in ISO 8601 twenty-four hour clock format. 0..1 14:00
</ReservationsDateTime>
<HistoricPricingDate>
Date for which a historical pricing is requested. When used for ticket reissue in BSP markets this is commonly the issuance date of the original ticket.0..1
<Date/>
Specifies the date in ISO 8601 format (yyyy-mm-dd). 1 2008-05-02
</HistoricPricingDate>
<AltTicketingDate>
This date stamp specifies a future or historic alternative date validation for ticketing.0..1
<Date/>
Specifies date in ISO 8601 format (yyyy-mm-dd). 1 2001-12-25
</AltTicketingDate>
<DiscountPricing>
Pricing fare basis and discount information1
<DiscountGroup>
Discount pricing group1..N
<SegmentIDRef/>
ID reference used to associate this item to a segment. No comma separated lists and no ranges supported. 0..N F1
<FareBasisCode/>
Fare basis code.
0..1 Y26
<TicketDesignator/>
Ticket designator to price. 0..1 AM10AC
<CurrencyCode>
Currency code. 0..1 USD
@NumberOfDecimals
Decimal position in fare amount. 1 2
</CurrencyCode>
<Discount>
Pricing discount value.
If the CurrencyCode is given and @Type='A', then the Discount must be given as integer (normalized); in this case the decimal point will be set using CurrencyCode/@NumberOfDecimals.

0..1 amount value: 20.00 percent value: 10
@Type
Type of discount.
Values are:
P = Percent
A = Amount
[P] [A] 1 A
</Discount>
</DiscountGroup>
</DiscountPricing>
<ClassifiedFare>
Classified fares group allowing to price using the fare basis code.1
@QFees
Q Fees. Possible values are: Y = Request Q Fees to be returned N = Do not request Q Fees to be returned. [Y] [N] 0..1 Y
<ClassifiedGroup>
Classified fare group1..N
<SegmentIDRef/>
ID reference used to associate this item to a segment. No comma separated lists and no ranges supported. 0..N F1
<FareBasisCode/>
Fare basis code.
1 Y26
<PseudoCityCode/>
Agency's pseudo city code. 0..1 AX49
<TicketDesignator/>
Ticket designator to price. 0..1 AM10AC
</ClassifiedGroup>
</ClassifiedFare>
<NetRemit>
Enter value code/contract agreement code(-s) her for NET REMIT ticketing. Values as printed in the tour code box.0..1
<ValueCode/>
0..1
<ContractCode/>
Also known as Contract Agreement Code (CAR) on some systems.0..1
</NetRemit>
<DirectPricing>
Direct pricing using a fare reference for a particular passenger/segment combination. Only supported in LCC adapter (Non-GDS pricing).1
<Fare>
Up to two one way fares or one round trip fare can be priced together.1..2
<SegmentIDRef/>
ID reference used to associate this item to a segment. No comma separated lists and no ranges supported. 1..N F1
<FareRefKey/>
Unique fare reference key. If present in pricing response messages, must be included in FareRulesRQ.1
</Fare>
</DirectPricing>
<ExemptTax>
Allows the Tax Exempt 0..1
<TaxCode/>
Specifies the Tax codes Example : AY1..N
</ExemptTax>
<ValidatingCarrier/>
Allows to specify the validating carrier for pricing. 0..1 DL
<ResidentDiscount>
This is for support for spanish resident discount.

Only supported in Amadeus.
0..N
<TravelerIDRef/>
Unique association ID reference of the traveler associated to this item. No comma separated lists and no ranges allowed. 0..1 T1
<DiscountCode/>
The fare discount code.1
<IdentificationCardType>
0..1
@Code
1
</IdentificationCardType>
<IdentificationCardNumber/>
0..1
<CheckCode/>
0..1
<PostalCode/>
0..1
<VendorCode/>
Vendor code. 0..1 CS
</ResidentDiscount>
</PricingInfo>
</FlightPriceRQ>

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