---New Funcionality (R3.5 - RLS2020.22)--- |
---|
|
Functional Description
OrderReshop API is used to reshop for changes and cancelations to the itinerary of an existing Order.
This service supports the following types of actions:
Reprice(Retarify) → Allows to know the price of paying and issuing a previous generated order.
Delete / Cancel → To know in advance what is the devolution of a partial or total refund of a specific group of passengers (not all passenger of the order) or for a previos booking (all passenger of the order). Passenger/s can be deleted when at least one coupon is in Open for Use/Airport Control status. Available to calculate the cost of delete some paxes from UNPAID Orders.
Available for orders with Conjunction tickets.
Available for orders with Special Discounts (Spanish Resident & Spanish Large Family Discounts).
Available for all passengers of the initial booking or even for not all of them.
Available for code share flights.
OrderReshop Cancel is available for Private Fare orders with TravelAgency, but not available for Private Fare orders with Corporates.
OrderReshop Delete is not available for Private Fare orders.
Available for orders created with corporates and private fares,it is only avalaible if it is done before 24h and if flight is not NO SHOW .
Add & Delete (Reshop flow - New Availability) → Allows searching new date, time or cabin availabilities to change the initial booking for all pax or for some pax of the order (limited to the same number of slices and the same airport codes). All coupons have to be in Open for Use/Airport Control status.
Available for orders with Conjunction tickets.
Available for orders with Special Discounts (Spanish Resident & Spanish Large Family Discounts) and Private Fare orders.
Available for all passengers of the initial booking or even for not all of them.
Available for code share flights.
Available for orders with Private Fares (No Split) but NOT available for orders with Corporate Private Fares.
Reprice (Reshop flow - New Fare) → Allows selecting and pricing one of the offer resulting on previous order reshop(new availability). This previous call to order reshop is mandatory(new availability). For orders with Corporate public fares , it will not be allowed to selecting and pricing one offer with at least a corporate private fare segment.
If you want to reshop an order generated in v16, it is necessary to launch an OrderRetrieve v17 previously
ActionType | Use | Examples → Complete Flow (All RQ/RS) |
---|---|---|
Reprice (Retarify) | This service is used to know the price of paying and issuing a previous generated order | |
Delete / Cancel | To know in advance what is the devolution of a partial or total refund of a specific group of passengers (not all passenger of the order). To know in advance what is the cost of a partial or total refund for an initial booking (all passenger of the order):
| |
Add & Delete (Reshop flow - New Availability) | This combination allows to look for new availabilities for date, time and/or cabin for an initial booking. To know in advance what is the cost of a flight change:
|
|
Reprice (Reshop flow - New Fare) | Allows selecting and pricing one of the offer resulting on previous order reshop(new availability)
| |
v16 Compatibility | Allows to reshop a previously created order with v16 |
NDC Servicing operations for corporate will only validate that travel agency indicated in the request is the same as generated the order. If corporateID is present in the request, it will only be checked when the order has been generated with corporateID.
New or modify 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 |
| |
Version | The IATA version of the message | Numeric | Any | Schema |
<PointOfSale> | ||||
Location / CountryCode | Country code | 2 Alphabetical | If toggle feature for market validation is activated. | |
<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 |
| |
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 | |
Sender / TravelAgencySender / Contacts / Contact / Name / Given | Reference Agency contact name | Alphanumeric | Any | Mandatory for schema if 'Name' tag is indicated. |
Sender / TravelAgencySender / AgencyID | Name of the Sender / Agency | Alphanumeric | Any | 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) | 7 Numeric | 7 Numbers | Mandatory for schema if 'Participants' tag is indicated. |
<Party> (With Corporates) | Schema | |||
Sender / CorporateSender / ID | ID for the Corporate | Alphanumeric | Any | NDC Mandatory |
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 |
| |
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 | ||
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / Name / Given | Reference Agency contact name | Alphabetic | Any | Mandatory for schema if 'Name' tag is indicated. |
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 / 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;
| |
<Query / Reshop / OrderServicing / Add / Preference > (Reshop Flow - New Availability) | ||||
CabinPreferences / CabinType / Code | Cabin code to search | 1 Numeric | Values allowed in CABIN_PROVIDER_TYPE (In this case values from 1 to 5) | Mandatory for schema if 'Preference' tag is indicated. |
FarePreference / Types / Type AttributePreferencesContext | Product of private fare | Alphabetical | Any | Mandatory for schema if 'Preference' tag is indicated. |
FarePreference / Types / Type | Code of private fare | Numeric | Any | Mandatory for schema if 'Preference' 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 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 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 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 AttributePassengerID | Id of the passenger | Alphanumeric | Any |
Response Body
NAME | DESCRIPTION | FORMAT | ALLOWED VALUES |
---|---|---|---|
<Document> | |||
ReferenceVersion | The IATA version of the message | Numeric | 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 AttributeOfferID | Id of the offer | Alphanumeric | Any |
ReshopOffer AttributeOwner | Airline Owner | Alphabetic | IB |
ReshopOffer AttributeRequestedDateInd | Identifies if another dates are offered | Alphabetic |
|
OfferExpirationDateTime | Offer expiration time limit | Alphanumeric | Any |
PaymentTimeLimitDateTime | Offer payment time limit | Alphanumeric | Any |
TotalPrice / SimpleCurrencyPrice AttributeCode | This field will displayed a value for all passengers of the booking:
| Alphanumeric | Any |
FlightsOverview / FlightRef | Origin and destination reference | Alphanumeric | Any (Ex: OD11) |
FlightsOverview / FlightRef AttributeODRef | Origin and destination identification | Alphabetic | Any (Ex: MADLPA) |
FlightsOverview / FlightRef AttributePriceClassRef | Fare basis code reference | Alphanumeric | Any (Ex: BFLESES) |
DeleteOfferItem AttributeOfferItemID AttributeOrderItemID | One for each orderItem of the order | Alphanumeric | Any |
ReshopDifferential / OriginalOrderItem / Total / Amount AttributeCode | OriginalOrderItem total value | Numeric | Any |
ReshopDifferential / OriginalOrderItem / Total / Purpose | Purpose of the OriginalOrderItem | Alphabetical |
|
ReshopDifferential / OriginalOrderItem / Taxes /Total AttributeCode | Total value of the OriginalOrderItem taxes | Numeric | Any |
ReshopDifferential / OriginalOrderItem / Taxes / BreakDown / Tax / Amount AttributeCode | Value of the OriginalOrderItem taxes broken down | Numeric | Any |
ReshopDifferential / OriginalOrderItem / Taxes / BreakDown / Tax / TaxCode | TaxCode of the OriginalOrderItem taxes | Alphabetical | 2 Alpha |
ReshopDifferential / NewOfferItem / Total / Amount AttributeCode | New offer total amount (base and taxes)
| Numeric | Any |
ReshopDifferential / NewOfferItem / Total / Purpose | Purpose of the NewOfferItem | Alphabetical |
|
ReshopDifferential / NewOfferItem / Taxes / Total | NewOfferItem total value | Numeric | Any |
ReshopDifferential / NewOfferItem / Taxes / BreakDown / Tax / Amount | Value of the NewOfferItem taxes broken down | Numeric | Any |
ReshopDifferential / NewOfferItem / Taxes / BreakDown / Tax / TaxCode | TaxCode of the NewOfferItem taxes | Alphabetic | Any |
ReshopDifferential / PenaltyAmount/ Total / Amount AttributeCode | Total Penalty Amount | Numeric | Any |
ReshopDifferential / ReshopDue / ByAirline / Total / Amount AttributeCode | Total Amount to refund by the airline | Numeric | Any |
<ReshopOffers / ReshopOffer / AddOfferItem (Reshop Flow - New Availability)> | |||
AddOfferItem AttributeOrderItemIDs | Order Item identification of the new offer | Alphanumeric | Any |
AddOfferItem AttributeOfferItemID | Offer Item identification of the new offer | Alphanumeric | Any |
AddOfferItem AttributeMandatoryInd | Indicate if it is mandatory to add this offer item in the order | Alphabetic | True |
TotalPriceDetail / TotalAmount / SimpleCurrencyPrice AttributeCode | Price and currency of the new offer, in this case associated to the same types of passengers, for example Adult Passengers. | Alphanumeric | Any |
Service 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 | Alphanumeric | Any (Ex: OD11) |
FareDetail / PassengerRefs | Passengers associated to the new flight offer shown | Alphanumeric | Any (Ex: ADULT_01 ADULT_02) |
FareDetail / Price / TotalAmount / SimpleCurrencyPrice AttributeCode | Fare difference amount between new offer and original order (NOT included taxes or penalties) and currency associated, in this case associated to each individual different type of passenger. | Alphanumeric | Any |
FareDetail / Price / BaseAmount AttributeCode | Fare difference amount between new offer and original order (NOT included taxes or penalties) and currency associated, in this case associated to 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) |
<ReshopOffers / ReshopOffer / AddOfferItem > | |||
AddOfferItem AttributeOfferItemID | Id of the OfferItem | Alphanumeric | Any |
TotalPriceDetail / TotalAmount / SimpleCurrencyPrice AttributeCode | Price and currency for the OfferItem. In reshop flow, it refers to the difference between new offer and original order. | Alphanumeric | Any |
Service 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 AttributeCode | Price and currency for the fare, it is refered to an individual passenger. | Alphanumeric | Any |
FareDetail / Price / BaseAmount AttributeCode | Price and currency for the base amount, it is refered to an individual passenger. In reshop flow, it refers to the difference between new offer and original order. | Alphanumeric | Any |
FareDetail / Price / Surcharges / Surcharge / Total AttributeCode | Price and currency for the surcharge amount, it is refered to an individual passenger. In reshop flow, it refers to the difference between new offer and original order. | Alphanumeric | Any |
FareDetail / Price / Taxes / Total AttributeCode | Price and currency for all taxes, it is refered to an individual passenger. In reshop flow, it refers to the difference between new offer and original order taxes. | Alphanumeric | Any |
FareDetail / Price / Taxes / Breakdown / Tax / Amount AttributeCode | Price and currency for the tax, it is refered to an individual passenger. | Alphanumeric | Any |
FareDetail / Price / Taxes / Breakdown / Tax / TaxCode | Code for the tax | Alphanumeric | Any |
FareDetail / FareComponent / FareRules / Penalty Attributerefs | References to a specific penalty rule | Alphanumeric | Any |
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) |
ReshopDifferential / OriginalOrderItem / Total / Amount AttributeCode | Currency and total amount associated to the original item amount. It refers to all passengers associated to the same item, for example if amount for each passenger ADULT_01 and ADULT_02 is 20€, this field will refer 40€. | Alphanumeric | Any |
ReshopDifferential / OriginalOrderItem / Total / Purpose | Indicates type of amount that is specified (total, base...) | Alphabetic |
|
ReshopDifferential / OriginalOrderItem / Taxes / Total AttributeCode | Currency and taxes amount associated to the original item amount. It refers to all passengers associated to the same item, for example if taxes amount for each passenger ADULT_01 and ADULT_02 is 10€, this field will refer 20€. | Alphanumeric | Any |
ReshopDifferential / OriginalOrderItem / Taxes / Breakdown / Tax / Amount AttributeCode | Currency and specific tax amount associated to the original item amount. It refers to all passengers associated to the same item, for example if tax amount for each passenger ADULT_01 and ADULT_02 is 10€, this field will refer 20€. | Alphanumeric | Any |
ReshopDifferential / OriginalOrderItem / Taxes / Breakdown / Tax / TaxCode | Tax identification Code | Alphabetic | Any (Ex: QV) |
ReshopDifferential / NewOfferItem / Total / Amount AttributeCode | Currency and total amount associated to the new offer item amount. It refers to all passengers associated to the same item, for example if amount for each passenger ADULT_01 and ADULT_02 is 20€, this field will refer 40€. | Alphanumeric | Any |
ReshopDifferential / NewOfferItem / Total / Purpose | Indicates type of amount that is specified (total, base...) | Alphabetic |
|
ReshopDifferential / NewOfferItem / Taxes / Total AttributeCode | Currency and taxes amount associated to the new offer item amount. It refers to all passengers associated to the same item, for example if taxes amount for each passenger ADULT_01 and ADULT_02 is 10€, this field will refer 20€. | Alphanumeric | Any |
ReshopDifferential / NewOfferItem / Taxes / Breakdown / Tax / Amount AttributeCode | Currency and specific tax amount associated to the new offer item amount. It refers to all passengers associated to the same item, for example if tax amount for each passenger ADULT_01 and ADULT_02 is 10€, this field will refer 20€. | Alphanumeric | Any |
ReshopDifferential / NewOfferItem / Taxes / Breakdown / Tax / TaxCode | Tax identification Code | Alphabetic | Any (Ex: QV) |
ReshopDifferential / PenaltyAmount / Total / Amount AttributeCode | Currency and surcharge amount associated to the new offer item amount. It refers to all passengers associated to the same item, for example if penalty for each passenger ADULT_01 and ADULT_02 is 45€, this field will refer 90€. | Alphanumeric | Any |
ReshopDifferential / ReshopDue / ByPassenger or ByAirline /Total / Amount
AttributeCode | Currency and amount associated to the difference between new offer and original order. It refers to all passengers associated to the same item, for example if new offer for ADULT_01 and ADULT_02 is 200€ and previous was 100€, this field will display 100€. | Alphanumeric | Any |
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 AttributePassengerID | Id for the passenger | Alphanumeric | Any |
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 |
|
Individual / NameTittle | Title of the passenger | Alphabetical |
|
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 |
|
IdentityDocument / IdentityDocumentNumber | Number of identity document | Numeric | Any |
IdentityDocument / IdentityDocumentType | Type of document | Alphanumeric | Any
|
ContactInfoRef | Reference for passenger's contact info | Alphanumeric | Any |
Remark / Remark | Description of remark | Alphanumeric | Any |
<DataLists / BaggageAllowanceList> | |||
BaggageAllowance AttributeBaggageAllowanceID | Reference to specific baggage conditions | Alphanumeric | Any (Ex: CHECKEDBAGALLOWANCE_0) |
BaggageCategory | Identify baggage category | Alphabetic |
|
BaggageAllowance / PieceAllowance AttributePieceAllowanceCombination | Identify type of combination | Alphabetic | Any (Ex: OR) |
BaggageAllowance / PieceAllowance / ApplicableParty | Text "Party" (Identifier for all conditions) | Alphabetic |
|
BaggageAllowance / PieceAllowance / TotalQuantity | Quantity allowed | Numeric | Any |
BaggageAllowance / PieceAllowance / Descriptions / Text | Associated quantity text | Alphanumeric | Any |
BaggageAllowance / Piece Allowance / PieceMeasurements AttributeQuantity | Quantity allowed | Numeric | Any |
<DataLists / DescriptionList> | |||
Description AttributeObjectKey | Product of private fare | Alphabetical | Any(Ex:TO) |
Description / Text | Product of private fare | Alphabetical | Any(Ex:TO) |
<DataLists / FareList> | |||
FareGroup AttributeListKey | Fare Basis Identifier | Alphanumeric | Any (Ex: DDNNS2) |
FareGroup AttributeRefs | Product of private fare | Alphabetical | Any(Ex:TO) |
FareGroup / Fare / FareCode | Fare Code Identifier | Alphanumeric | Any (Ex: 70J) |
FareGroup / FareBasisCode / Code | Same Fare Basis Identifier as above | Alphanumeric | Any (Ex: DDNNS2) |
<ContactList / ContactInformation> | |||
ContacInformation 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 |
|
ContactProvided / Phone / PhoneNumber | Phone Number for the Contact indicated in Label | Numeric | Any |
<DataLists / FlightSegmentList / FlightSegment> | |||
FlightSegment 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 AttributeFlightKey | Id for the flight | Alphanumeric | Any |
Journey / Time | Duration of the flight | Alphanumeric | Any |
SegmentReferences | References for the segments | Alphanumeric | Any |
<DataLists / OriginDestinationList> | |||
OriginDestination AttributeOriginDestinationKey | Id of the origin-destination | Alphanumeric | Any |
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 | References for the flight | Alphanumeric | Any |
<DataLists / MediaList> | |||
Media AttributeListKey | Id for the Media Item | Alphanumeric | Any |
Media / MediaLink | Http link referring to the Media Item | Alphanumeric | Any |
<DataLists / PenaltyList> | |||
Penalty 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 | Numeric | Any |
Details / Detail / Amounts / Amount / CurrencyAmountValue AttributeCode | Amount and currency for the penalty | Alphanumeric | Any |
Details / Detail / Amounts / Amount / AmountApplication | Identifies minimum and maximun penalty amount | Alphabetic |
|
<DataLists / PriceClassList> | |||
PriceClass 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 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 Attributerefs | Segment and fare basis identification | Alphanumeric | Any (Ex: IB382620191013 DDNNS2) |
PriceClass / ClassOfService / Code AttributeSeatsLeft | Associated cabin number and code | Alphanumeric | Any |
PriceClass / ClassOfService / MarketingName | Fare Basis marketing identification | Alphabetic | Any (Ex: BUSINESS) |
<Metadata / Other / OtherMetadata / CurrencyMetadatas> | |||
CurrencyMetadata AttributeMetadataKey | ID for the Metadata | Alphanumeric | Any |
CurrencyMetada / Decimals | Number of decimals | Numeric | Any |
Error messages
For further information about all kind of error messages, please go to the following link: