Versions Compared

Key

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

...

Excerpt
nameReshopOffer

ReshopOffer

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

<ReshopOffers>

ReshopOffer

Info

Attribute

OfferID

Id of the offer

Alphanumeric

Any

ReshopOffer

Info

Attribute

Owner

Airline Owner

Alphabetical

IB

ReshopOffer

Info

Attribute

RequestedDateInd

Id of the offer

Airline Owner

Identifies if another dates are offered

Alphanumeric

Alphabetical

Alphabetical

Any

“IB”

  • True (Actually shown)

  • False

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

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#ABF5D1#DEEBFF

Attribute

Refs

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

Info

Attribute

Code

This field will display a value for all passengers of the booking:

  • For cancellations or passengers elimination, it will be formed by the sum of amounts the airline has to return. It will appear as positive refund amount.

  • For new availabilities of paid and unpaid orders (reshop flow), it will be formed by the total new offer price.

Alphanumeric

Any

FlightsOverview / FlightRef

Reference for the flight. The value refers to the FlightList list.

FLXX (XX → Number digits)

Any (Example: FL11)

FlightsOverview / FlightRef

Info

Attribute

ODRef

Origin and destination identification

Reference to the DataLists / OriginDestinationList

Alphanumeric

Default format: ODX (X → Number digit)

Any (Default format example: OD1)

FlightsOverview / FlightRef

Info

Attribute

PriceClassRef

Price Class identifier key:

  • Branded Fare example → BUSFLEXp8eGI8Gt

Alphanumeric

Any

...

Excerpt
nameReshopOffer_AddOfferItem_NewAvailability

AddOfferItem - New Availability

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

<ReshopOffers / ReshopOffer> (Reshop Flow - New Availability)

AddOfferItem

Info

Attribute

OrderItemIDs

Info

Attribute

OfferItemID

Info

Attribute

MandatoryInd

Order Item identification of the new offer

Alphanumeric

Any

AddOfferItem

Info

Attribute

OfferItemID

Offer Item identification of the new offer

Alphanumeric

Any

AddOfferItem

Info

Attribute

MandatoryInd

Indicate if it is mandatory to add this offer item in the order

Alphanumeric

Alphanumeric

Alphabetical

Any

Any

True

AddOfferItem / TotalPriceDetail / TotalAmount / SimpleCurrencyPrice

Info

Attribute

Code

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

Info

Attribute

Code

Unitary base amount and currency

Alphanumeric

Any

AddOfferItem / TotalPriceDetail / Discount / DiscountAmount

Info

Attribute

Code

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

Info

Attribute

Code

Unitary total taxes and amount

Alphanumeric

Any

AddOfferItem / Service 

Info

Attribute

ServiceID

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

Info

Attribute

Code

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

Info

Attribute

Code

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

Info

Attribute

Code

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

Info

Attribute

Code

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

Info

Attribute

Code

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

Expand
titleAddOfferItem example
Code Block
languagexml
<ReshopOffer>
	<AddOfferItem OrderItemIDs="IBcdb1362c43394a439b3ab7dd004cd1e3OC_01 IBcdb1362c43394a439b3ab7dd004cd1e3OC_02" OfferItemID="IB48ef34264b37406585479d8250d611bcOC_01" MandatoryInd="true">
		<TotalPriceDetail>
			<TotalAmount>
				<SimpleCurrencyPrice Code="USD">712.40</SimpleCurrencyPrice>
			</TotalAmount>
			<BaseAmount Code="USD">544.00</BaseAmount>
			<Taxes>
				<Total Code="USD">168.40</Total>
			</Taxes>
		</TotalPriceDetail>
		<Service ServiceID="IBFLIGHT_01_IB48ef34264b37406585479d8250d611bcOC_01">
			<PassengerRefs>ADULT_01 ADULT_02</PassengerRefs>
			<FlightRefs>FL15</FlightRefs>
		</Service>
		<Service ServiceID="IBFLIGHT_02_IB48ef34264b37406585479d8250d611bcOC_01">
			<PassengerRefs>ADULT_01 ADULT_02</PassengerRefs>
			<FlightRefs>FL21</FlightRefs>
		</Service>
		<Service ServiceID="IBFLIGHT_03_IB48ef34264b37406585479d8250d611bcOC_01">
			<PassengerRefs>ADULT_01 ADULT_02</PassengerRefs>
			<FlightRefs>FL31</FlightRefs>
		</Service>
		<Service ServiceID="IBFLIGHT_04_IB48ef34264b37406585479d8250d611bcOC_01">
			<PassengerRefs>ADULT_01 ADULT_02</PassengerRefs>
			<FlightRefs>FL41</FlightRefs>
		</Service>
		<Service ServiceID="IBFLIGHT_05_IB48ef34264b37406585479d8250d611bcOC_01">
			<PassengerRefs>ADULT_01 ADULT_02</PassengerRefs>
			<FlightRefs>FL51</FlightRefs>
		</Service>
		<FareDetail>
			<PassengerRefs>ADULT_01 ADULT_02</PassengerRefs>
			<Price>
				<TotalAmount>
					<SimpleCurrencyPrice Code="USD">356.20</SimpleCurrencyPrice>
				</TotalAmount>
				<BaseAmount Code="USD">272.00</BaseAmount>
				<Taxes>
					<Total Code="USD">84.20</Total>
				</Taxes>
			</Price>
			<FareComponent>
				<PriceClassRef>BAGSEATVIk62mgZUsT</PriceClassRef>
				<SegmentRefs>IB042620220525MADBIO</SegmentRefs>
			</FareComponent>
			<FareComponent>
				<PriceClassRef>BAGSEATVIk62mgZUsT</PriceClassRef>
				<SegmentRefs>IB042320220527BIOMAD</SegmentRefs>
			</FareComponent>
			<FareComponent>
				<PriceClassRef>BAGSEATVIk62mgZUsT</PriceClassRef>
				<SegmentRefs>IB887820220531MADVLC</SegmentRefs>
			</FareComponent>
			<FareComponent>
				<PriceClassRef>BAGSEATVIk62mgZUsT</PriceClassRef>
				<SegmentRefs>IB888120220601VLCMAD</SegmentRefs>
			</FareComponent>
			<FareComponent>
				<PriceClassRef>BAGSEAT0vhMvfOjaP1</PriceClassRef>
				<SegmentRefs>IB303420220602MADBCN</SegmentRefs>
			</FareComponent>
		</FareDetail>
	</AddOfferItem>
	<BaggageAllowance>
		<FlightRefs>FL51 FL41 FL31 FL21 FL15</FlightRefs>
		<PassengerRefs>ADULT_01 ADULT_02 INFANT_01</PassengerRefs>
		<BaggageAllowanceRef>HANDBAGALLOWANCE_01</BaggageAllowanceRef>
	</BaggageAllowance>
	<BaggageAllowance>
		<FlightRefs>FL51 FL41 FL31 FL21 FL15</FlightRefs>
		<PassengerRefs>ADULT_01 ADULT_02 INFANT_01</PassengerRefs>
		<BaggageAllowanceRef>CHECKEDBAGALLOWANCE_1</BaggageAllowanceRef>
	</BaggageAllowance>
