Versions Compared

Key

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

...

Excerpt
nameOffersGroup

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

<OffersGroup>

AirlineOffers

List of available AirlineOffers.

List

Any

<OffersGroup / AirlineOffers>

Info

Attribute

Offer@OfferID

Id ID of a returned offer

Alphanumeric

Any (36 characters)

Info

Attribute

Offer@Owner

Owner of the Offer

Alphanumeric

IB

Info

Attribute

Offer@RequestedDateInd

Mandatory attribute indicating whether the Offer is for the dates requested or not.

Boolean

True / False

<OffersGroup / AirlineOffers / Offer>

OfferExpirationDateTime

Offer expiration time limit indicates the time until which the offers are valid. Once expired a new Shopping flow must be performed as the Offers may have changed.

Date

Any

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. (Do not apply in cheapest flow)

Date

Any

<OffersGroup / AirlineOffers / Offer / TimeLimits / OtherLimits / OtherLimit>

Date sate for payment deadline before offers expires
Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#ABF5D1

Attribute

TimeLimits@OtherLimits

Time to Price Guarantee Time Limit

Date

Any

PriceGuaranteeTimeLimit

PriceGuaranteeTimeLimit@Refs

Due to limits of schema. This attribute points to a Metadata key that contains the PriceGuaranteeTimeLimit

Date

Any

TicketByTimeLimit / TicketBy

Generic Ticket that The use of <OtherLimit> forces us to enter by default in the schema to set the Price Guarantee Time Limitincluded the TicketByTimeLimit. Please ignore this value which is ficticious.

Date

Any

<OffersGroup / AirlineOffers / Offer>

TotalPrice

Info

Attribute

SimpleCurrencyPrice@Code

Type of currencyThree character currency code as per ISO 4217

AlphabeticalAny

As per ISO 4217

TotalPrice / SimpleCurrencyPrice

Full price for Total base fare (excluding taxes) amount for all passangers associated to the offer

Numeric

Any

FlightsOverview

Info

Attribute

FlightRef@ODRef

Reference to the DataLists / OriginDestinationList

Alphanumeric

Default format: ODX (X → Number digit)

Any (Default format example: OD1)

FlightsOverview

Info

Attribute

FlightRef@PriceClassRef

Price Class identificator key:

  • Branded Fare example → BUSFLEXp8eGI8Gt

Alphanumeric

Any

FlightsOverview / FlightRef

Reference for the flight. The value refers to to the FlightKey in the FlightList list.FLXX (XX → Number digits)

Alphanumeric

Any (Example: FL11)

Info

Attribute

OfferItem@OfferItemID

Id for OfferItem. There may or may not be one OfferItem for each type of passenger in the offer depending on the Fare details.

Alphanumeric

Any

<OffersGroup / AirlineOffers / Offer / OfferItem>

TotalPriceDetail / TotalAmount

Info

Attribute

SimpleCurrencyPrice@Code

The total fare amount for the passengers associated to the OfferItem including taxes.

Numeric for the amount.

Alphabetical for the currency code.

Any

TotalPriceDetail / BaseAmount

Info

Attribute

Code

The total base fare amount for the passengers associated to the OfferItem excluding taxes.

Numeric for the amount.

Alphabetical for the currency code.

Any

TotalPriceDetail / Discount / DiscountAmount

Info

Attribute

Code

The amount discounted from the base amount for all passengers associated to the OfferItem.

Numeric for the amount.

Alphabetical for the currency code.

Any

TotalPriceDetail / Discount / Application

The name of the discount applied.

See allowed/possible values.

Alphabetical

See:

Spanish Resident Discount

Spanish Large Family Discount

TotalPriceDetail / Taxes / Total

Info

Attribute

Code

Total amount of taxes for all passengers associated to the OfferItem.

Numeric for the amount.

Alphabetical for the currency code.

Any

Service

Info

Attribute

ServiceID

Flight service identification

This reference is displayed sorted by flight hour and date.

Alphanumeric

Any

Service / PassengerRefs

References of the passengers for whom the service applies.

Alphanumeric

Any

Service / FlightRefs

References of the flights for which the service applies.

FLXX (XX → Number digits)

Any (Example: FL11)

FareDetail / PassengerRefs

References of the passengers to whom the fare detail applies.

Alphanumeric

Any

FareDetail / Price / TotalAmount / SimpleCurrencyPrice

Info

Attribute

Code

The total price (base fare + taxes) for each passenger included in the OfferItem together with the currency code.

Numeric for the amount.

Alphabetical for the currency code.

Any

FareDetail / Price / BaseAmount

Info

Attribute

Code

The base fare amount for each passenger associated to the OfferItem.

Numeric for the amount.

Alphabetical for the currency code.

Any

FareDetail / Price / Taxes / Total

Info

Attribute

Code

Total tax amount for each passenger associated to the OfferItem.

Alphabetical

Any

FareDetail / FareComponent / FareBasis / FareBasisCode / Code

The fare basis code that identifies the type of fare.

Alphanumeric

Any (Ex: SDL0NOM6)

FareDetail / FareComponent / FareBasis / CabinType / CabinTypeCode

Code of the cabin

If we have more than one segment per FareComponent with different CabinTypeCode, the one with the highest category or the one with the lowest number is shown.

Numeric

1 = First
2 = Business
4 = Premium Economy
5 = Economy

FareDetail / FareComponent / FareBasis / CabinType / CabinTypeName

Name of the cabin

Alphabetical

First, Business, , Premium Economy, Economy

FareDetail / FareComponent / TicketDesig

TicketDesig

Alphabetical

Any (Ex: RCF1)

FareDetail / FareComponent / FareRules / Penalty

Info

Attribute

CancelFeeInd

 

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

Boolean

true/false

FareDetail / FareComponent / FareRules / Penalty

Info

Attribute

ChangeFeeInd

 

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

Boolean

true/false

FareDetail / FareComponent / FareRules / Penalty

Info

Attribute

RefundableInd

 

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

Boolean

true/false

FareDetail / FareComponent / PriceClassRef

Reference to DataList / PriceClassList

Alphabetical

Any

FareDetail / FareComponent / SegmentRefs

Reference to the segments for which this fare component applies.

Alphanumeric

Any (Ex: Example → IB343620200216MADORY)

FareDetail / Remarks / Remark

Remark used today to give information about the ‘DISCOUNT’ applied.

Today this is used for the “SD“ (Spanish Discount), identified by the code in the third element of the remark, which can be found in our Spanish Resident Discount and Spanish Large Family Discount pages.

Alphanumeric

DISCOUNT/SD/xx/###

xx = Discount code

###= Discount amount with the applicable currency

Example → DISCOUNT/SD/RC/230.57EUR

<OffersGroup / AirlineOffers / Offer / BaggageAllowance>

FlightRefs

Reference to the Flights for the Baggage allowance applicable for this Offer.

Alphanumeric

Any

PassengerRefs

Reference to the passengers for the Baggage allowance applicable for this Offer.

Alphanumeric

Any

BaggageAllowanceRef

Reference to the Baggage allowance information applicable to this Offer.

Alphanumeric

Any

...