New or modified element | To be removed/deprecated | Unique to v2 - Branded Fares | Unique to V1 - Fare Families |
ReshopOffer
NAME | DESCRIPTION | FORMAT | ALLOWED/POSSIBLE VALUES |
---|---|---|---|
<ReshopOffers> | |||
ReshopOffer AttributeOfferID AttributeOwner AttributeRequestedDateInd | Id of the offer Airline Owner Identifies if another dates are offered | Alphanumeric Alphabetical Alphabetical | Any “IB”
|
ReshopOffer / OfferExpirationDateTime | Offer expiration time limit indicates the time until which the offer is valid. Once the offer has expired a new OrderReshop should be performed as the Offer may have changed | Alphanumeric (UTC) | Any |
ReshopOffer / 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 (UTC) | 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 ficticious. | Date | Any |
<OffersGroup / AirlineOffers / Offer> | |||
TotalPrice / SimpleCurrencyPrice AttributeCode | This field will display a value for all passengers of the booking:
| Alphanumeric | Any |
FlightsOverview / FlightRef | Reference for the flight. The value refers to the FlightList list. | FLXX (XX → Number digits) | Any (Example: FL11) |
FlightsOverview / FlightRef AttributeODRef | Origin and destination identification Reference to the DataLists / OriginDestinationList | Alphanumeric Default format: ODX (X → Number digit) | Any (Default format example: OD1) |
FlightsOverview / FlightRef AttributePriceClassRef | Price Class identifier key:
| Alphanumeric | Any |
ReshopOffers example
DeleteOfferItem
NAME | DESCRIPTION | FORMAT | ALLOWED/POSSIBLE VALUES |
---|---|---|---|
<ReshopOffers / ReshopOffer> (Delete / Cancel Flow) | |||
DeleteOfferItem AttributeOfferItemID AttributeOrderItemID | One for each orderItem of the order | Alphanumeric | Any |
DeleteOfferItem / ReshopDifferential / OriginalOrderItem / Total / Amount AttributeCode | OriginalOrderItem total value | Numeric | Any |
DeleteOfferItem / ReshopDifferential / OriginalOrderItem / Total / Purpose | Purpose of the OriginalOrderItem | Alphabetical |
|
DeleteOfferItem / ReshopDifferential / OriginalOrderItem / Taxes / Total AttributeCode | Total value of the OriginalOrderItem taxes | Numeric | Any |
DeleteOfferItem / ReshopDifferential / OriginalOrderItem / Taxes / BreakDown / Tax / Amount AttributeCode | Value of the OriginalOrderItem taxes broken down | Numeric | Any |
DeleteOfferItem / ReshopDifferential / OriginalOrderItem / Taxes / BreakDown / Tax / Nation | Nation for the tax | Alphabetical | Any |
DeleteOfferItem / ReshopDifferential / OriginalOrderItem / Taxes / BreakDown / Tax / TaxCode | TaxCode of the OriginalOrderItem taxes | Alphanumeric | Any |
DeleteOfferItem / ReshopDifferential / OriginalOrderItem / Taxes / BreakDown / Tax / TaxType | Type for the tax | Alphanumeric | Any |
DeleteOfferItem / ReshopDifferential / NewOfferItem / Total / Amount AttributeCode | New offer total amount (base and taxes)
| Numeric | Any |
DeleteOfferItem / ReshopDifferential / NewOfferItem / Total / Purpose | Purpose of the NewOfferItem | Alphabetical |
|
DeleteOfferItem / ReshopDifferential / NewOfferItem / Taxes / Total AttributeCode | NewOfferItem total taxes value and associated currency | Alphanumeric | Any |
DeleteOfferItem / ReshopDifferential / NewOfferItem / Taxes / BreakDown / Tax / Amount AttributeCode | Value of the NewOfferItem taxes broken down and associated currency | Alphanumeric | Any |
DeleteOfferItem / ReshopDifferential / NewOfferItem / Taxes / BreakDown / Tax / Nation | Nation associated to the tax | Alphabetical | Any |
DeleteOfferItem / ReshopDifferential / NewOfferItem / Taxes / BreakDown / Tax / TaxCode | Tax code associated to the tax | Alphanumeric | Any |
DeleteOfferItem / ReshopDifferential / NewOfferItem / Taxes / BreakDown / Tax / TaxType | Type associated to the tax | Alphanumeric | Any |
DeleteOfferItem / ReshopDifferential / PenaltyAmount/ Total / Amount AttributeCode | Total Penalty Amount | Alphanumeric | Any |
DeleteOfferItem / ReshopDifferential / ReshopDue / ByPassenger / Total / Amount AttributeCode | Total Amount to refund by the airline and associated currency. As in case of being refunded, it will be displayed as negative value. | Alphanumeric | Any |
DeleteOfferItem / ReshopDifferential / ReshopDue / ByPassenger/ Total / Purpose | Purpose of the total amount to be refunded | Alphanumeric |
|
DeteleOfferItem / ReshopDifferential / ReshopDue / Taxes / Total AttributeCode |
| Alphanumeric | Any |
DeleteOfferItem / ReshopDifferential / ReshopDue / Taxes / BreakDown / Tax / Amount AttributeCode |
| Alphanumeric | Any |
DeleteOfferItem / ReshopDifferential / ReshopDue / Taxes / BreakDown / Tax / Nation | Nation associated to the tax | Alphanumeric | Any |
DeleteOfferItem / ReshopDifferential / ReshopDue / Taxes / BreakDown / Tax / TaxCode | Tax code associated to the tax | Alphanumeric | Any |
DeleteOfferItem / ReshopDifferential / ReshopDue / Taxes / BreakDown / Tax / TaxType | Type associated to the tax | Alphanumeric | Any |
DeleteOfferItem example
AddOfferItem - New Availability
NAME | DESCRIPTION | FORMAT | ALLOWED/POSSIBLE VALUES |
---|---|---|---|
<ReshopOffers / ReshopOffer> (Reshop Flow - New Availability) | |||
AddOfferItem AttributeOrderItemIDs AttributeOfferItemID AttributeMandatoryInd | Order Item identification of the new offer Offer Item identification of the new offer Indicate if it is mandatory to add this offer item in the order | Alphanumeric Alphanumeric Alphabetical | Any Any True |
AddOfferItem / TotalPriceDetail / TotalAmount / SimpleCurrencyPrice AttributeCode | For new availabilities of paid and unpaid orders (reshop flow), it will be formed by the total new offer price for same type of passenger(for example adults). | Alphanumeric | Any |
AddOfferItem / TotalPriceDetail / BaseAmount AttributeCode | Unitary base amount and currency | Alphanumeric | Any |
AddOfferItem / TotalPriceDetail / Discount / DiscountAmount AttributeCode | Type of currency | Alphabetical | Any |
AddOfferItem / TotalPriceDetail / Discount / DiscountAmount | Unitary discount amount for each type of passenger included at the fare | Numeric | Any |
AddOfferItem / TotalPriceDetail / Discount / Application | Application for discount | Alphabetical | Any |
AddOfferItem / TotalPriceDetail / Discount / Description | Description for discount | Alphabetical | Any |
AddOfferItem / TotalPriceDetail / Taxes / Total AttributeCode | Unitary total taxes and amount | Alphanumeric | Any |
AddOfferItem / Service AttributeServiceID | Flight service identification | Alphanumeric | Any |
AddOfferItem / Service / PassengerRefs | Passengers associated to the new flight service shown | Alphanumeric | Any (Ex: ADULT_01 ADULT_02) |
AddOfferItem / Service / FlightRefs | Flights references associated to the new flight service shown | FLXX (XX → Number digits) | Any (Example: FL11) |
AddOfferItem / FareDetail / PassengerRefs | Passengers associated to the new flight offer shown | Alphanumeric | Any (Ex: ADULT_01 ADULT_02) |
AddOfferItem / FareDetail / Price / TotalAmount / SimpleCurrencyPrice AttributeCode | For new availabilities of paid and unpaid orders, it will be formed by the total new offer price for each passenger included at the fare. | Alphanumeric | Any |
AddOfferItem / FareDetail / Price / BaseAmount AttributeCode | For new availabilities of paid and unpaid orders, it will be formed by the base amount new offer price for each passenger included at the fare. | Alphanumeric | Any |
AddOfferItem / FareDetail / Price / Taxes / Total AttributeCode | Type of currency | Alphabetical | Any |
AddOfferItem / FareDetail / Price / Taxes / Total | Unitary total taxes for each passenger included at the fare | Numeric | Any |
AddOfferItem / FareDetail / FareComponent / PriceClassRef | Reference at DataList / PriceClassList *Note: The fare components will be displayed by segment. | Alphanumeric | Any (Ex: BAGSEATVIk62mgZUsT) |
AddOfferItem / FareDetail / FareComponent / SegmentRefs | Segment reference associated *Note: The fare components will be displayed by segment. | Alphanumeric | Any (Ex: IB044820220514MADBIO) |
AddOfferItem / 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) |
AddOfferItem / ReshopDifferential / PenaltyAmount / Total / Amount AttributeCode | Currency and penalty amount associated to the new offer item amount. Refers to all passengers associated to the same passenger type (for example adults). Only apply for paid orders flow (not for unpaid orders). | Alphanumeric | Any |
AddOfferItem / ReshopDifferential / ReshopDue / ByPassenger / Total / Amount AttributeCode | Currency and amount associated to the difference between new offer and original paid order, including penalty value. Refers to all passengers associated to the same passenger type (for example adults). Only apply for paid orders flow (not for unpaid orders). | Alphanumeric | Any |
<ReshopOffers/ ReshopOffer/ BaggageAllowance> | |||
FlightRefs | Reference for the Flights | Alphanumeric | Any |
PassengerRefs | Reference for the Passengers | Alphanumeric | Any |
BaggageAllowanceRef | Reference for the Baggage | Alphanumeric | Any |
AddOfferItem example
AddOfferItem - New Fare & Retarify Order
NAME | DESCRIPTION | FORMAT | ALLOWED/POSSIBLE VALUES |
---|---|---|---|
<ReshopOffers / ReshopOffer> (Reshop Flow - New Fare & Retarify Order) | |||
AddOfferItem AttributeOrderItemIDs AttributeOfferItemID | Order Item identification of the new offer Id of the OfferItem | Alphanumeric Alphanumeric | Any Any |
AddOfferItem / TotalPriceDetail / TotalAmount / SimpleCurrencyPrice AttributeCode | For new availabilities of paid and unpaid orders, or retarifying a previous order, it will be formed by the total new offer price for same type of passenger(for example adults). | Alphanumeric | Any |
AddOfferItem / TotalPriceDetail / BaseAmount AttributeCode | Unitary base amount and currency | Alphanumeric | Any |
AddOfferItem / TotalPriceDetail / Discount / DiscountAmount AttributeCode | Type of currency | Alphabetical | Any |
AddOfferItem / TotalPriceDetail / Discount / DiscountAmount | Unitary discount amount for each type of passenger included at the fare | Numeric | Any |
AddOfferItem / TotalPriceDetail / Discount / Application | Application for discount | Alphabetical | Any |
AddOfferItem / TotalPriceDetail / Discount / Description | Description for discount | Alphabetical | Any |
AddOfferItem / TotalPriceDetail / Taxes / Total AttributeCode | Unitary total taxes and amount | Alphanumeric | Any |
AddOfferItem / Service AttributeServiceID | Id for the service | Alphanumeric | Any |
AddOfferItem / Service / PassengerRefs | Reference for the passenger | Alphanumeric | Any |
AddOfferItem / Service / FlightRefs | Reference for the flight | Alphanumeric | Any |
AddOfferItem / FareDetail / PassengerRefs | Reference for the passenger | Alphanumeric | Any |
AddOfferItem / FareDetail / Price / TotalAmount / SimpleCurrencyPrice AttributeCode | For new availabilities of paid and unpaid orders, or retarifying a previous order, it will be formed by the total new offer price for each passenger. | Alphanumeric | Any |
AddOfferItem / FareDetail / Price / BaseAmount AttributeCode | For new availabilities of paid and unpaid orders, or retarifying a previous order, it will be formed by the base amount new offer price for each passenger. | Alphanumeric | Any |
AddOfferItem / FareDetail / Price / Taxes / Total AttributeCode | Price and currency for all taxes, it is referred to an individual passenger. | Alphanumeric | Any |
AddOfferItem / FareDetail / Price / Taxes / Breakdown / Tax / Amount AttributeCode | Price and currency for the tax, it is referred to an individual passenger. | Alphanumeric | Any |
AddOfferItem / FareDetail / Price / Taxes / Breakdown / Tax / Nation | Nation for the tax | Alphabetical | Any |
AddOfferItem / FareDetail / Price / Taxes / Breakdown / Tax / TaxCode | Code for the tax | Alphanumeric | Any |
AddOfferItem / FareDetail / Price / Taxes / Breakdown / Tax / TaxType | Type for the tax | Alphanumeric | Any |
AddOfferItem / FareDetail / Price / Taxes / Breakdown / Tax / Description | Description for the tax | Alphabetical | Any |
FareComponent / FareBasis / FareBasisCode / Code | Fare code | Alphanumeric | Any |
AddOfferItem / FareDetail / FareComponent / FareBasis / CabinType / CabinTypeCode | IATA PADIS Cabin code | Numeric | PADIS → 9873 Cabin class of service, coded 1 → First class, Highest class of service (First Class Category) |
AddOfferItem / FareDetail / FareComponent / FareBasis / CabinType / CabinTypeName | Name of the cabin | Alphabetical | First, Business, Premium Economy, Economy |
AddOfferItem / FareDetail / FareComponent / TicketDesig | Ticket designator associated to the order. | Alphanumeric | Any |
AddOfferItem / FareDetail / FareComponent / FareRules / Penalty AttributeCancelFeeInd | This attribute will indicate whether a cancellation or refund fee will apply. | Boolean | true/false |
AddOfferItem / FareDetail / FareComponent / FareRules / Penalty AttributeChangeFeeInd | This attribute will indicate whether a fee will be applied for any voluntary changes. | Boolean | true/false |
AddOfferItem / FareDetail / FareComponent / FareRules / Penalty AttributeRefundableInd | This attribute will indicate whether a fare is refundable or not. | Boolean | true/false |
AddOfferItem / FareDetail / FareComponent / FareRules / Penalty Attributerefs | Reference of the penalty rule that applies to the fare. | Alphanumeric | Any |
AddOfferItem / FareDetail / FareComponent / FareRules / Penalty / ApplicableFeeRemarks / Remark | Detailed conditions covering cancellations and changes. | Text | Any |
AddOfferItem / FareDetail / FareComponent / FareRules / Penalty / Details / Detail Attributerefs | References to detail of penalty
| Alphanumeric | Any |
AddOfferItem / FareDetail / FareComponent / FareRules / Penalty / Details / Detail / Type | Type of penalty applied | Alphabetical |
|
AddOfferItem / FareDetail / FareComponent / PriceClassRef | Reference for the PriceClass, associated with the same reference in PriceClassList | Alphanumeric | Any (Ex: BUSPROMOYrh2QIqV) |
AddOfferItem / FareDetail / FareComponent / SegmentRefs | References to a specific segment. | Alphanumeric | Any (Ex: IB537420191023) |
AddOfferItem / 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) |
AddOfferItem / ReshopDifferential / OriginalOrderItem / Total / Amount AttributeCode | Currency and total amount associated to the original item total amount. Refers to all passengers associated to the same passenger type (for example adults). | Alphanumeric | Any |
AddOfferItem / ReshopDifferential / OriginalOrderItem / Total / Purpose | Indicates type of amount that is specified (total, base...) | Alphabetic |
|
AddOfferItem / ReshopDifferential / OriginalOrderItem / Taxes / Total AttributeCode | Currency and taxes amount associated to the original item amount. Refers to all passengers associated to the same passenger type (for example adults).
| Alphanumeric | Any |
AddOfferItem / ReshopDifferential / OriginalOrderItem / Taxes / Breakdown / Tax / Amount AttributeCode | Currency and specific tax amount associated to the original item amount. Refers to all passengers associated to the same passenger type (for example adults).
| Numeric | Any |
AddOfferItem / ReshopDifferential / OriginalOrderItem / Taxes / Breakdown / Tax / Nation | Nation for the tax | Alphabetical | Any |
AddOfferItem / ReshopDifferential / OriginalOrderItem / Taxes / Breakdown / Tax / TaxCode | Tax identification Code | Alphanumeric | Any (Ex: QV) |
AddOfferItem / ReshopDifferential / OriginalOrderItem / Taxes / Breakdown / Tax / TaxType | Type for the tax | Alphanumeric | Any |
AddOfferItem / ReshopDifferential / NewOfferItem / Total / Amount AttributeCode | Currency and total amount associated to the new offer item amount. Refers to all passengers associated to the same passenger type (for example adults). | Alphanumeric | Any |
AddOfferItem / ReshopDifferential / NewOfferItem / Total / Purpose | Indicates type of amount that is specified (total, base...) | Alphabetic |
|
AddOfferItem / ReshopDifferential / NewOfferItem / Taxes / Total AttributeCode | Currency and taxes amount associated to the new offer item amount. Refers to all passengers associated to the same passenger type (for example adults). | Alphanumeric | Any |
AddOfferItem / ReshopDifferential / NewOfferItem / Taxes / Breakdown / Tax / Amount AttributeCode | Currency and specific tax amount associated to the new offer item amount. Refers to all passengers associated to the same passenger type (for example adults). | Alphanumeric | Any |
AddOfferItem / ReshopDifferential / NewOfferItem / Taxes / Breakdown / Tax / Nation | Nation for the tax | Alphabetical | Any |
AddOfferItem / ReshopDifferential / NewOfferItem / Taxes / Breakdown / Tax / TaxCode | Tax identification Code | Alphanumeric | Any (Ex: QV) |
AddOfferItem / ReshopDifferential / NewOfferItem / Taxes / Breakdown / Tax / TaxType | Type for the tax | Alphanumeric | Any |
AddOfferItem / ReshopDifferential / NewOfferItem / Taxes / Breakdown / Tax / Description | Description for the tax | Alphanumeric | Any |
AddOfferItem / ReshopDifferential / PenaltyAmount / Total / Amount AttributeCode | Currency and penalty amount associated to the new offer item amount. Refers to all passengers associated to the same passenger type (for example adults). Only apply for paid orders flow (not for unpaid orders, it will display zero). | Alphanumeric | Any |
AddOfferItem / ReshopDifferential / ReshopDue / ByPassenger / Total / Amount AttributeCode | Currency and amount associated to the difference between new offer and original paid order, including penalty value. Refers to all passengers associated to the same passenger type (for example adults). In case of unpaid orders flow, it will display total new offer amount, as original order has not been paid. The sum of all ReshopDue values, for all types of passengers, will be the amount to be sent in OrderChange request. | Alphanumeric | Any |
AddOfferItem / ReshopDifferential / ReshopDue / ByPassenger / Total / Purpose | Indicates type of amount that is specified (total, base...) | Alphabetical |
|
AddOfferItem / ReshopDifferential / ReshopDue / Taxes / Total AttributeCode | For flights changes of paid orders, it will display the difference between new offer taxes and original order taxes, being positive in case new taxes is greater than original values. | Alphanumeric | Any |
AddOfferItem / ReshopDifferential / ReshopDue / Taxes / Breakdown / Tax / Amount AttributeCode | For flights changes of paid orders, it will display the difference between new offer tax and original order tax, being positive in case new tax is greater than original value. | Alphanumeric | Any |
AddOfferItem / ReshopDifferential / ReshopDue / Taxes / Breakdown / Tax / Nation | Nation for the tax | Alphabetical | Any |
AddOfferItem / ReshopDifferential / ReshopDue / Taxes / Breakdown / Tax / TaxCode | Tax identification Code | Alphanumeric | Any (Ex: QV) |
AddOfferItem / ReshopDifferential / ReshopDue / Taxes / Breakdown / Tax / TaxType | Type for the tax | Alphanumeric | Any |
AddOfferItem / ReshopDifferential / ReshopDue / Taxes / Breakdown / Tax / Description | Description for the tax | Alphanumeric | Any |
ReshopOffers Reshop Flow example
BaggageAllowance
NAME | DESCRIPTION | FORMAT | ALLOWED/POSSIBLE VALUES |
---|---|---|---|
<ReshopOffers/ ReshopOffer/ BaggageAllowance> | |||
FlightRefs | Flight reference associated | Alphanumeric | Any (Ex: BIOSVQ20191023132000) |
PassengerRefs | Associated passengers references | Alphanumeric | Any (Ex: ADULT_02 ADULT_01) |
BaggageAllowanceRef | Reference to specific baggage conditions | Alphanumeric | Any (Ex: CHECKEDBAGALLOWANCE_0) |