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.
| Node | Description | Values | Occurs | Example |
|---|---|---|---|---|
<FlightPriceRQ> | Flight price request root element | 1 | ||
@version | Version number. | 0..1 | 1.0 | |
@QueryID | Optional, alphanumeric. Used only for internal tracking purposes. | 0..1 | ||
@Lang | ISO language code. A two letter code as defined by ISO-639-1. This code specifies the requested language for text content. Default value is 'en'. | 0..1 | ||
<SaleInfo> | Sale Information group | 0..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 group | 0..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> | ||||
<CLID> | 0..N | |||
<CLIDCompanyCode> | Airline code of the program/ membership sponsoring airline. | 1 | ||
</CLIDCompanyCode> | ||||
<CLIDNumber/> | CorporateID. | 1 | C900395168859 | |
<CLIDStatus/> | CLID level for this member as provided by airline's database. | 0..1 | ||
</CLID> | ||||
</TravelerIDs> | ||||
<OriginDestination> | Origin and Destination group | 1..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 group | 1..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 If type is set to O (Open segment) then departure date/time, arrival date/time and flight number are optional. F = Flown (for pricing only) | [P] [O] [F] | 0..1 | P |
@SellIndicator | Internal sell indicator used to identify segment grouping listed in a fare search response recommendation. If present in the response must be used as-is in PNRCreateRQ request for air sell. See PNRCreateRQ/CompletePNRElements/Itinerary/Flight. | 0..1 | ||
<AirlineCode/> | Airline Code. | 1 | DL | |
<FlightNumber> | Flight number - an integer value within the range of [0,9999]. | 0..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 | |
<Equipment> | Equipment group | 0..1 | ||
<Code/> | Error code or equipment type code. | 1 | 0104 (error code), 747 (equipment code) | |
<Name/> | Airplane type name. | 1 | Boeing 747 series | |
</Equipment> | ||||
<Departure> | Departure Information group | 1 | ||
<AirportCode/> | Origin or destination Airport Code. | 1 | MIA | |
<Date/> | Specifies departure date in ISO 8601 format (yyyy-mm-dd). | 0..1 | 2001-12-25 | |
<Time/> | Departure time in ISO 8601 twenty-four hour clock format. | 0..1 | 14:00 | |
</Departure> | ||||
<Arrival> | Arrival Information group | 1 | ||
<AirportCode/> | Origin or destination Airport Code. | 1 | MIA | |
<Date/> | Specifies arrival date in ISO 8601 format (yyyy-mm-dd). | 0..1 | 2001-12-25 | |
<Time/> | Arrival time in ISO 8601 twenty-four hour clock format. | 0..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 group | 0..1 | ||
<Service> | Service Details | 1..N | ||
@AssociationID | Unique ID used to associate to this element at PNR creation time. | 1 | S1 | |
@Method | Values are: F = FareIntegrated EA = EMD Associated ES = EMD Standalone MA = Flight Associated but settled via MCO MS = Standalone but settle via MCO D = DirectSettlement | [F] [EA] [MA] [ES] [MS] [D] | 0..1 | |
@Airline | This is the airline code of the Marketing carrier, the carrier actually offering the service. | 1 | ||
@TypeValue | EMD Type Value as defined by ATPCO 1 = Standalone 2 = Associated to a flight 3 = Standalone associated to a ticket (but not flight) 4 = no EMD, carrier directed type 5 = E-Ticket | 0..1 | ||
@SaleStatus | Allowed Values: "Offered" "Pending" "Booked" "Issued" "Canceled" "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 | [Offered] [Booked] [Issued] [Pending] [Canceled] | 0..1 | |
@ServiceType | The ATPCO defined code for the type of service (also referred to as 'Flight/Ticket/Merchandise Byte 21)': F = Flight (TypeValue=2) R = Rule Buster (Type Value = 5) T = Ticket (TypeValue=3 if EMD-S is issued, 4 if other) M = Merchandise (TypeValue=1 if EMD-S is issued, 4 if other) | 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. A = Air Transportation B = Surface Transportation/Non Air services C = Baggage D = Financial Impact E = Airport Services F = Merchandise G = in-flight Services I = Individual Airline Use | 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 brand | 0..1 | ||
@Status | Values are: NN = "Requested" HK = "Confirmed" | [NN] [HK] | 0..1 | |
@DealID | This ID represents an airline promotion for a special target market and applies only for FQTV numbers identified for this promotion | 0..1 | ||
@Type | Indicator if this option is a discount or a surcharge; Values are: "Discount" 1) "Surcharge" "Included" 2) "Not applicable" 3) 1) only applicable when using methof F, applying option directly to a fare (not used in an EMD solution) 2) This item is free of charge due to FQTV status or chosen Price Class 3) This item is not available/applicable due to FQTV status or chosen Price Class. Sample: Earning extra miles may only be allowed for a Top tier FQTV status and is not applicable for any other traveler. | [Discount] [Surcharge] [Included] [Not applicable] | 0..1 | |
@FQTVAirline | The 2-character airline code of the Frequent Flyer membership | 0..1 | AA | |
@FQTVStatus | The status (tier level) of the traveler's FQTV account. This is available as a query results against the airline's FQTV database. Samples: AA(American AAdvantage): -- Gold -- Platinum -- Executive Platinum LH (Miles and More): -- Frequent Traveller -- Senator -- HON Circle EK (Emirates Skywards): -- Silver -- Gold | 0..1 | ||
@FQTVNumber | This is the actual FrequentFlyer number associated to the FQTVStatus. This will allow the POS GUI to associate the actual traveler with the respective option/price | 0..1 | ||
@NotValidBefore | Option is not available/usable until the date entered | 0..1 | ||
@NotValidAfter | Option is not available/usable after the date entered | 0..1 | ||
@Slice | In case of a "Change Of Gauge" flight, this determines to which slice of the flight the option belongs. Default = 0 (or absence) | 0..1 | YY 465 SFO FRA with change of gauge in ORD Slice 0 = SFO to ORD Slice 1 = ORD to FRA | |
@IconID | Any icon ID associated to this service. The icon ID will be used by the UI to retrieve respective icon image. | 0..1 | MEALS | |
@CanDeselect | Any service tagged with a "Y" setting here can be deselected. This attribute is set by the merchandizing engine for services which are typically included in a Price Class or CoS but may not be desired by the traveler, e.g. Premium Drinks on the flight. Allowed value: "Y" | [Y] | 0..1 | |
@MaxQuantity | Will determine what the maximum number can be for the Quantity. | 0..1 | 5 | |
@Quantity | This attribute provides how many service/items of the same type have been ordered, 1 being the default. | 0..1 | 3 | |
@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. | |
<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 offered service. | 0..1 | "3rd Bag Fee" UI tip: You may build a one line description to display by stringing the following values together: "Description"+"ServiceLocation"+"ServiceDate"+"DescriptionVariable" which could be displayed as sampled here: 'Airline Lounge Pass DFW 10May' where 'Airline Lounge Pass' is the "Description", 'DFW' the "ServiceLocation" and '10May' the "ServiceDate" or Premium Seat 9D where 'Premium Seat' is the "Description" and '9D' the "DescriptionVariable" | |
<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 | ||
<DescriptionDetails> | Detailed description of this service | 0..1 | ||
<Text/> | 1..N | |||
</DescriptionDetails> | ||||
<Amount/> | Total price for the chosen quantity of this option (or option differential in case of upsell). This node is a string showing the value with decimal point (not linked to a currency code). Sample: 25.50 | 0..1 | ||
<ServicePrice> | Price for this service; not to be used for 'included' options (no charge options) This node uses the Currency/Decimals of the FareGroup root level | 0..1 | ||
@Total | Total amount for the chosen quantity of this service. Total = base price + total amount of taxes. | 1 | 7500 | |
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<BasePrice> | Base (net) price of Service | 1 | ||
@Amount | Net price of service | 1 | 6750 | |
</BasePrice> | ||||
<Taxes> | Tax Group | 0..1 | ||
@Amount | Total taxes amount. | 1 | 750 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 250 | |
<Designator/> | Tax or surcharge designator. | 0..1 | US | |
<Description/> | Tax or surcharge description. | 0..1 | US national transportation | |
</Tax> | ||||
</Taxes> | ||||
<ItemPrice> | Recommended to provide at all times, however if quantity is greater than 1 ItemPrice is mandatory | 0..1 | ||
@Total | Total amount for this service based on FQTV status and chosen Price Class. Total = base price + total amount of taxes. | 1 | 7500 | |
<BasePrice> | Base (net) price of Option | 1 | ||
@Amount | Net price of option. | 1 | 6750 | |
</BasePrice> | ||||
<Taxes> | Tax Group | 0..1 | ||
@Amount | Total taxes amount. | 1 | 750 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 250 | |
<Designator/> | Tax or surcharge designator. | 1 | US | |
<Description/> | Tax or surcharge description. | 0..1 | US national transportation | |
</Tax> | ||||
</Taxes> | ||||
</ItemPrice> | ||||
</ServicePrice> | ||||
<TicketByDate/> | Ticket by date in ISO 8601 (yyyy-mm-dd) format. | 0..1 | 2001-12-25 | |
<Penalties> | Option Penalty group | 0..1 | ||
@Refundable | Indicates if option is refundable. Values are: Y = Option refundable N = Option not refundable | [Y] [N] | 0..1 | Y |
@Reusable | Indicates if option is reusable. Values are: Y = Funds are reusable N = Funds are not reusable (default) | [Y] [N] | 0..1 | Y |
<Change> | Change penalty group | 0..1 | ||
@Application | Penalty application type. Examples: AFTER_DEP (After departure) NO_SHOW (No show) PRIOR_DEP (Prior to departure) | [PRIOR_DEP] [AFTER_DEP] [NO_SHOW] | 0..1 | |
@Total | Total Change fee Taxes + Total Change Fee amount | 0..1 | ||
<Amount> | Penalty amount in currency amount or percentage. | 0..2 | 7500 | |
@Unit | Penalty amount unit. Possible values are: M = currency money value P = percentage | [M] [P] | 1 | M |
@MinMax | Minimum or maximum penalty indicator. | [MIN] [MAX] | 0..1 | MIN (MINIMUM PENALTY AMOUNT) MAX MAXIMUM PENALTY AMOUNT) |
</Amount> | ||||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
<Taxes> | Taxes group | 0..1 | ||
@Amount | Total taxes amount. | 1 | 50000 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 6500 | |
@Refundable | Indicates if tax is refundable. Values are: Y = Tax refundable (default) N = Tax not refundable | [Y] [N] | 0..1 | N |
@Paid | Indicates the payment status of the tax. PD=Paid, RF=refunded | [PD] [RF] | 0..1 | |
<Designator/> | Tax designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax description. | 0..1 | US international transportation | |
<CollectionPoint> | For XF and ZP taxes: Tax data break down per collection point. The sum of amounts for all collection points may differ slighty from the Tax/@Amount in cases were the collection point amounts were converted from a different currency. NOTE: this definition will eventually supercede the Calculation element. Use this group instead of Calculation as Calculation will be deprecated in near future. | 0..N | ||
@Amount | Individual amount for collection point. | 0..1 | 2500 | |
<AirportCode/> | Origin or destination Airport Code. | 1 | MIA | |
</CollectionPoint> | ||||
</Tax> | ||||
</Taxes> | ||||
</Change> | ||||
<Cancel> | Cancel penalty group | 0..1 | ||
@Application | Penalty application type. Examples: AFTER_DEP (After departure) NO_SHOW (No show) PRIOR_DEP (Prior to departure) | [PRIOR_DEP] [AFTER_DEP] [NO_SHOW] | 0..1 | |
@Total | Total Change fee Taxes + Total Change Fee amount | 0..1 | ||
<Amount> | Penalty amount in currency amount or percentage. | 0..2 | 7500 | |
@Unit | Penalty amount unit. Possible values are: M = currency money value P = percentage | [M] [P] | 1 | M |
@MinMax | Minimum or maximum penalty indicator. | [MIN] [MAX] | 0..1 | MIN (MINIMUM PENALTY AMOUNT) MAX MAXIMUM PENALTY AMOUNT) |
</Amount> | ||||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
<Taxes> | Taxes group | 0..1 | ||
@Amount | Total taxes amount. | 1 | 50000 | |
<Tax> | Tax break down information group | 0..N | ||
@Amount | Individual tax amount. | 1 | 6500 | |
@Refundable | Indicates if tax is refundable. Values are: Y = Tax refundable (default) N = Tax not refundable | [Y] [N] | 0..1 | N |
@Paid | Indicates the payment status of the tax. PD=Paid, RF=refunded | [PD] [RF] | 0..1 | |
<Designator/> | Tax designator. | 0..1 | US | |
<Nature/> | Tax nature. | 0..1 | US2 | |
<Description/> | Tax description. | 0..1 | US international transportation | |
<CollectionPoint> | For XF and ZP taxes: Tax data break down per collection point. The sum of amounts for all collection points may differ slighty from the Tax/@Amount in cases were the collection point amounts were converted from a different currency. NOTE: this definition will eventually supercede the Calculation element. Use this group instead of Calculation as Calculation will be deprecated in near future. | 0..N | ||
@Amount | Individual amount for collection point. | 0..1 | 2500 | |
<AirportCode/> | Origin or destination Airport Code. | 1 | MIA | |
</CollectionPoint> | ||||
</Tax> | ||||
</Taxes> | ||||
</Cancel> | ||||
</Penalties> | ||||
<Commission> | Commission amount or percentage for this option | 0..1 | ||
@Type | Commission type. Values are: P = Percent, A = Amount | [P] [A] | 1 | A |
</Commission> | ||||
<Endorsement> | Endorsements for this service. | 0..N | NONREF | |
<Text/> | Endorsement text. | 1 | ||
</Endorsement> | ||||
<ValidatingCarrier/> | Validating carrier code. Standard IATA 2-letter alphanumeric code. Allows to override the Validating Carrier assigned to the entire FareGroup | 0..1 | AF | |
<ReferenceKey/> | Unique reference key. If present in pricing response messages, must be included. | 0..1 | ||
<Attributes> | ATPCO S5 record attributes | 0..1 | ||
<Group> | Sample codes: 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 WF = WiFi | 1 | ||
<Code/> | 1 | |||
<Text/> | 0..1 | |||
</Group> | ||||
<SubGroup> | Sample codes for group "BG": CT = Container PP = Pre-paid excess baggage Sample codes for group "GT": BU = Bus LI = Limo, etc Sample codes for group "IE": IT = Internet access TV = Television, etc | 0..1 | ||
<Code/> | 1 | |||
<Text/> | 0..1 | |||
</SubGroup> | ||||
<Desc1> | Description codes. Examples: 05 = up to 5 kg 1Y = One Year AI = Aisle B1 = First Bag etc. | 0..1 | ||
<Code/> | 1 | |||
<Text/> | 0..1 | |||
</Desc1> | ||||
<Desc2> | Description codes. Examples: HT = Hot KO = Kosher etc. | 0..1 | ||
<Code/> | 1 | |||
<Text/> | 0..1 | |||
</Desc2> | ||||
</Attributes> | ||||
<BookingInstructions> | Contains instructions how to book this service with respective source | 0..1 | ||
<SSRCode/> | Special service request code. IATA standard. | 0..N | VGML | |
<OSIText/> | 0..N | |||
<UpgradeMethod> | Allowed Values: A = AutoUpgrade S = SSR request | 0..1 | ||
@NewClass | Instructs which new class to book | 0..1 | ||
</UpgradeMethod> | ||||
<Text/> | Any freeflow to instruct DC | 0..N | ||
</BookingInstructions> | ||||
<InstantPurchase/> | Instant Purchase indicator. CC = Purchase is immediately charged to CC AP = Purchase is using AirPass credit(s) PP = Purchase is charged via PayPal N = Not an instant purchase TT = Purchase is immediate after Ticketing time AU = EMD will be automatically issued without sending EMDIssueRQ | [CC] [AP] [PP] [N] [TT] [AU] | 0..1 | TT |
</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 details | 1..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. A = Air Transportation B = Surface Transportation/Non Air services C = Baggage D = Financial Impact E = Airport Services F = Merchandise G = in-flight Services I = Individual Airline Use | 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 brand | 0..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 group | 0..N | ||
@FareType | Specifies the type of fares to use for pricing. Values: PUBL = published fares NEGO = negotiated/private Fares BOTH = published and negotiated/private fares If no PricingInfo is specified, the FareType defaults to BOTH. | [NEGO] [PUBL] [BOTH] | 1 | PUBL |
@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) L = get the lowest possible (not necessarily available) fare within the same cabin as the class of service specified (for each segment respectively) LC = get the lowest possible (not necessarily available) fare across all cabin classes N = price with classes of service specified for segments | [Y] [C] [N] [L] [LC] | 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 |
@CabinSpecific | @CabinSpecific is only relevant in combination with @BestPricing="C" and @Cabin. When @CabinSpecific is set to "N" and there is no fare availble which matches the requested cabin for all segments, return the best available fare where at least a subset of the segments has the requested cabin. If left out, @CabinSpecific defaults to "Y": only accept fares which which have requested cabin for all segments. Values: Y = Yes N = No Default: Y | [Y] [N] | 0..1 | N |
@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 | This attribute controls whether to use additional transactions to obtain detailed fare rule information, e.g. for refundability or changeability and corresponding penalties for all fares that stem from this PricingInfo. This can cause several additional requests being sent to the backend system. Values are: - Y: Return additional rule information, only use services that are free of charge. - C: Return additional rule information, use value added fare rule services that are chargeable if offered by provider. (Only supported for Amadeus where this option will invoke Amadeus MiniRules). - N: dont return additional rule informations (default). | [Y] [C] [N] | 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 |
@version | Only supported in multi-source contexts: Specifes version of FlightPrice to apply when this PricingInfo is processed by the XX/1 adapter for the source to which this PricingInfo refers. | 0..1 | CombineOneWay | |
@FareFamilyInfo | Display Fare Family Information. Values are: Y = Yes N = No | [Y] [N] | 0..1 | |
@FareFamilyUpsell | Display Fare Family Upsells. Values are: Y = Yes N = No | [Y] [N] | 0..1 | |
<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 group | 0..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 specified, returned fares may or may not be refundable depending on the other Restrictions settings. | [Y] [N] | 0..1 | Y |
@Changeable | Y = Return changeable fares only N = Return non-changeable fares only Default: If not specified, returned fares may or may not be changeable depending on the other Restrictions settings. | [Y] [N] | 0..1 | Y |
</Restrictions> | ||||
<PricingCurrency/> | Desired currency override for pricing only (not ticketing) | 0..1 | EUR | |
<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) group | 0..1 | ||
<Office> | Pseudo city under which private fares are stored. | 1 | 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 F1 = Farelogix ACH = Travelport Airline Content Hub (uAPI) | [1A] [1B] [1G] [1P] [1S] [1U] [1V] [1W] [F1] [XS] [ACH] | 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 | 0..N | ||
<AirlineCode/> | Airline code. | 0..1 | AA | |
<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 information | 1 | ||
<DiscountGroup> | Discount pricing group | 1..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: 200 percent value: 5.5 | |
@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..N | ||
@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 |
<TravelerIDRef/> | Unique association ID reference of the traveler associated to this item. No comma separated lists and no ranges allowed. | 0..N | T1 | |
<ClassifiedGroup> | Classified fare group | 1..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. | 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..N | ||
<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> | ||||
<PriceClass> | 1..N | |||
@PriceClassCode | Code of the price class. | 0..1 | 3 | |
@PriceClassName | Marketing name of the price class. | 0..1 | TANGO | |
<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..N | T1 | |
</PriceClass> | ||||
<ExemptTax> | Allows the Tax Exempt | 0..1 | ||
<TaxCode/> | Specifies the Tax codes Example : AY | 1..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> | ||||
<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. The following list of normalized credit card codes is currently supported by XX/1. AX .. American Express AXB .. American Express BTA AXI .. American Express IBTA CA .. MasterCard CAD .. MasterCard Debit CB .. Carte Blanche DC .. Diners Club DS .. Discover JC .. Japan Credit Bureau (JCB) MA .. Maestro TP .. Air Plus VI .. Visa Credit VID .. Visa Debit VIL .. Visa Delta VIE .. Visa Electron | 1 | VI | |
<CCNumber/> | Credit card number. | 0..1 | 4011236654652341 Can be returned encrypted by GDS/CRS. Example: XXXXXXXXXXXXXXXX | |
<CCExpiration> | Credit card expiration group | 0..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> | ||||
<BaggageAllowance> | Allows to specify whether only fares which include free checked bags are requested. | 0..1 | ||
@MinPieces | Minimum number of bags included. Values 1 (Default if left out) 2 3 If a value >1 is specified for a CRS which only supports value 1, 1 will automatically be used instead of the value specified. | [1] to [3] | 0..1 | 1 |
</BaggageAllowance> | ||||
</PricingInfo> | ||||
</FlightPriceRQ> |
| Column | Description |
|---|---|
| Node | Name 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. |
| Description | Description of meaning and usage of the node. |
| Values | List of predefined values (each in square brackets) or range of values ("[a] to [z]") allowed for the node, if formally defined in the schema. |
| Occurs | Minimum 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. |
| Example | Example value for the node. |
XML Schema documentation generated with XX/1 server