...
Release 2023.09
...
Legend
...
New or modified field
...
Field to be removed/deprecated
HTTP Headers
...
HEADER NAME
...
DESCRIPTION
...
MANDATORY?
...
EXAMPLE
...
api_key
...
Your unique key used to authorise access to the API.
...
Yes
...
n/a
Request Body
...
NAME
...
DESCRIPTION
...
FORMAT
...
ALLOWED VALUES
...
MANDATORY FOR
...
PrimaryLangID
...
Two character ISO Language Code, for the agent’s preferred language. This is for error messages and some other data such as legal waivers.
...
2 alpha
...
EN
ES
...
Version
...
The IATA version of the message
...
Numeric
...
Any
...
Schema
...
<PointOfSale>
...
Location / CountryCode
...
Country code. (Iberia will use the country stored in the internal database for registered users)
...
2 Alphabetical
...
...
<Document>
...
Schema
...
ReferenceVersion
...
The IATA Schema version
...
Numeric
...
Any
...
<Party / Sender> Only for Real IATA
...
Schema
...
TravelAgencySender / IATA_Number
...
Sender unique identifier such as:
IATA number (if you have one)
TIDs number (re
ended if you do not have an IATA)
...
Numeric
...
7/8 Numbers
...
NDC Mandatory
...
<Party / Sender> Only for Pseudo IATA
...
Schema
...
TravelAgencySender / OtherIDs / OtherID
...
Pseudo IATA (assigned by Iberia)
...
Numeric
...
7/8 Numbers
...
NDC Mandatory
...
<Party>
...
Sender / TravelAgencySender / Name
...
Agency Name
...
Alphanumeric
...
Any
...
Sender / TravelAgencySender / Contacts / Contact / EmailContact / Address
...
Email to contact the Agency
...
Alphanumeric
...
Any
...
Mandatory for schema if 'EmailContact' tag is indicated.
...
Sender / TravelAgencySender / Contacts / Contact / PhoneContact / Application
...
Agency phone type
...
Alphabetical
...
Business
Mobile
...
Sender / TravelAgencySender / Contacts / Contact / PhoneContact / Number
...
Phone number to contact the Agency
...
Numeric
...
Any
...
Sender / TravelAgencySender / Contacts / Contact / Name / Surname
...
Reference Agency contact surname
...
Alphanumeric
...
Any
...
Mandatory for schema if 'Name' tag is indicated.
...
Sender / TravelAgencySender / Contacts / Contact / Name / Given
...
Reference Agency contact name
...
Alphanumeric
...
Any
...
Sender / TravelAgencySender / AgencyID
...
Name of the Sender / Agency. It will be obtained by NDC_SELLERS table.
...
Alphanumeric
...
Any
...
Participants / Participant / AggregatorParticipant / AggregatorID
...
Participant / Aggregator unique identifier:
IATA number (if you have one)
TIDs number (recommended if you do not have an IATA)
Pseudo IATA(assigned by Iberia)
...
7 Numeric
...
7 Numbers
...
Mandatory for schema if 'Participants' tag is indicated.
...
<Party> (With Corporates)
...
Schema
...
Sender / CorporateSender / ID
...
ID for the Corporate
*Not mandatory to include it, if in previous AirShopping is already informed, in this case this value will be taken from database*
...
Alphanumeric
...
Any
...
Participants / Participant / TravelAgencyParticipant / Name
...
Agency Name
...
Alphanumeric
...
Any
...
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / EmailContact / Address
...
Email to contact the Agency
...
Alphanumeric
...
Any
...
Mandatory for schema if 'EmailContact' tag is indicated.
...
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / PhoneContact / Application
...
Agency phone type
...
Alphabetic
...
Business
Mobile
...
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / PhoneContact / Number
...
Phone number to contact the Agency
...
Alphanumeric
...
Any
...
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / Name / Surname
...
Reference Agency contact surname
...
Alphabetic
...
Mandatory for schema if 'Name' tag is indicated.
...
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / Name / Given
...
Reference Agency contact name
...
Alphabetic
...
Any
...
Participants / Participant / TravelAgencyParticipant / TravelAgencySender / OtherIDs / OtherID
...
Pseudo IATA Identification
...
Numeric
...
7/8 Numbers
...
NDC Mandatory
...
Sender / TravelAgencySender / AgencyID
...
Real IATA Identification
...
Numeric
...
7/8 Numbers
...
Schema
...
Participants / Participant / AggregatorParticipant / AggregatorID
...
Participant / Aggregator unique identifier:
IATA number (if you have one)
TIDs number (recommended if you do not have an IATA)
Pseudo IATA(assigned by Iberia)
...
Numeric
...
7/8 Numbers
...
Mandatory for schema if 'Participants' tag is indicated.
...
<Query>
...
OrderID
...
Id of the Order
...
Alphanumeric
...
Any
...
<Query / Reshop / OrderServicing / Add / Qualifier / ExistingOrderQualifier > (Retarify Flow)
...
OrderKeys / OrderID
...
Order Identification
...
Alphanumeric
...
Any
...
PassengerReferences
...
Reference of the passenger
...
Alphanumeric
...
Any
...
<Query / Reshop / OrderServicing / Add / FlightQuery > (Reshop Flow - New Availability)
...
OriginDestinations / OriginDestination
| Info |
|---|
AttributeOriginDestinationKey |
...
ID for the Origin/Destination
...
Alphanumeric
...
This attribute can be filled with any value, but first character cannot be a number digit or a special character.
...
OriginDestinations / OriginDestination / Departure / AirportCode
...
Departure airport code
...
3 alpha
...
Any valid airport code (JFK)
...
Mandatory for schema if 'OriginDestination' tag is indicated.
...
OriginDestinations / OriginDestination / Departure / Date
...
Departure date
...
Date
...
Any Date (2019-10-06<)
...
Mandatory for schema if 'OriginDestination' tag is indicated.
...
OriginDestinations / OriginDestination / Arrival / AirportCode
...
Arrival airport code
...
3 alpha
...
Any valid airport code (BCN)
...
Mandatory for schema if 'OriginDestination' tag is indicated.
...
OriginDestinations / OriginDestination / MarketingCarrierAirline / AirlineID
...
Airline identification code
...
2 alpha
...
Any valid, in our case IB
...
Mandatory for schema if 'MarketingCarrierAirline' tag is indicated.
...
OriginDestinations / OriginDestination / MarketingCarrierAirline / FlightNumber
...
Flight number identification
...
Alphanumeric
...
It is valid to fill in with the following options for flight changes in paid orders (Not available for unpaid orders):
OPEN (All flights availability will be displayed)
XXXX (Specific Flight Number - This flight number availability will be displayed).
...
<Query / Reshop / OrderServicing / Add / Preference > (Reshop Flow - New Availability)
FarePreference / Types / Type
| Info |
|---|
AttributePreferencesContext |
...
Product of private fare
...
Alphabetical
...
Any
...
Mandatory for schema if 'Preference' tag is indicated.
...
FarePreference / Types / Type
...
Code of private fare
...
Numeric
...
Actually this field is not taken into account as original public/private product will be applied in new search.
...
Mandatory for schema if 'Types' tag is indicated.
...
CabinPreferences / CabinType / Code
...
Cabin code to search
...
1 Numeric
...
It is valid to fill in with the following options for flight changes in paid orders (Not available for unpaid orders):
Values allowed in CABIN_PROVIDER_TYPE (In this case values from 1 to 5)
...
Mandatory for schema if 'CabinType' tag is indicated.
...
PricingMethodPreference / BestPricingOption
...
Code to select best pricing option
...
1 Alphabetical
...
It is valid to fill in with the following options for flight changes in unpaid orders (Not available for paid orders):
C (cheapest fares)
...
Mandatory for schema if 'PricingMethodPreference' tag is indicated.
...
FlightPreferences / Characteristic / DirectPreferences
...
Specific number of fligt stops.
...
1 Numeric
...
0 - Direct Flights
n (1, 2, 3...) - Indirect Flights
...
Mandatory for schema if 'Characteristic' tag is indicated.
...
<Query / Reshop / OrderServicing / Add / Passengers> (Reshop Flow - New Availability)
...
PassengerReferences
...
Passenger references the new search applies to
...
Alphanumeric
...
Any (Ex: ADULT_01 CHILD_01 INFANT_01)
...
Mandatory for schema if 'Passengers' tag is indicated.
...
<Query / Reshop / OrderServicing / Delete> (Cancel & Reshop Flow - New Availability)
OrderItem
| Info |
|---|
AttributeOrderItemID |
...
Identification of the flight item associated to the passenger who is asking for new availabilities options.
...
Alphanumeric
...
Any valid flight item returned in Order Create RS.
...
Mandatory for schema if 'Delete' tag is indicated.
...
ServiceRetainRequestIDs
...
Flight services that passenger wants to mantain in new search.
...
Alphanumeric
...
Any valid flight service returned in Order Create RS.
...
<Query / Reshop / OrderServicing / Add / Qualifier / ExistingOrderQualifier> (Reshop Flow - New Fare)
OrderKeys / OrderID
| Info |
|---|
AttributeOwner |
...
Order and owner identification
...
Owner will be IB and the order identification, the one created previously.
...
Owner will be IB and the order identification, the one created previously.
...
Mandatory for schema if 'ExistingOrderQualifier' tag is indicated.
OrderKeys / AssociatedIDs / AssociatedID / OfferItemID
| Info |
|---|
AttributeOwner |
...
Offer identification of the offer item from previous order reshop and owner identification
...
Alphanumeric
...
Owner will be IB and the offer identification, the one returned in previous order reshop(new availability)
...
PassengerReferences
...
Passenger references the new fare applies to
...
Alphanumeric
...
Any (Ex: ADULT_01 CHILD_01 INFANT_01)
...
<DataLists / PassengerList>
Passenger
| Info |
|---|
AttributePassengerID |
...
Id of the passenger
PassengerID attribute value can be indicated in PassengerID attribute from AirShopping request.
...
Alphanumeric
Alphanumeric
...
Any
Value indicated in PassengerID attribute from AirShopping request
Response Body
...
NAME
...
DESCRIPTION
...
FORMAT
...
ALLOWED VALUES
...
<Document>
...
ReferenceVersion
...
The IATA version of the message
...
Numeric
...
Any
...
<Warnings>
...
Warning
...
Different messages to inform the agency, for example:
In flight changes, associated ancillaries that cannot be changed/moved with the flights are lost, and a warning is shown.
In flight changes, if a different product type is included as a preference in the new flights search.
...
Alphanumeric
...
Any
...
<OrderReshopProcessing>
...
MarketingMessages / MarketMessage / Text
...
Message indicating that if additional services have been contracted, contact Iberia for refund
...
Alphabetical
...
Any
...
<ReShoppingResponseID>
...
ResponseID
...
Id of the response
...
Alphanumeric
...
Any
...
<ReshopOffers / ReshopOffer >
ReshopOffer
| Info |
|---|
AttributeOfferID |
...
Id of the offer
...
Alphanumeric
...
Any
ReshopOffer
| Info |
|---|
AttributeOwner |
...
Airline Owner
...
Alphabetic
...
IB
ReshopOffer
| Info |
|---|
AttributeRequestedDateInd |
...
Identifies if another dates are offered
...
Alphabetic
...
True (Actually shown)
False
...
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
...
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
TotalPrice / SimpleCurrencyPrice
| Info |
|---|
AttributeCode |
...
This field will displayed a value for all passengers of the booking:
For cancelations 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 orders (reshop flow), it will be formed by the difference for all passengers between the new offer and the original order, so this value may be positive if passenger has to pay or negative if AirLine has to return money to the passenger.
For new availabilities of 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 |
|---|
AttributeODRef |
...
Origin and destination identification
Reference to the DataLists / OriginDestinationList
...
Alphanumeric
Default format: ODX (X → Number digit)
...
Any (Default format example: OD1)
FlightsOverview / FlightRef
| Info |
|---|
AttributePriceClassRef |
...
Fare basis code reference
...
Alphanumeric
...
Any (Ex: BFLESES)
...
<ReshopOffers / ReshopOffer / DeleteOfferItem (Delete / Cancel Flow )>
DeleteOfferItem
| Info |
|---|
AttributeOfferItemID |
| Info |
|---|
AttributeOrderItemID |
...
One for each orderItem of the order
...
Alphanumeric
...
Any
ReshopDifferential / OriginalOrderItem / Total / Amount
| Info |
|---|
AttributeCode |
...
OriginalOrderItem total value
...
Numeric
...
Any
...
ReshopDifferential / OriginalOrderItem / Total / Purpose
...
Purpose of the OriginalOrderItem
...
Alphabetical
...
Net (refers to total amount, fare and taxes)
ReshopDifferential / OriginalOrderItem / Taxes /Total
| Info |
|---|
AttributeCode |
...
Total value of the OriginalOrderItem taxes
...
Numeric
...
Any
ReshopDifferential / OriginalOrderItem / Taxes / BreakDown / Tax / Amount
| Info |
|---|
AttributeCode |
...
Value of the OriginalOrderItem taxes broken down
...
Numeric
...
Any
...
ReshopDifferential / OriginalOrderItem / Taxes / BreakDown / Tax / Nation
...
Nation for the tax
...
Alphabetical
...
Any
...
ReshopDifferential / OriginalOrderItem / Taxes / BreakDown / Tax / TaxCode
...
TaxCode of the OriginalOrderItem taxes
...
Alphanumeric
...
Any
...
ReshopDifferential / OriginalOrderItem / Taxes / BreakDown / Tax / TaxType
...
Type for the tax
...
Alphanumeric
...
Any
...
ReshopDifferential / OriginalOrderItem / Taxes / BreakDown / Tax / Description
...
Description for the tax
...
Alphanumeric
...
Any
ReshopDifferential / NewOfferItem / Total / Amount
| Info |
|---|
AttributeCode |
...
New offer total amount (base and taxes)
Total Refund → This value will display “0”, as there is not consumed services.
Partial Refund → This value will display the value of consumed services.
NO SHOW / Total Refund (Penalties) → This value will display the value of consumed services.
New Availability → This value will display the new offer amount.
...
Numeric
...
Any
...
ReshopDifferential / NewOfferItem / Total / Purpose
...
Purpose of the NewOfferItem
...
Alphabetical
...
Net (refers to total amount, fare and taxes)
...
ReshopDifferential / NewOfferItem / Taxes / Total
| Info |
|---|
AttributeCode |
...
NewOfferItem total taxes value and associated currency
...
Alphanumeric
...
Any
...
ReshopDifferential / NewOfferItem / Taxes / BreakDown / Tax / Amount
| Info |
|---|
AttributeCode |
...
Value of the NewOfferItem taxes broken down and associated currency
...
Alphanumeric
...
Any
...
ReshopDifferential / NewOfferItem / Taxes / BreakDown / Tax / Nation
...
Nation associated to the tax
...
Alphabetical
...
Any
...
ReshopDifferential / NewOfferItem / Taxes / BreakDown / Tax / TaxCode
...
Tax code associated to the tax
...
Alphanumeric
...
Any
...
ReshopDifferential / NewOfferItem / Taxes / BreakDown / Tax / TaxType
...
Type associated to the tax
...
Alphanumeric
...
Any
...
ReshopDifferential / NewOfferItem / Taxes / BreakDown / Tax / Description
...
Description for the tax
...
Alphanumeric
...
Any
ReshopDifferential / PenaltyAmount/ Total / Amount
| Info |
|---|
AttributeCode |
...
Total Penalty Amount
...
Alphanumeric
...
Any
ReshopDifferential / ReshopDue / ByAirline / Total / Amount
| Info |
|---|
AttributeCode |
...
Total Amount and currency associated to refund by the airline.
As is case of being refunded, it will be displayed as negative value.
...
Alphanumeric
...
Any
...
ReshopDifferential / ReshopDue / ByAirline / Total / Purpose
...
Purpose of the total amount to be refunded
...
Alphabetical
...
Net (refers to total amount, fare and taxes)
...
ReshopDifferential / ReshopDue / Taxes / Total
| Info |
|---|
AttributeCode |
...
For cancellations, total taxes amount and associated currency to be refunded to the passenger.
In case of being refunded, they will be displayed as negative value.
...
Alphanumeric
...
Any
...
ReshopDifferential / ReshopDue / Taxes / BreakDown / Tax / Amount
| Info |
|---|
AttributeCode |
...
For cancellations, specific tax amount and associated currency to be refunded to the passenger.
In case of being refunded, it will be displayed as negative value.
...
Alphanumeric
...
Any
...
ReshopDifferential / ReshopDue / Taxes / BreakDown / Tax / Nation
...
Nation associated to the tax
...
Alphabetical
...
Any
...
ReshopDifferential / ReshopDue / Taxes / BreakDown / Tax / TaxCode
...
Tax code associated to the tax
...
Alphanumeric
...
Any
...
ReshopDifferential / ReshopDue / Taxes / BreakDown / Tax / TaxType
...
Type associated to the tax
...
Alphanumeric
...
Any
...
<ReshopOffers / ReshopOffer / AddOfferItem (Reshop Flow - New Availability)>
AddOfferItem
| Info |
|---|
AttributeOrderItemIDs |
...
Order Item identification of the new offer
...
Alphanumeric
...
Any
AddOfferItem
| Info |
|---|
AttributeOfferItemID |
...
Offer Item identification of the new offer
...
Alphanumeric
...
Any
AddOfferItem
| Info |
|---|
AttributeMandatoryInd |
...
Indicate if it is mandatory to add this offer item in the order
...
Alphabetic
...
True
TotalPriceDetail / TotalAmount / SimpleCurrencyPrice
| Info |
|---|
AttributeCode |
...
For new availabilities of paid orders, it will be formed by the difference for same type of passenger(for example adults) between the new offer and the original order, so this value may be positive if passenger has to pay or negative if airLine has to return money to the passenger.
For new availabilities of unpaid orders, it will be formed by the total new offer price for same type of passenger(for example adults).
...
Alphanumeric
...
Any
...
TotalPriceDetail / BaseAmount
| Info |
|---|
AttributeCode |
...
Unitary base amount and currency
...
Alphanumeric
...
Any
...
TotalPriceDetail / Discount / DiscountAmount
| Info |
|---|
AttributeCode |
...
Type of currency
...
Alphabetical
...
Any
...
TotalPriceDetail / Discount / DiscountAmount
...
Unitary discount amount for each type of passenger included at the fare
...
Numeric
...
Any
...
TotalPriceDetail / Discount / Application
...
Application for discount
...
Alphabetical
...
Any
...
TotalPriceDetail / Discount / Description
...
Description for discount
...
Alphabetical
...
Any
...
TotalPriceDetail / Taxes / Total
| Info |
|---|
AttributeCode |
...
Unitary total taxes and amount
...
Alphanumeric
...
Any
Service
| Info |
|---|
AttributeServiceID |
...
Flight service identification
...
Alphanumeric
...
Any
...
Service / PassengerRefs
...
Passengers associated to the new flight service shown
...
Alphanumeric
...
Any (Ex: ADULT_01 ADULT_02)
...
Service / FlightRefs
...
Flights references associated to the new flight service shown
...
FLXX (XX → Number digits)
...
Any (Example: FL11)
...
FareDetail / PassengerRefs
...
Passengers associated to the new flight offer shown
...
Alphanumeric
...
Any (Ex: ADULT_01 ADULT_02)
FareDetail / Price / TotalAmount / SimpleCurrencyPrice
| Info |
|---|
AttributeCode |
...
For new availabilities of paid orders, it will be formed by the difference for each individual different type of passenger between the total new offer and the total original order, so this value may be positive if passenger has to pay or negative if airLine has to return money to the passenger.
For new availabilities of unpaid orders, it will be formed by the total new offer price for each individual different type of passenger.
...
Alphanumeric
...
Any
FareDetail / Price / BaseAmount
| Info |
|---|
AttributeCode |
...
For new availabilities of paid orders, it will be formed by the difference for each individual different type of passenger between the base amount new offer and the base amount original order, so this value may be positive if passenger has to pay or negative if airLine has to return money to the passenger.
For new availabilities of unpaid orders, it will be formed by the base amount new offer price for each individual different type of passenger.
...
Alphanumeric
...
Any
...
FareDetail / FareComponent / PriceClassRef
...
Fare basis code segment reference
...
Alphanumeric
...
Any (Ex: BFLESES)
...
FareDetail / FareComponent / SegmentRefs
...
Segment reference associated
...
Alphanumeric
...
Any (Ex: IB382620191013)
...
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)
...
<ReshopOffers / ReshopOffer / AddOfferItem (Reshop Flow - New Fare & Retarify Order)>
AddOfferItem
| Info |
|---|
AttributeOfferItemID |
...
Id of the OfferItem
...
Alphanumeric
...
Any
TotalPriceDetail / TotalAmount / SimpleCurrencyPrice
| Info |
|---|
AttributeCode |
...
For new availabilities of paid orders, it will be formed by the difference for same type of passenger(for example adults) between the new offer and the original order, so this value may be positive if passenger has to pay or negative if airLine has to return money to the passenger.
For new availabilities of 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
...
TotalPriceDetail / BaseAmount
| Info |
|---|
AttributeCode |
...
Unitary base amount and currency
...
Alphanumeric
...
Any
...
TotalPriceDetail / Discount / DiscountAmount
| Info |
|---|
AttributeCode |
...
Type of currency
...
Alphabetical
...
Any
...
TotalPriceDetail / Discount / DiscountAmount
...
Unitary discount amount for each type of passenger included at the fare
...
Numeric
...
Any
...
TotalPriceDetail / Discount / Application
...
Application for discount
...
Alphabetical
...
Any
...
TotalPriceDetail / Discount / Description
...
Description for discount
...
Alphabetical
...
Any
...
TotalPriceDetail / Taxes / Total
| Info |
|---|
AttributeCode |
...
Unitary total taxes and amount
...
Alphanumeric
...
Any
Service
| Info |
|---|
AttributeServiceID |
...
Id for the service
...
Alphanumeric
...
Any
...
Service / PassengerRefs
...
Reference for the passenger
...
Alphanumeric
...
Any
...
Service / FlightRefs
...
Reference for the flight
...
Alphanumeric
...
Any
...
FareDetail / PassengerRefs
...
Reference for the passenger
...
Alphanumeric
...
Any
FareDetail / Price / TotalAmount / SimpleCurrencyPrice
| Info |
|---|
AttributeCode |
...
For new availabilities of paid orders, it will be formed by the difference for each individual different type of passenger between the total new offer and the total original order, so this value may be positive if passenger has to pay or negative if airLine has to return money to the passenger.
For new availabilities of unpaid orders or retarifying a previous order, it will be formed by the total new offer price for each individual different type of passenger.
...
Alphanumeric
...
Any
FareDetail / Price / BaseAmount
| Info |
|---|
AttributeCode |
...
For new availabilities of paid orders, it will be formed by the difference for each individual different type of passenger between the base amount new offer and the base amount original order, so this value may be positive if passenger has to pay or negative if airLine has to return money to the passenger.
For new availabilities of unpaid orders or retarifying a previous order, it will be formed by the base amount new offer price for each individual different type of passenger.
...
Alphanumeric
...
Any
FareDetail / Price / Surcharges / Surcharge / Total
| Info |
|---|
AttributeCode |
...
Price and currency for the surcharge amount, it is refered to an individual passenger.
In reshop flow, it will apply for paid orders whose voluntary change this surcharge apply for. It will not apply to unpaid orders, so amount displayed will be zero.
...
Alphanumeric
...
Any
FareDetail / Price / Taxes / Total
| Info |
|---|
AttributeCode |
...
Price and currency for all taxes, it is refered to an individual passenger.
...
Alphanumeric
...
Any
FareDetail / Price / Taxes / Breakdown / Tax / Amount
| Info |
|---|
AttributeCode |
...
Price and currency for the tax, it is refered to an individual passenger.
...
Alphanumeric
...
Any
...
FareDetail / Price / Taxes / Breakdown / Tax / Nation
...
Nation for the tax
...
Alphabetical
...
Any
...
FareDetail / Price / Taxes / Breakdown / Tax / TaxCode
...
Code for the tax
...
Alphanumeric
...
Any
...
FareDetail / Price / Taxes / Breakdown / Tax / Taxtype
...
Type for the tax
...
Alphanumeric
...
Any
...
FareDetail / Price / Taxes / Breakdown / Tax / Description
...
Description for the tax
...
Alphanumeric
...
Any
...
FareDetail / Price / Taxes / Breakdown / Tax / Description
...
Description for the tax
...
Alphabetical
...
Any
...
FareDetail / FareComponent / FareRules / Penalty
| Info |
|---|
AttributeCancelFeeInd |
...
This indicator will displayed 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
...
FareDetail / FareComponent / FareRules / Penalty
| Info |
|---|
AttributeChangeFeeInd |
...
This indicator will displayed the following options:
"true" → This fare will have changee fee
"false" →This fare will not have changee fee
...
Boolean
...
true/false
...
FareDetail / FareComponent / FareRules / Penalty
| Info |
|---|
AttributeRefundableInd |
...
This indicator will displayed the following options:
"false" → This fare will not be refundable
"true" → This fare will be refundable
...
Boolean
...
true/false
FareDetail / FareComponent / FareRules / Penalty
| Info |
|---|
Attributerefs |
References to a specific penalty rule.
...
Alphanumeric
...
Any
...
FareDetail / FareComponent / FareRules / Penalty / ApplicableFeeRemarks / Remark
...
Text specifying charges applied in case of cancelations, changes, No-Show flights...
...
Text
...
Any
...
FareDetail / FareComponent / FareRules / Penalty / Details / Detail
| Info |
|---|
Attributerefs |
...
References to detail of penalty
Example: refs = “RULEMETADATAKEY_1”
...
Alphanumeric
...
Any
...
FareDetail / FareComponent / FareRules / Penalty / Details / Detail / Type
...
Type of penalty applied
...
Alphabetical
...
Cancel
Change
...
FareDetail / FareComponent / PriceClassRef
...
References to a specific fare basis code
...
Alphanumeric
...
Any (Ex: TCLESES)
...
FareDetail / FareComponent / SegmentRefs
...
References to a specific segment.
...
Alphanumeric
...
Any (Ex: IB537420191023)
...
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)
ReshopDifferential / OriginalOrderItem / Total / Amount
| Info |
|---|
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
...
ReshopDifferential / OriginalOrderItem / Total / Purpose
...
Indicates type of amount that is specified (total, base...)
...
Alphabetic
...
Net (indicates total amount is displayed, base and taxes)
ReshopDifferential / OriginalOrderItem / Taxes / Total
| Info |
|---|
AttributeCode |
...
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
ReshopDifferential / OriginalOrderItem / Taxes / Breakdown / Tax / Amount
| Info |
|---|
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).
For new availabilities of unpaid orders, it will be not displayed.
...
Alphanumeric
...
Any
...
ReshopDifferential / OriginalOrderItem / Taxes / Breakdown / Tax / Nation
...
Nation for the tax
...
Alphabetical
...
Any
...
ReshopDifferential / OriginalOrderItem / Taxes / Breakdown / Tax / TaxCode
...
Tax identification Code
...
Alphanumeric
...
Any (Ex: QV)
...
ReshopDifferential / OriginalOrderItem / Taxes / Breakdown / Tax / TaxType
...
Code for the tax
...
Alphanumeric
...
Any
...
ReshopDifferential / OriginalOrderItem / Taxes / Breakdown / Tax / Description
...
Description for the tax
...
Alphanumeric
...
Any
ReshopDifferential / NewOfferItem / Total / Amount
| Info |
|---|
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
...
ReshopDifferential / NewOfferItem / Total / Purpose
...
Indicates type of amount that is specified (total, base...)
...
Alphabetic
...
Net (indicates total amount is displayed, base and taxes)
ReshopDifferential / NewOfferItem / Taxes / Total
| Info |
|---|
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
ReshopDifferential / NewOfferItem / Taxes / Breakdown / Tax / Amount
| Info |
|---|
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
...
ReshopDifferential / NewOfferItem / Taxes / Breakdown / Tax / Nation
...
Nation for the tax
...
Alphabetical
...
Any
...
ReshopDifferential / NewOfferItem / Taxes / Breakdown / Tax / TaxCode
...
Tax identification Code
...
Alphanumeric
...
Any (Ex: QV)
...
ReshopDifferential / NewOfferItem / Taxes / Breakdown / Tax / TaxType
...
Type for the tax
...
Alphanumeric
...
Any
...
ReshopDifferential / NewOfferItem / Taxes / Breakdown / Tax / Description
...
Description for the tax
...
Alphanumeric
...
Any
ReshopDifferential / PenaltyAmount / Total / Amount
| Info |
|---|
AttributeCode |
...
Currency and surcharge 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
ReshopDifferential / ReshopDue / ByPassenger or ByAirline /Total / Amount
| Info |
|---|
AttributeCode |
...
Currency and amount associated to the difference between new offer and original paid order.
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.
...
Alphanumeric
...
Any
...
ReshopDifferential / ReshopDue / ByPassenger or ByAirline /Total / Purpose
...
Indicates type of amount that is specified (total, base...)
...
Alphabetical
...
Net (indicates total amount is displayed, base and taxes)
...
ReshopDifferential / ReshopDue / Taxes / Total
| Info |
|---|
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
...
ReshopDifferential / ReshopDue / Taxes / Breakdown / Tax / Amount
| Info |
|---|
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
...
ReshopDifferential / ReshopDue / Taxes / Breakdown / Tax / Nation
...
Nation for the tax
...
Alphabetical
...
Any
...
ReshopDifferential / ReshopDue / Taxes / Breakdown / Tax / TaxCode
...
Tax identification Code
...
Alphanumeric
...
Any (Ex: QV)
...
ReshopDifferential / ReshopDue / Taxes / Breakdown / Tax / TaxType
...
Type for the tax
...
Alphanumeric
...
Any
...
ReshopDifferential / ReshopDue / Taxes / Breakdown / Tax / Description
...
Description for the tax
...
Alphanumeric
...
Any
...
<ReshopOffers/ ReshopOffer/ BaggageAllowance>
...
BaggageAllowance / FlightRefs
...
Flight reference associated
...
Alphanumeric
...
Any (Ex: BIOSVQ20191023132000)
...
BaggageAllowance / PassengerRefs
...
Associated passengers references
...
Alphanumeric
...
Any (Ex: ADULT_02 ADULT_01)
...
BaggageAllowance / BaggageAllowanceRef
...
Reference to specific baggage conditions
...
Alphanumeric
...
Any (Ex: CHECKEDBAGALLOWANCE_0)
...
<Commision> (Only if Sender is Real IATA)
...
Amount
...
Amount of commision that applicates to the OfferItem
...
Numeric
...
Any
...
Percentage
...
Percentage of commision that applicates to the OfferItem
...
Numeric
...
Any
...
<DataLists / PassengerList / Passenger>
Passenger
| Info |
|---|
AttributePassengerID |
...
Id for the passenger
PassengerID attribute value can be indicated in PassengerID attribute from AirShopping request.
Alphanumeric
Alphanumeric
...
Any
Value indicated in PassengerID attribute from AirShopping request
...
PTC
...
Attribute Passenger Type Code
...
PaxType (3 Alphabetical)
...
...
Birthdate
...
Birthdate of the passenger
...
Date
...
Date depends of the PTC
...
Individual / Gender
...
Gender of the passenger
...
Alphabetical
...
Male
Female
...
Individual / NameTittle
...
Title of the passenger
...
Alphabetical
...
MR
MRS
MS
MSS
...
Individual / GivenName
...
Name of the passenger
...
Alphabetical
...
Any
...
Individual / Surname
...
Surname of the passenger
...
Alphabetical
...
Any
...
Individual / SurnameSuffix
...
Passenger suffix
...
Alphatical
...
Any
...
FOID / FOID_Number
...
Number for the document
...
Alphanumeric
...
Any
...
FOID / FOID_Type
...
Type of the passenger ID Info
...
2 Alphanumeric
...
NI
PP
...
IdentityDocument / IdentityDocumentNumber
...
Number of identity document
...
Numeric
...
Any
...
IdentityDocument / IdentityDocumentType
...
Type of document
...
Alphanumeric
...
Any
F1 (Other Documents, Resident Discount)
AI (Additional information, Large Family Discount)
...
ContactInfoRef
...
Reference for passenger's contact info
...
Alphanumeric
...
Any
...
InfantRef
...
Reference to the associated adult passenger for infant in lap passengers, and to the associated infant in lap passenger for adult passengers.
...
Alphanumeric
...
Any
...
Remark / Remark
...
Description of remark
...
Alphanumeric
...
Any
...
<DataLists / BaggageAllowanceList>
BaggageAllowance
| Info |
|---|
AttributeBaggageAllowanceID |
...
Reference to specific baggage conditions
...
Alphanumeric
...
Any (Ex: CHECKEDBAGALLOWANCE_0)
...
BaggageCategory
...
Identify baggage category
...
Alphabetic
...
Checked
BaggageAllowance / PieceAllowance
| Info |
|---|
AttributePieceAllowanceCombination |
...
Identify type of combination
...
Alphabetic
...
Any (Ex: OR)
...
BaggageAllowance / PieceAllowance / ApplicableParty
...
Text "Party" (Identifier for all conditions)
...
Alphabetic
...
Party
...
BaggageAllowance / PieceAllowance / TotalQuantity
...
Quantity allowed
...
Numeric
...
Any
...
BaggageAllowance / PieceAllowance / Descriptions / Text
...
Associated quantity text
...
Alphanumeric
...
Any
BaggageAllowance / Piece Allowance / PieceMeasurements
| Info |
|---|
AttributeQuantity |
...
Quantity allowed
NOT USED BY IBERIA today. Included due to mandatory in Schema.
PLEASE IGNORE and use BaggageAllowance / PieceAllowance / TotalQuantity
...
Numeric
...
Any
...
<DataLists / DescriptionList>
Description
| Info |
|---|
AttributeObjectKey |
...
Product of private fare
...
Alphabetical
...
Requested product (Ex:TO)
...
Description / Text
...
Product of private fare
...
Alphabetical
...
Requested product (Ex:TO)
...
<DataLists / FareList>
FareGroup
| Info |
|---|
AttributeListKey |
...
Fare Basis Identifier
...
Alphanumeric
...
Any (Ex: DDNNS2)
FareGroup
| Info |
|---|
AttributeRefs |
...
Product of private fare
...
Alphabetical
...
Any(Ex:TO)
...
FareGroup / Fare / FareCode
...
IATA PADIS Code from Code Set 9910-Fare qualifier.
OrderReshop Delete&Create returns 1, because fare is not properly defined yet.
OrderReshop Reprice returns correct FareCode (70J, 758, 70M…)
...
Alphanumeric
...
Public Fare → 70J
Private Fare → 758
Corporate Private Fare → 70M
Other → 1
...
FareGroup / FareBasisCode / Code
...
Same Fare Basis Identifier as above
...
Alphanumeric
...
Any (Ex: DDNNS2)
...
<ContactList / ContactInformation>
ContacInformation
| Info |
|---|
AttributeContactID |
...
ID for the contact
...
Alphanumeric
...
Any
...
ContactProvided / EmailAddress / EmailAddressValue
...
Email Address
...
Alphanumeric
...
Any
...
ContactProvided / Phone / PhoneNumber
...
Phone Number
...
Numeric
...
Any
...
ContactProvided / Phone / Label
...
Type of Contact
...
Alphabetical
...
Emergency
...
ContactProvided / Phone / PhoneNumber
...
Phone Number for the Contact indicated in Label
...
Numeric
...
Any
...
<DataLists / FlightSegmentList / FlightSegment>
FlightSegment
| Info |
|---|
AttributeSegmentKey |
...
Id for the segment
...
Alphanumeric
...
Any
...
Departure / AirportCode
...
IATA 3 character code for the departure city/airport/station
...
3 Alphanumeric
...
Any
...
Departure / Date
...
Date of departure
...
Date
...
yyyy-MM-dd
...
Departure / Time
...
Time of departure
...
Hour
...
HH:mm
...
Departure / AirportName
...
Name of the departure city/airport/station
...
Alphanumeric
...
Any
...
Departure / Terminal / Name
...
Name of the departure terminal at city/airport/station
...
Aphanumeric
...
Any
...
Arrival / AirportCode
...
IATA 3 character code for the arrival city/airport/station
...
3 Alphanumeric
...
Any
...
Arrival / Date
...
Date of arrival
...
Date
...
yyyy-MM-dd
...
Arrival / Time
...
Time of arrival
...
Hour
...
HH:mm
...
Arrival / ChangeOfDay
...
Change of day between departure and arrival
...
1 Numeric
...
Any
...
Arrival / AirportName
...
Name of the arrival city/airport/station
...
Alphanumeric
...
Any
...
Arrival / Terminal / Name
...
Name of the arrival terminal at city/airport/station
...
3 Alphanumeric
...
Any
...
MarketingCarrier / Name
...
Name for the airline that markets the flight
...
Alphanumeric
...
Any
...
MarketingCarrier / FlightNumber
...
Number for the flight
...
Numeric
...
Any
...
OperatingCarrier / AirlineID
...
Id for the airline that operates the flight
...
Alphabetical
...
Any
...
OperatingCarrier / Name
...
Name for the airline that operates the flight
...
Alphanumeric
...
Any
...
OperatingCarrier / FlightNumber
...
Number for the flight
...
Numeric
...
Any
...
OperatingCarrier / Disclosures / Description / Text
...
Description of the airline
...
Alphanumeric
...
Any
...
Equipment / AircraftCode
...
Code of the aircraft that operates the flight
...
Alphanumeric
...
Any
...
Equipment / Name
...
Name of the aircraft that operates the flight
...
Alphanumeric
...
Any
...
FlightDetail / FlightDuration / Value
...
Duration of the flight
...
Alphanumeric
...
Any
...
<FlightDetail / Stops>
...
StopQuantity
...
Number of technical stops
...
Numeric
...
>= 0
...
StopLocations
...
List of the technical stops
...
List
...
Any
...
<FlightDetail / Stops / StopLocations / StopLocations>
...
AirportCode
...
Code of the airport
...
Alphanumeric
...
Any
...
Name
...
Name of the airport
...
Alphanumeric
...
Any
...
ArrivalDate
...
Arrival date
...
Date
...
yyyy-MM-dd
...
ArrivalTime
...
Arrival time
...
Time
...
hh:mm
...
DepartureDate
...
Departure date
...
Date
...
yyyy-MM-dd
...
DepartureTime
...
Departure time
...
Time
...
hh:mm
...
GroundTime
...
Duration of the stop
...
Alphanumeric
...
ISO 8601 duration format (EX: PT2H40M)
...
<DataLists / FlightList>
Flight
| Info |
|---|
AttributeFlightKey |
...
Id for the flight
...
FLXX (XX → Number digits)
...
Any (Example: FL11)
...
Journey / Time
...
Duration of the flight
...
Alphanumeric
...
Any
...
SegmentReferences
...
References for the segments
...
Alphanumeric
...
Any
...
<DataLists / OriginDestinationList>
OriginDestination
| Info |
|---|
AttributeOriginDestinationKey |
...
Id of the origin-destination
OriginDestinationKey attribute value can be indicated in OriginDestinationKey attribute from AirShopping request. If this value is not indicated, it will be auto-generated with the default format.
...
Alphanumeric
Default format: ODX (X → Number digit)
...
Any (Default format example: OD1)
...
DepartureCode
...
IATA 3 character code for the departure city/airport/station
...
3 Alphanumeric
...
Any
...
ArrivalCode
...
IATA 3 character code for the arrival city/airport/station
...
3 Alphanumeric
...
Any
...
FlightReferences
...
List of FlightReferences
...
Alphanumeric
...
Any
...
<DataLists / MediaList>
Media
| Info |
|---|
AttributeListKey |
...
Id for the Media Item
...
Alphanumeric
...
Any
...
Media / MediaLink
...
Http link referring to the Media Item
...
Alphanumeric
...
Any
...
<DataLists / PenaltyList>
Penalty
| Info |
|---|
AttributeObjectKey |
...
Penalty identification reference
...
Alphanumeric
...
Any
...
Details / Detail / Type
...
Type of action associated to he penalty like Cancel, Change...
...
Alphabetic
...
Any
Ex: Cancel, Change
...
Details / Detail / Application
...
Associated Code to action refered above like Change, Cancel
FAT Fare or application penalty type
1 No show
2 Prior to departure
3 After departure
...
Numeric
...
Any
Details / Detail / Amounts / Amount / CurrencyAmountValue
| Info |
|---|
AttributeCode |
...
Amount and currency for the penalty
...
Alphanumeric
...
Any
...
Details / Detail / Amounts / Amount / AmountApplication
...
Identifies minimum and maximun penalty amount
...
Alphabetic
...
minPrice
maxPrice
...
<DataLists / PriceClassList>
PriceClass
| Info |
|---|
AttributePriceClassID |
...
Fare Basis Identifier
...
Alphanumeric
...
Any (Ex: BFLESES)
...
PriceClass / Name
...
Family Name of the fare basis
...
Alphabetic
...
Any (Ex: Business Flexible)
...
PriceClass / Code
...
Same Fare Basis Identifier as above
...
Alphanumeric
...
Any (Ex: BFLESES)
PriceClass / Descriptions / Description
| Info |
|---|
AttributeObjectKey |
...
Condition identification
...
Alphabetic
...
Any (Ex: EQMANOBUSINESSFLEXIBLE)
...
PriceClass / Descriptions / Description / Text
...
This field shows the condition and specify for each fare the detail.
...
Alphanumeric
...
Any (Ex: Equipaje de mano: 1 bulto)
PriceClass / ClassOfService
| Info |
|---|
Attributerefs |
...
Segment and fare basis identification
...
Alphanumeric
...
Any (Ex: IB382620191013 DDNNS2)
PriceClass / ClassOfService / Code
| Info |
|---|
AttributeSeatsLeft |
...
Associated cabin number and code
...
Alphanumeric
...
Any
...
PriceClass / ClassOfService / MarketingName
...
Fare Basis marketing identification
...
Alphabetic
...
Any (Ex: BUSINESS)
...
<Metadata / Other / OtherMetadata / CurrencyMetadatas>
CurrencyMetadata
| Info |
|---|
AttributeMetadataKey |
...
ID for the Metadata
...
Alphanumeric
...
Any
...
CurrencyMetada / Decimals
...
Number of decimals
...
Numeric
...
Any
...
RuleMetadatas / RuleMetadata
| Info |
|---|
AttributeMetadataKey |
...
ID associated for this Metadata
...
Alphanumeric
...
Any
...
RuleMetadatas / RuleMetadata / RuleID
...
Type of penalty applied
...
Alphabetical
...
Cancel
Change
...
RuleMetadatas / RuleMetadata / Values / Value / Instruction
...
This indicator will displayed the following options:
"Allowed" → This fare will be refundable or changeable
"Not Allowed" → This fare will not be refundable or changeable
...
Alphabetical
...
Allowed
Not Allowed
Error messages
For further information about all kind of error messages, please go to the following link:
...
Functional Description
Please, visit our new OrderReshopRQ page for Request messages and our new OrderReshopRS page for Response messages.
...