New or modified element | To be removed/deprecated | Unique to v2 - Branded Fares | Unique to V1 - Fare Families |
PricedOffer
NAME | DESCRIPTION | FORMAT | ALLOWED/POSSIBLE VALUES |
---|---|---|---|
PricedOffer AttributeOfferID | Id of the Offer | Alphanumeric | Any |
PricedOffer / OfferExpirationDateTime | Offer expiration time limit indicates the time until which the offer is valid. Once the offer has expired a new Shopping flow must be performed as the Offer may have changed. | Date | Any |
PricedOffer / PaymentTimeLimitDateTime | Offer payment time limit (2021-01-28T22:59:59.000Z) is the time by which the Order must be paid for. Any Orders not paid for by the payment time limit will be automatically cancelled. | Date | Any |
<OffersGroup / AirlineOffers / Offer / TimeLimits / OtherLimits / OtherLimit> | |||
PriceGuaranteeTimeLimit AttributeRefs | Due to limits of schema. This attribute points to a Metadata key that contains the PriceGuaranteeTimeLimit | Date | Any |
TicketByTimeLimit / TicketBy | The use of <OtherLimit> forces us to included the TicketByTimeLimit. Please ignore this value which is fictitious. | Date | Any |
<OffersGroup / AirlineOffers / Offer> | |||
TotalPrice / SimpleCurrencyPrice AttributeCode | Three character currency code as per ISO 4217 | Alphabetical | As per ISO 4217 |
<PricedOffer> | |||
OfferItem AttributeOfferItemID AttributeMandatoryInd |
Id of the OfferItem
Boolean identifier for all offer items displaying always true value. |
Alphanumeric
Alphabetical |
Any
True |
OfferItem / TotalPriceDetail / TotalAmount / SimpleCurrencyPrice AttributeCode | Price and currency for the OfferItem | Alphanumeric | Any |
OfferItem / TotalPriceDetail / BaseAmount AttributeCode | Unitary base amount and currency | Alphanumeric | Any |
OfferItem / TotalPriceDetail / Discount / DiscountAmount AttributeCode | Type of currency | Alphabetical | Any |
OfferItem / TotalPriceDetail / Discount / DiscountAmount | Unitary discount amount for each type of passenger included at the fare | Numeric | Any |
OfferItem / TotalPriceDetail / Discount / Application | Application for discount | Alphabetical | Any |
OfferItem / TotalPriceDetail / Discount / Description | Description for discount | Alphanumeric | Any |
OfferItem / TotalPriceDetail / Taxes / Total AttributeCode | Unitary total taxes and amount | Alphanumeric | Any |
OfferItem / Service AttributeServiceID | Id of the Service | Alphanumeric | Any |
OfferItem / Service / PassengerRefs | Passenger Identifier | Alphanumeric | Any |
OfferItem / Service / FlightRefs | Flight Identifier | Alphanumeric | Any |
<PricedOffer / OfferItem / FareDetail> | |||
PassengerRefs | Passenger Identifier | Alphanumeric | Any |
Price / TotalAmount / SimpleCurrencyPrice AttributeCode | Price and currency for the fare and taxes | Alphanumeric | Any |
Price / BaseAmount AttributeCode | Unitary total price and currency without taxes for each passenger included at the fare | Alphanumeric | Any |
Price / Taxes / Total AttributeCode | Sum of all taxes and currency | Alphanumeric | Any |
Price / Taxes / Breakdown / Tax / Amount AttributeCode | Single tax amount and currency | Alphanumeric | Any |
PriceDetail / Taxes / Breakdown / Tax / Nation | Nation for the tax | Alphabetical | Any |
Price / Taxes / Breakdown / Tax / TaxCode | Id of the specified tax | Alphabetical | Any |
PriceDetail / Taxes / Breakdown / Tax / TaxType | Type for the tax | Alphanumeric | Any |
PriceDetail / Taxes / Breakdown / Tax / Description | Description for the tax | Alphanumeric | Any |
FareComponent / FareBasis / CabinType / CabinTypeCode | Code of the cabin | Numeric |
|
FareComponent / FareBasis / CabinType / CabinTypeName | Name of the cabin | Alphabetical | First, Business, , Premium Economy, Economy |
FareDetail / FareComponent / TicketDesig | TicketDesig | Alphabetical | Any (Ex: RCF1) |
FareComponent / FareRules / Penalty AttributeCancelFeeInd | This attribute will indicate whether a cancellation or refund fee will apply.
| Boolean | true/false |
FareComponent / FareRules / Penalty AttributeChangeFeeInd | This attribute will indicate whether a fee will be applied for any voluntary changes.
| Boolean | true/false |
FareComponent / FareRules / Penalty AttributeRefundableInd | This attribute will indicate whether a fare is refundable or not.
| Boolean | true/false |
FareComponent / FareRules / Penalty Attributerefs | Reference of the penalty rule that applies to the fare. | Alphanumeric | Any |
FareComponent / FareRules / Penalty / ApplicableFeeRemarks / Remark | Detailed conditions covering cancellations and changes. | Text | Any |
FareComponent / FareRules / Penalty / Details / Detail Attributerefs | References to detail of penalty
| Alphanumeric | Any |
FareComponent / FareRules / Penalty / Details / Detail / Type | Type of penalty applied | Alphabetical |
|
FareComponent / PriceClassRef | Reference for the PriceClass, associated with the same reference in PriceClassList | Alphanumeric | Any |
FareComponent / SegmentRefs | Reference for the segment | Alphanumeric | Any |
FareDetail / Remarks / Remark | Remark that contains description, type of discount, ticket designator, quantity and currency for special discount | Alphanumeric | Any (Example → DISCOUNT/SD/RC/230.57EUR) |
<PricedOffer / BaggageAllowance> | |||
FlightRefs | Reference for the Flights | Alphanumeric | Any |
PassengerRefs | Reference for the Passengers | Alphanumeric | Any |
BaggageAllowanceRef | Reference for the Baggage | Alphanumeric | Any |
PricedOffer example
PricedOffer - Get Direct Fare
NAME | DESCRIPTION | FORMAT | ALLOWED/POSSIBLE VALUES |
---|---|---|---|
<PricedOffer / OtherOffers> Only for Get Direct Fare | |||
Offer AttributeOfferID | Id for the Offer | Alphanumeric | Any |
Offer AttributeOwner | Marketing airline identification and offer identification | Alphanumeric | Any |
Offer / OfferExpirationDateTime
| Offer expiration time limit indicates the time until which the offer is valid. Once the offer has expired a new Shopping flow must be performed as the Offer may have changed. | Alphanumeric | Any |
Offer / PaymentTimeLimitDateTime | Offer payment time limit (2021-01-28T22:59:59.000Z) is the time by which the Order must be paid for. Any Orders not paid for by the payment time limit will be automatically cancelled. | Alphanumeric | Any |
Offer / TimeLimits / OtherLimits / OtherLimit / PriceGuaranteeTimeLimit AttributeRefs | Due to limits of schema. This attribute points to a Metadata key that contains the PriceGuaranteeTimeLimit | Date | Any |
Offer / TimeLimits / OtherLimits / OtherLimit / TicketByTimeLimit / TicketBy | The use of <OtherLimit> forces us to included the TicketByTimeLimit. Please ignore this value which is fictitious. | Date | Any |
Offer / TotalPrice / SimpleCurrencyPrice AttributeCode | Price and currency for the complete offer | Alphanumeric | Any |
<PricedOffer / OtherOffers / Offer> | |||
OfferItem AttributeOfferItemID | Id of the OfferItem | Alphanumeric | Any |
OfferItem AttributeMandatoryInd | Boolean identifier for all offer items displaying always true value. | Alphabetical |
|
OfferItem / TotalPriceDetail / TotalAmount / SimpleCurrencyPrice AttributeCode | Price and currency for OfferItem | Alphanumeric | Any |
OfferItem / Service AttributeServiceID | Id of the Service | Alphanumeric | Any |
OfferItem / Service / PassengerRefs | Passenger Identifier | Alphanumeric | Any |
OfferItem / Service / FlightRefs | Flight Identifier | Alphanumeric | Any |
OfferItem / FareDetail / PassengerRefs | Passenger Identifier | Alphanumeric | Any |
OfferItem / FareDetail / Price / TotalAmount / SimpleCurrencyPrice AttributeCode | Price and currency for the fare and taxes | Alphanumeric | Any |
OfferItem / FareDetail / Price / BaseAmount AttributeCode | Unitary total price and currency without taxes for each passenger included at the fare | Alphanumeric | Any |
OfferItem / FareDetail / Price / Taxes / Total AttributeCode | Sum of all taxes and currency | Alphanumeric | Any |
OfferItem / FareDetail / Price / Taxes / Breakdown / Tax / Amount AttributeCode | Single tax amount and currency | Alphabetical | Any |
OfferItem / FareDetail / Price / Taxes / Breakdown / Tax / Nation | Nation for the tax | Alphabetical | Any |
OfferItem / FareDetail / Price / Taxes / Breakdown / Tax / TaxCode | Id of the specified tax | Alphanumeric | Any |
OfferItem / FareDetail / Price / Taxes / Breakdown / Tax / TaxType | Type for the tax | Alphanumeric | Any |
OfferItem / FareDetail / Price / Taxes / Breakdown / Tax / Description | Description for the tax | Alphanumeric | Any |
OfferItem / FareDetail / FareComponent / FareRules / Penalty AttributeCancelFeeInd | This indicator will display the following options:
| Boolean | true/false |
OfferItem / FareDetail / FareComponent / FareRules / Penalty AttributeChangeFeeInd | This indicator will display the following options:
| Boolean | true/false |
OfferItem / FareDetail / FareComponent / FareRules / Penalty AttributeRefundableInd | This indicator will display the following options:
| Boolean | true/false |
OfferItem / FareDetail / FareComponent / FareRules / Penalty Attributerefs | Reference of the penalty rule that applies to the fare | Alphanumeric | Any |
OfferItem / FareDetail / FareComponent / PriceClassRef | Reference for the PriceClass, associated with the same reference in PriceClassList | Alphanumeric | Any |
OfferItem / FareDetail / FareComponent / SegmentRefs | Reference for the Segment | Alphanumeric | Any |
OfferItem / BaggageAllowance / FlightRefs | Reference for the Flights | Alphanumeric | Any |
OfferItem / BaggageAllowance / PassengerRefs | Reference for the Passengers | Alphanumeric | Any |
OfferItem / BaggageAllowance / BaggageAllowanceRef | Reference for the Baggage | Alphanumeric | Any |
<OtherOffers> | |||
ALaCarteOffer AttributeOfferID | Id for the Offer | Alphanumeric | Any |
ALaCarteOffer / ALaCarteOfferItem AttributeOfferItemID | Id for the OfferItem | Alphanumeric | Any |
ALaCarteOffer / ALaCarteOfferItem / Eligibility / PassengerRefs | Reference for the Passengers | Alphanumeric | Any |
ALaCarteOffer / ALaCarteOfferItem / Eligibility / SegmentRefs | Reference for the Segment | Alphanumeric | Any |
ALaCarteOffer / ALaCarteOfferItem / UnitPriceDetail / TotalAmount / SimpleCurrencyPrice | Price for the special need | Numeric | Any |
ALaCarteOffer / ALaCarteOfferItem / Service AttributeServiceID | Id for the Service | Alphanumeric | Any |
ALaCarteOffer / ALaCarteOfferItem / Service / ServiceDefinitionRef | Type of special need | Alphabetical | Any |