Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Excerpt
namePricedOffer
<PricedOffer>

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

PricedOffer

Info

Attribute

PricedOffer@OfferIDOfferID

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

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#ABF5D1

Attribute

PriceGuaranteeTimeLimit@RefsRefs

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 ficticiousfictitious.

Date

Any

<OffersGroup / AirlineOffers / Offer>

TotalPrice / SimpleCurrencyPrice

Info

Attribute

SimpleCurrencyPrice@CodeCode

Three character currency code as per ISO 4217

Alphabetical

As per ISO 4217

<PricedOffer / OfferItem><PricedOffer>

OfferItem

OfferItem
Info

Attribute

OfferItem@OfferItemID

Id of the OfferItem

Alphanumeric

Any

OfferItemID

Info

Attribute

MandatoryInd

Id of the OfferItem

@MandatoryInd

Boolean identifier for all offer items displaying always true always true value.

Alphanumeric

Alphabetical

Any

True

OfferItem / TotalPriceDetail / TotalAmount / SimpleCurrencyPrice

Info

Attribute

SimpleCurrencyPrice@CodeCode

Price and currency for the OfferItem

Alphanumeric

Any

OfferItem / TotalPriceDetail / BaseAmount

Info

Attribute

BaseAmount@CodeCode

Unitary base amount and currency

Alphanumeric

Any

OfferItem / TotalPriceDetail / Discount / DiscountAmount

Info

Attribute

DiscountAmount@CodeCode

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

Info

Attribute

Total@CodeCode

Unitary total taxes and amount

Alphanumeric

Any

OfferItem / Service

Info

Attribute

Service@ServiceIDServiceID

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

Info

Attribute

SimpleCurrencyPrice@CodeCode

Price and currency for the fare and taxes

Alphanumeric

Any

Price / BaseAmount

Info

Attribute

BaseAmount@CodeCode

Unitary total price and currency without taxes for each passenger included at the fare

Alphanumeric

Any

Price / Taxes / Total

Info

Attribute

Total@CodeCode

Sum of all taxes and currency

Alphanumeric

Any

Price / Taxes / Breakdown / Tax / Amount

Info

Attribute

Amount@CodeCode

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

  • 1 = First

  • 2 = Business

  • 4 = Premium Economy

  • 5 = Economy

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

Info

Attribute

Penalty@CancelFeeIndCancelFeeInd

This attribute will indicate whether a cancellation or refund fee will apply.

Boolean

true/false

FareComponent / FareRules / Penalty

Info

Attribute

Penalty@ChangeFeeIndChangeFeeInd

This attribute will indicate whether a fee will be applied for any voluntary changes.

Boolean

true/false

FareComponent / FareRules / Penalty

Info

Attribute

Penalty@RefundableIndRefundableInd

This attribute will indicate whether a fare is refundable or not.

Boolean

true/false

FareComponent / FareRules / Penalty

Info

Attribute

Penalty@refsrefs

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

Info

Attribute

Detail@refsrefs

References to detail of penalty

  • Example: refs = “METADATAKEY_1”

Alphanumeric

Any

FareComponent / FareRules / Penalty / Details / Detail / Type

Type of penalty applied

Alphabetical

  • Cancel

  • Change

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

...

Excerpt
namePricedOfferGetDirectFare

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

<PricedOffer / OtherOffers / Offer> Only OtherOffers> Only for Get Direct Fare

Offer

Info

Attribute

Offer@OfferIDOfferID

Id for the Offer

Alphanumeric

Any

Offer

Info

Attribute

Offer@OwnerOwner

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 / TotalPrice / SimpleCurrencyPrice

Info

Attribute

SimpleCurrencyPrice@CodeCode

Price and currency for the complete offer

Alphanumeric

Any

<PricedOffer / OtherOffers / Offer / OfferItem>Offer>

OfferItem

Info

Attribute

OfferItem@OfferItemIDOfferItemID

Id of the OfferItem

Alphanumeric

Any

OfferItem

Info

Attribute

OfferItem@MandatoryIndMandatoryInd

Boolean identifier for all offer items displaying always true value.

Alphabetical

  • True

OfferItem / TotalPriceDetail / TotalAmount / SimpleCurrencyPrice

Info

Attribute

SimpleCurrencyPrice@CodeCode

Price and currency for OfferItem

Alphanumeric

Any

OfferItem / Service

Info

Attribute

Service@ServiceIDServiceID

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

Info

Attribute

SimpleCurrencyPrice@CodeCode

Price and currency for the fare and taxes

Alphanumeric

Any

OfferItem / FareDetail / Price / BaseAmount

Info

Attribute

BaseAmount@CodeCode

Unitary total price and currency without taxes for each passenger included at the fare

Alphanumeric

Any

OfferItem / FareDetail / Price / Taxes / Total

Info

Attribute

Total@CodeCode

Sum of all taxes and currency

Alphanumeric

Any

OfferItem / FareDetail / Price / Taxes / Breakdown / Tax / Amount

Info

Attribute

Amount@CodeCode

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

Info

Attribute

Penalty@CancelFeeIndCancelFeeInd

This indicator will display the following options:

  • "true" → This fare will have cancellation and refund fee

  • "false" → This fare will not have cancellation and refund fee

Boolean

true/false

OfferItem / FareDetail / FareComponent / FareRules / Penalty

Info

Attribute

Penalty@ChangeFeeIndChangeFeeInd

This indicator will display the following options:

  • "true" → This fare will have change fee

  • "false" →This fare will not have change fee

Boolean

true/false

OfferItem / FareDetail / FareComponent / FareRules / Penalty

Info

Attribute

Penalty@RefundableIndRefundableInd

This indicator will display the following options:

  • "false" → This fare will not be refundable

  • "true" → This fare will be refundable

Boolean

true/false

OfferItem / FareDetail / FareComponent / FareRules / Penalty

Info

Attribute

Penalty@refsrefs

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><OtherOffers>

ALaCarteOffer

Info

Attribute

ALaCarteOffer@OfferIDOfferID

Id for the Offer

Alphanumeric

Any

ALaCarteOffer / ALaCarteOfferItem

Info

Attribute

ALaCarteOfferItem@OfferItemIDOfferItemID

Id for the OfferItem

Alphanumeric

Any

ALaCarteOffer /  ALaCarteOfferItem ALaCarteOfferItem / Eligibility / PassengerRefs

Reference for the Passengers

Alphanumeric

Any

ALaCarteOffer /  ALaCarteOfferItem ALaCarteOfferItem / Eligibility / SegmentRefs

Reference for the Segment

Alphanumeric

Any

ALaCarteOffer /  ALaCarteOfferItem ALaCarteOfferItem / UnitPriceDetail / TotalAmount / SimpleCurrencyPrice

Price for the special need

Numeric

Any

ALaCarteOffer /  ALaCarteOfferItemALaCarteOfferItem / Service

Info

Attribute

Service@ServiceIDServiceID

Id for the Service

Alphanumeric

Any

ALaCarteOffer /  ALaCarteOfferItem ALaCarteOfferItem / Service / ServiceDefinitionRef

Type of special need

Alphabetical

Any

...