</ReshopOffer>

Excerpt
nameReshopOffer_AddOfferItem_NewFareRetarify

AddOfferItem - New Fare & Retarify Order

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

<ReshopOffers / ReshopOffer> (Reshop Flow - New Fare & Retarify Order)

AddOfferItem

Info

Attribute

OrderItemIDs

Info

Attribute

OfferItemID

Order Item identification of the new offer

Id of the OfferItem

Alphanumeric

Alphanumeric

Any

Any

AddOfferItem / TotalPriceDetail / TotalAmount / SimpleCurrencyPrice

Info

Attribute

Code

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

Info

Attribute

Code

Unitary base amount and currency

Alphanumeric

Any

AddOfferItem / TotalPriceDetail / Discount / DiscountAmount

Info

Attribute

Code

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

Info

Attribute

Code

Unitary total taxes and amount

Alphanumeric

Any

AddOfferItem / Service

Info

Attribute

ServiceID

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

Info

Attribute

Code

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

Info

Attribute

Code

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

Info

Attribute

Code

Price and currency for all taxes, it is referred to an individual passenger.

Alphanumeric

 Any

AddOfferItem / FareDetail / Price / Taxes / Breakdown / Tax / Amount

Info

Attribute

Code

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)
2 → Second class, Medium class of service (Business Class Category)
3 → Third class, lowest class of service (all economy/coach class categories)
4 → Economy/coach premium
5 → Economy/coach

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

Info

Attribute

CancelFeeInd

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

Boolean

true/false

AddOfferItem / FareDetail / FareComponent / FareRules / Penalty

Info

Attribute

ChangeFeeInd

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

Boolean

true/false

AddOfferItem / FareDetail / FareComponent / FareRules / Penalty

Info

Attribute

RefundableInd

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

Boolean

true/false

AddOfferItem / FareDetail / FareComponent / FareRules / Penalty

Info

Attribute

refs

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

Info

Attribute

refs

References to detail of penalty

  • Example: refs = “RULEMETADATAKEY_1”

Alphanumeric

Any

AddOfferItem / FareDetail / FareComponent / FareRules / Penalty / Details / Detail / Type

Type of penalty applied

Alphabetical

  • Cancel

  • Change

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

Info

Attribute

Code

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

  • Net (indicates total amount is displayed, base and taxes)

AddOfferItem / ReshopDifferential / OriginalOrderItem / Taxes / Total

Info

Attribute

Code

Currency and taxes amount associated to the original item amount. 

Refers to all passengers associated to the same passenger type (for example adults).

  • For new availabilities of unpaid orders, it will be not displayed.

Alphanumeric

Any

AddOfferItem / ReshopDifferential / OriginalOrderItem / Taxes / Breakdown / Tax / Amount

Info

Attribute

Code

Currency and specific tax amount associated to the original item amount. 

Refers to all passengers associated to the same passenger type (for example adults).

  • For new availabilities of unpaid orders, it will be not displayed.

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

Info

Attribute

Code

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

  • Net (indicates total amount is displayed, base and taxes)

AddOfferItem / ReshopDifferential / NewOfferItem / Taxes / Total

Info

Attribute

Code

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

Info

Attribute

Code

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

Info

Attribute

Code

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

Info

Attribute

Code

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

  • Net (indicates total amount is displayed, base and taxes)

AddOfferItem / ReshopDifferential / ReshopDue / Taxes / Total

Info

Attribute

Code

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

Info

Attribute

Code

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

...