Release 2023.09
Legend | |
---|---|
New or modified field | Field to be removed/deprecated |
Unique to v2 Branded Fares |
Functional Description
The purpose of this table is to show the responses for NDC services Order Create, Order Change and Order Retrieve.
Examples of messages with complete flows can be downloaded from here.
Response Body (OrderViewRS)
NAME | DESCRIPTION | FORMAT | POSSIBLE VALUES | NDC Services |
---|---|---|---|---|
Version | NDC message version | Alphanumeric | Any | All Services |
PrimaryLangID | NDC message language identification | Alphabetical | Any (e.g.: es) | All Services |
xmlns | IATA official website | Alphabetical | Any | All Services |
<Document> | ||||
ReferenceVersion | Version | Numeric | Any | All Services |
<Errors> | ||||
Error AttributeShortText AttributeCode | Different messages to inform about errors that occurs during the process. | Alphanumeric | Any | All Services |
<Success/> | ||||
<Warnings/> | ||||
Warning | Different messages to inform the agency, for example:
| Alphanumeric | Any | All Services |
<Party / Sender / TravelAgencySender> | ||||
Type | Agency Type
If we receive any other value it will return error, but only when using Credit Card form of payment. | Alphabetical | Any | OrderCreate |
IATA_Number | Sender IATA number (if you have one) | Numeric | 8 numbers | All Services |
AgencyID | Agency ID | Alphanumeric | Any | All Services |
Name | Agency name. SELLER_NAME from table NDC_SELLERS. | Alphanumeric | Any | All Services |
<Party / Sender / TravelAgencySender / Contacts> | ||||
Contact AttributeContactType | Field that agencies can include to specify the information to include in confirmation mails.
| Alphabetical |
| All Services |
Contact / EmailContact / Address | Email to contact the Agency | Alphanumeric | Any | All Services |
Contact / PhoneContact / Application | Agency phone type | Alphabetical |
| All Services |
Contact / PhoneContact / Number | Phone number to contact the Agency | Numeric | Any | All Services |
Contact / Name / Surname | Reference Agency contact surname | Alphanumeric | Any | All Services |
Contact / Name / Given | Reference Agency contact name | Alphanumeric | Any | All Services |
<Party> (With Corporates) | ||||
Sender / CorporateSender / ID | ID for the corporate | Alphanumeric | Any | All Services |
Participants / Participant / TravelAgencyParticipant / Name | Agency name | Alphabetical | Any | All Services |
Participants / Participant / TravelAgencyParticipant / Contacts / Contact AttributeContactType | Field that agencies can include to specify the information to include in confirmation mails.
| Alphabetical |
| All Services |
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / EmailContact / Address | Email to contact the Agency | Alphanumeric | Any | All Services |
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / PhoneContact / Application | Agency phone type | Alphabetical |
| All Services |
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / PhoneContact / Number | Phone number to contact the Agency | Numeric | Any | All Services |
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / Name / Surname | Reference Agency contact surname | Alphanumeric | Any | All Services |
Participants / Participant / TravelAgencyParticipant / Contacts / Contact / Name / Given | Reference Agency contact name | Alphanumeric | Any | All Services |
Participants / Participant / TravelAgencyParticipant / IATA_Number | The identifier of the Travel Agent (Travel Management Company) managing the booking for their Corporate Client (identified in the CorporateSender). Possible identifiers:
| Numeric | 8 numbers | All Services |
Participants / Participant / TravelAgencyParticipant / AgencyID | Agency ID | Alphanumeric | Any | All Services |
<Response / OrderViewProcesing> | ||||
Remarks / Remark AttributeDisplayInd | Indicating the obligation to show the remark text to the end user/customer. | Boolean | true | All Services |
Remarks / Remark | Important information that should be displayed to the end user/customer. Today used for:
| Alphanumeric | Any | All Services |
MarketingMessages / MarketMessage / Text | Information message | Alphabetical | Any | All Services |
<Response / Order> | ||||
Order AttributeOrderID AttributeOwner | ID for the Order and Airline code | Alphanumeric | Any | All Services |
BookingReferences / BookingReference / ID | Order's Locator
| Alphanumeric | Any | All Services |
BookingReferences / BookingReference / AirlineID | ID for the Airline | Alphanumeric |
| All Services |
BookingReferences / BookingReference / ID | External reference ID | Alphabetical | XRef | All Services |
BookingReferences / BookingReference / OtherID AttributeName | This attribute contains the senders IATA Number | Numeric | 7/8 Numbers | All Services |
BookingReferences / BookingReference / OtherID | Sender´s external reference | Alphanumeric | Any (String exceeding 30 chars will be truncated) | All Services |
OriginalOrder AttributeOriginalOrderID | Original order identification
| Alphanumeric | Any | Order Change |
TotalOrderPrice / DetailCurrencyPrice / Total AttributeCode | Total price of the Order with associated currency | Numeric | Any | All Services |
TotalOrderPrice / DetailCurrencyPrice / Taxes / Total AttributeCode | Total taxes amount of the Order with associated currency | Numeric | Any | All Services |
TotalOrderPrice / SimpleCurrencyPrice AttributeCode | Total price of the new order after making a date, hour or cabin change to the initial booking (Penalty is not included in case that it applies) | Numeric | Any | Order Change |
Payments / Payment / Type | Code of payment type | Alpha |
| OrderCreate OrderChange |
Payments / Payment / Amount / SimpleCurrencyPrice AttributeCode | Amount of payment method Code of currency | numeric 3 alpha | Any | OrderCreate OrderChange |
– This refers to Voucher payment method -- | ||||
Payments / Payment / Method / VoucherMethod / Number | Voucher discount ID | Alphanumeric | Any | OrderCreate OrderChange |
– This refers to Cash payment method -- | ||||
Payments / Payment / Method / CashMethod | Indicate that payment method is cash | Empty | Empty | OrderCreate OrderChange |
– This refers to Credit Card payment method -- | ||||
Payments / Payment / PaymentCardMethod / CardType | Type of credit card | 2 alpha | VI, CA, AX, DC, etc | OrderCreate OrderChange |
Payments / Payment / PaymentCardMethod / MaskedCardNumber | Masked card number | Alphanumeric | Any | OrderCreate OrderChange |
TimeLimits / PaymentTimeLimit AttributeDateTime | Date for payment time limit | Date | Any | Order Create Order Retrieve |
Status AttributeScheduleChangeInd | Displayed only if the order has undergone an involuntary time change | Boolean | true | Order Retrieve |
Status / StatusCode | Shows if the order is unserviceable (UNS) or serviceable with involuntary time change | Alphabetical |
| Order Retrieve |
<Response / Order / OrderItems / OrderItem> | ||||
OrderItemID AttributeOrderItemID | ID for the OrderItem | Alphanumeric | Any | All Services |
ItemStatus | Status for the OrderItem in Partial Refunds
| Alphabetical |
| Order Change |
PriceDetail / TotalAmount / SimpleCurrencyPrice AttributeCode | Total amount of the OrderItem with associated currency | Numeric | Any | All Services |
PriceDetail / BaseAmount AttributeCode | Base amount of the OrderItem without taxes | Numeric | Any | All Services |
PriceDetail / Taxes / Total AttributeCode | Total amount of taxes of the OrderItem with associated currency | Numeric | Any | All Services |
PriceDetail / Taxes / Breakdown / Tax / Amount AttributeCode | Each amount of tax with associated currency | Numeric | Any | All Services |
PriceDetail / Taxes / Breakdown / Tax / Nation | Nation for the tax | Alphabetical | Any | All Services |
PriceDetail / Taxes / Breakdown / Tax / TaxCode | Code for the tax | Alphanumeric | Any | All Services |
PriceDetail / Taxes / Breakdown / Tax / TaxType | Type for the tax | Alphanumeric | Any | All Services |
PriceDetail / Taxes / Breakdown / Tax / Description | Description for the tax | Alphanumeric | Any | OrderCreate - No Payment |
Service AttributeServiceID AttributeServiceStatus | ID for the flight service and service status key. Service status will be displayed only for flight services, special needs and ancillaries. | Alphanumeric Alphabetical | Any HK - CONFIRMED UN - CANCELLED TK - ACCEPT CHANGES PENDING HN - CONFIRM PENDING | All Services |
Service / PassengerRef | Passenger Identifier | Alphanumeric | Any | All Services |
Service / SegmentRef | Segment Identifier | Alphanumeric | Any | All Services |
Service / ServiceRef | Service Identifier | Alphanumeric | Any | All Services |
Service / ServiceDefinitionRef AttributeSegmentRef | Service Identifier with associated segment | Alphanumeric | Any | All Services |
Service / SelectedSeat / Seat / Row | Row seat | Numeric | Any | All Services |
Service / SelectedSeat / Seat / Column | Column seat | Alphabetical | Any | All Services |
FareDetail / PassengerRefs | Passenger ID | Alphanumeric | Any | All Services |
FareDetail / Price / TotalAmount / SimpleCurrencyPrice AttributeCode | Price | Numeric | Any | All Services |
FareDetail / Price / BaseAmount AttributeCode | Base Price | Numeric | Any | All Services |
FareDetail / Price / Taxes / BreakDown / Tax / Amount AttributeCode | Tax | Numeric | Any | All Services |
FareDetail / Price / Taxes / BreakDown / Tax / Nation | Nation for the tax | Alphabetical | Any | All Services |
FareDetail / Price / Taxes / BreakDown / Tax / TaxCode | Tax code | Alphabetical | Any | All Services |
FareDetail / Price / Taxes / BreakDown / Tax / TaxType | Type for the tax | Alphanumeric | Any | All Services |
FareDetail / Price / Taxes / BreakDown / Tax / Description | Description for the tax | Alphanumeric | Any | OrderCreate - No Payment |
FareDetail / FareComponent / FareBasis / FareBasisCode / Code | Code of the fare | Alphanumeric | Any | All Services |
FareDetail / FareComponent / FareBasis / RBD | RBD for the fare | Alphabetical | Any | All Services |
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) | Migrated flows: OrderRetrieve OrderChange Payment (Time Limit Orders) OrderChange Voluntary Changes (Unpaid Orders) OrderChange Partial Refund |
FareDetail / FareComponent / FareBasis / CabinType / CabinTypeName | Name of the cabin | Alphabetical | Any of the top row | All Services |
<FareDetail / FareComponent / FareRules>
| ||||
FareDetail / FareComponent / FareRules / Penalty AttributeCancelFeeInd | This attribute will indicate whether a cancellation or refund fee will apply. | Boolean | true/false | All Services |
FareDetail / FareComponent / FareRules / Penalty AttributeChangeFeeInd | This attribute will indicate whether a fee will be applied for any voluntary changes. | Boolean | true/false | All Services |
FareDetail / FareComponent / FareRules / Penalty AttributeRefundableInd | This attribute will indicate whether a fare is refundable or not. | Boolean | true/false | All Services |
FareDetail / FareComponent / FareRules / Penalty Attributerefs | Reference of the penalty rule that applies to the fare. | Alphanumeric | Any | All Services |
FareDetail / FareComponent / FareRules / Penalty / Details / Detail Attributerefs | References to detail of penalty
| Alphanumeric | Any | All Services |
FareDetail / FareComponent / FareRules / Penalty / Details / Detail / Type | Type of penalty applied | Alphabetical |
| All Services |
FareDetail / FareComponent / PriceClassRef | Reference to PriceClass (Branded Fare)
| Alphanumeric | Any | All Services |
FareDetail / FareComponent / TicketDesig | Ticket designator associated to the order. | Alphanumerical | Some possible examples:
| All Services |
FareDetail / FareComponent / SegmentRefs | Reference to the segment | Alphanumeric | Any | All Services |
FareDetail / TourCode | Private fare associated tour code | Alphanumeric | Any | All Services |
<Response / TicketDocInfos / TicketDocInfo> | ||||
TicketDocument AttributePrimaryDocInd | In case of conjunction tickets, this indicator will be displayed associated to the primary ticket. Also if conjunction tickets apply, all of them will be displayed inside the same “TicketDocInfo” tag as a list of associated tickets. | Alphabetical | true | All Services |
TicketDocument / TicketDocNbr | Number of the ticket | Numeric | Any | All Services |
TicketDocument / Type | Type of ticket | Alphabetical |
*Penalty EMD will only be displayed in Order Change, not in Order Retrieve after the change. |
|
TicketDocument / NumberofBooklets | Number of tickets associated in case of conjunction tickets | Numeric | 1-4 | All Services |
TicketDocument / DateOfIssue | Date of ticket issue at local office | Date | yyyy-MM-dd | All Services |
TicketDocument / TimeOfIssue | Hour of ticket issue at local office | Hour | HH:mm | All Services |
TicketDocument / Remark | Associated remark to ancillaries or seat description | Alphanumeric | Any Here some examples depending of ancillary type:
| All Services |
TicketDocument / CouponInfo / CouponNumber | Order number of the coupon | Numeric | Any | All Services |
TicketDocument / CouponInfo / FareBasisCode / Code | Code of the fare | Alphanumeric | Any | All Services |
TicketDocument / CouponInfo / CouponValid / EffectiveDatePeriod / Effective | Coupon effective date | Date | yyyy-MM-dd | All Services |
TicketDocument / CouponInfo / Status | Status of the coupon | Alphabetical | IATA Padis Codeset - List for data element 4405 (Status, coded) Here some examples of possible values:
| All Services |
TicketDocument / CouponInfo / DateOfService | Date of service | Date | yyyy-MM-dd | All Services |
TicketDocument / CouponInfo / ServiceReferences | Reference to those services included in this coupon (serviceID related) | Alphanumeric |
| All Services |
TicketDocument / CouponInfo / InConnectionWithInfo AttributeAssociateInd | Connection with info | Boolean |
| All Services |
TicketDocument / CouponInfo / InConnectionWithInfo / InConnectionDocNbr | Document in connection | Numeric | Numeric | All Services |
TicketDocument / CouponInfo / InConnectionWithInfo / InConnectionCpnNbr | Coupon in connection | Numeric | Numeric | All Services |
TicketDocument / CouponInfo / ReasonForIssuance / RFIC | Reason for Issuance | Alphabetical | Examples:
| All Services |
TicketDocument / CouponInfo / ReasonForIssuance / Code | Type of service code | Alphanumeric | Examples:
| All Services |
TicketDocument / CouponInfo / ReasonForIssuance / Description | Service description | Alphabetical | Examples:
| All Services |
TicketDocument / CouponInfo / SoldAirlineInfo / DepartureDateTime AttributeShortDate AttributeTime | Date and hour of departure | Date Hour | yyyy-MM-dd HH:mm | All Services |
TicketDocument / CouponInfo / SoldAirlineInfo / Departure / AirportCode | IATA 3 character code for the departure city/airport/station | 3 Alphanumeric | Any | All Services |
TicketDocument / CouponInfo / SoldAirlineInfo / Departure / Date | Date of departure | Date | yyyy-MM-dd | All Services |
TicketDocument / CouponInfo / SoldAirlineInfo / Departure / Time | Hour of departure | Hour | HH:mm | All Services |
TicketDocument / CouponInfo / SoldAirlineInfo / Arrival / AirportCode | IATA 3 character code for the arrival city/airport/station | 3 Alphanumeric | Any | All Services |
TicketDocument / CouponInfo / SoldAirlineInfo / MarketingCarrier / AirlineID | ID of the airline that markets the flight | Alphabetical | Any | All Services |
TicketDocument / CouponInfo / SoldAirlineInfo / MarketingCarrier / FlightNumber | Number of the airline that markets the flight | Numeric | Any | All Services |
TicketDocument / CouponInfo / SoldAirlineInfo / Status | Status of the coupon | Alphabetical | Any | All Services |
TicketDocument / CouponInfo / AddlBaggageInfo / AllowableBag AttributeNumber | Number of checked baggages allowed in fare | Numeric | Any | All Services |
TicketDocument / ReportingType | The way in which this sale has been reconciled, for billing and settlement purposes. | Alphabetical |
| All Services |
TicketDocument / Price / Total AttributeCode | Currency and total price of the document | Alphanumeric | Any | All Services |
OriginalIssueInfo / IssuingAgentID | NDC Iata number associated to the orginal ticket. | Numeric | Any | All Services |
OriginalIssueInfo / DateOfIssue | Issuance date of the original ticket. | Date | Any | All Services |
OriginalIssueInfo / LocationCode | Location of the original ticket. | Alphabetical | Any | All Services |
OriginalIssueInfo / TicketDocumentNbr | Number of the original ticket. | Numeric | Any | All Services |
PassengerReference | Ticket/EMD Passenger Reference | Alphanumeric | Any | All Services |
<Response / Commission> (Only if Sender is Real IATA) | ||||
Percentage | Percentage of the commision | Numeric | Any | All Services |
Amount | Amount of the commision | Numeric | Any | All Services |
<Response / DataLists / PassengerList / Passenger> | ||||
Passenger AttributePassengerID | Passenger Identifier PassengerID attribute value can be indicated in PassengerID attribute from AirShopping request. | Alphanumeric Alphanumeric | Any Value indicated in PassengerID attribute from AirShopping request | All Services |
PTC | Attribute Passenger Type Code | PaxType (3 Alphabetical) | All Services | |
Birthdate | Birthdate of the passenger | Date | Date depends of the PTC | All Services |
Individual / Gender | Gender of the passenger | Alphabetical |
| All Services |
Individual / NameTitle | Title of the passenger | Alphabetical |
| All Services |
Individual / GivenName | Name of the passenger | Alphabetical | Any | All Services |
Individual / Surname | Surname of the passenger If the name and surnames exceed the maximum number of characters allowed, the original name will be displayed, without trimming If agency has specified separated by a special character "@" first and second surname, it will be displayed as introduced with separator → e.g.: De la Morena@López) | Alphabetical | Any | All Services |
Individual / SurnameSuffix | Passenger suffix | Alphabetical | Any | All Services |
LoyaltyProgramAccount / Airline / AirlineDesignator | Frequent Flyer Airline ID | 2 Alphanumeric | Any | All Services |
LoyaltyProgramAccount / AccountNumber | Frequent Flyer number On Business number | Alphanumeric Alphanumeric | Any Any | All Services |
FOID / FOID_Number | Number for the document | Alphanumeric | Any | All Services |
FOID / FOID_Type | Type of the passenger ID Info | 2 Alphanumeric |
| All Services |
InfantRef | Indicates the infant in lap associated to this adult. If this tag is not indicated, the infant in lap is associated to the first adult in the Order by Iberia | Alphanumeric | Any | Highly recommended to ensure infant in lap is with correct adult. |
IdentityDocument / IdentityDocumentNumber | Number of identity document | Numeric | Any | All Services |
IdentityDocument / IdentityDocumentType | Type of document | Alphanumeric | Any
| All Services |
ContactInfoRef | Reference of passenger's contact info | Alphanumeric | Any | All Services |
Remark / Remark |
| Alphanumeric | Any | All Services |
<Response / DataLists / ContactList> | ||||
ContactInformation AttributeContactID | Id of the contact information | Alphanumeric | Any | All Services |
ContactInformation / ContactProvided / ContactType | Identifier of field that agencies can include to specify the information to include in confirmation mails.
| Alphabetical |
| All Services |
ContactInformation / ContactProvided / EmailAddress / EmailAddressValue | Email address of the contact | Alphanumeric | Any | All Services |
ContactInformation / ContactProvided / Phone / Label | Identify type of phone number | Alphabetical | Any | Order Create |
ContactInformation / ContactProvided / Phone / CountryDialingCode | Country Code associated to phone number if it is filled | Alphanumeric | Ej: (+34) | All Services |
ContactInformation / ContactProvided / Phone / PhoneNumber | Phone number of the contact | Numeric | Any | All Services |
ContactInformation / Individual / Gender | Gender of the passenger | Alphabetical |
| All Services |
ContactInformation / Individual / Surname | Concatenated Name and Surname of emergency contact | Alphabetical | Any | All Services |
<Response / DataLists / BaggageAllowanceList>
| ||||
BaggageAllowance AttributeBaggageAllowanceID | Id for the Baggage | Alphanumeric | Any | All Services |
BaggageAllowance / BaggageCategory | Identifier
| Alphabetical | Any | All Services |
BaggageAllowance / PieceAllowance Attributerefs | References to media list.
| Alphanumeric |
| All Services |
BaggageAllowance / PieceAllowance / ApplicableParty | Text "Traveler" (Identifier for all conditions) | Alphabetical | “Traveler” | All Services |
BaggageAllowance / PieceAllowance / TotalQuantity | Quantity allowed | Numeric | Any | All Services |
BaggageAllowance / PieceAllowance / BagType | Type of bag allowed | Alphabetical | Any | All Services |
BaggageAllowance / PieceAllowance / Descriptions / Description / Text | Associated quantity text | Alphanumeric | Any | All Services |
BaggageAllowance / Piece Allowance / PieceMeasurements AttributeQuantity | Quantity of piece measurements NOT USED BY IBERIA today. Included due to mandatory in Schema. PLEASE IGNORE and use BaggageAllowance / PieceAllowance / TotalQuantity | Numeric | Any | All Services |
<Response / DataLists / DescriptionList> | ||||
Description AttributeObjectKey | Type of private fare | Alphabetical | Requested product in AirShopping | All Services |
Description / Text | Description of private fare | Alphabetical | Requested product in AirShopping | All Services |
<Response / DataLists / FareList> | ||||
FareGroup Attributerefs AttributeListKey | Reference of the fare Reference of the fare basis code | Alphabetical Alphabetical | Any Any | All Services |
FareGroup / Fare / FareCode | Code for the fare | Alphanumeric | IATA PADIS Code:
| All Services |
FareGroup / FareBasisCode / Code | Code for the fare basis | Alphabetical | Any | All Services |
<Response / DataLists / FlightSegmentList / FlightSegment> | ||||
FlightSegment AttributeSegmentKey AttributeSecureFlight | ID of the segment SecureFlight = true (If it is a secure flight) | Alphanumeric | Any | All Services |
Departure / AirportCode | IATA 3 character code for the departure city/airport/station | 3 Alphanumeric | Any | All Services |
Departure / Date | Date of departure | Date | yyyy-MM-dd | All Services |
Departure / Time | Time of departure | Hour | HH:mm | All Services |
Departure / AirportName | Name of the departure city/airport/station | Alphanumeric | Any | All Services |
Departure / Terminal / Name | Name of the departure terminal at city/airport/station | Alphanumeric | Any | All Services |
Arrival / AirportCode | IATA 3 character code for the arrival city/airport/station | 3 Alphanumeric | Any | All Services |
Arrival / Date | Date of departure | Date | yyyy-MM-dd | All Services |
Arrival / Time | Time of arrival | Hour | HH:mm | All Services |
Arrival / ChangeOfDay | Change of day between departure and arrival | 1 Numeric | Any | All Services |
Arrival / AirportName | Name of the arrival city/airport/station | Alphanumeric | Any | All Services |
Arrival / Terminal / Name | Name of the arrival terminal at city/airport/station | Alphanumeric | Any | All Services |
MarketingCarrier / AirlineID | ID of the airline that markets the flight | Alphabetical | Any | All Services |
MarketingCarrier / Name | Name of the airline that markets the flight | Alphanumeric | Any | All Services |
MarketingCarrier / FlightNumber | Number of the flight | Numeric | Any | All Services |
OperatingCarrier / AirlineID | ID of the airline that operates the flight | Alphabetical | Any | All Services |
OperatingCarrier / Name | Name of the airline that operates the flight | Alphanumeric | Any | All Services |
OperatingCarrier / FlightNumber | Number of the flight | Numeric | Any | All Services |
OperatingCarrier / Disclosures / Description / Text | Description of the airline | Alphanumeric | Any | All Services |
Equipment / AircraftCode | Code of the aircraft that operates the flight | Alphanumeric | Any | All Services |
Equipment / Name | Name of the aircraft that operates the flight | Alphanumeric | Any | All Services |
FlightDetail / FlightDuration / Value | Duration of the flight | Alphanumeric | Any | All Services |
<Response / DataLists / FlightList> | ||||
Flight AttributeFlightKey | ID of the flight | Alphanumeric | Any | All Services |
Journey / Time | Duration of the flight | Alphanumeric | Any | All Services |
SegmentReferences | References for the segment | Alphanumeric | Any | All Services |
<Response / DataLists / OriginDestinationList> | ||||
OriginDestination 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) | All Services |
DepartureCode | IATA 3 character code of the departure city/airport/station | 3 Alphanumeric | Any | All Services |
ArrivalCode | IATA 3 character code of the arrival city/airport/station | 3 Alphanumeric | Any | All Services |
FlightReferences | References for the flight | Alphanumeric | Any | All Services |
<Response / DataLists / MediaList> | ||||
Media AttributeListKey | ID of the Media Item | Alphanumeric | Any | All Services |
Media / MediaLink | Http link referring to the Media Item | Alphanumeric | Any | All Services |
<Respone / DataLists / PenaltyList / Penalty>
| ||||
Penalty AttributeObjectKey | Id for the penalty | Alphanumeric | Any | All Services |
Details / Detail / Type | Type of action associated to he penalty like Cancel, Change... | Alphabetical | Any e.g.: Cancel, Change | All Services |
Details / Detail / Application | Associated Code to action refered above like Change, Cancel FAT Fare or application penalty type | Numeric | Any | All Services |
Details / Detail / Amounts / Amount / CurrencyAmountValue AttributeCode | Amount and currency for the penalty | Alphanumeric | Any | All Services |
Details / Detail / Amounts / Amount / AmountApplication | Identifies minimum and maximun penalty amount | Alphabetical | minPrice maxPrice | All Services |
<Response / DataLists / PriceClassList / PriceClass>
| ||||
PriceClass AttributePriceClassID | Price Class identificator key:
| Alphanumeric | Any | All Services |
Name | Identification name of the price class | Alphanumeric | Any | All Services |
Code | Code of the price class. | Alphanumeric | Any | All Services |
Descriptions / Description AttributeObjectKey | Identification of the description of the condition:
| Alphanumeric | Any | All Services |
Descriptions / Description / Text | Descriptive text about the condition to apply:
| Alphanumeric | Any | All Services |
<Response / DataLists / ServiceDefinitionList> | ||||
ServiceDefinition AttributeServiceDefinitionID | ID reference of the service | Alphabetical | Any (e.g.: DEAF, BAGSERVICE-1) | All Services |
ServiceDefinition / Name | Name of the service | Alphanumeric | Any | All Services |
ServiceDefinition/Encoding/RFIC | RFIC of booked ancillaries | Alphabetical | Any (e.g.: A, C) | All Services |
ServiceDefinition/Encoding/Subcode | SubCode (RFISC) of booked ancillaries | Alphanumeric | Any (e.g.: 0B5, 0GO) | All Services |
ServiceDefinition / BaggageAllowanceRef | Reference associated to hand/checked baggage included in passenger fare. | Alphanumeric | Any | All Services |
ServiceDefinition / Descriptions / Description Attributerefs | Passenger identification associated to the service | Alphanumeric | Any | All Services |
ServiceDefinition/Descriptions / Description / Text | Description of the service (Limited to 90 characters) | Alphanumeric | Any | All Services |
ServiceDefinition/BookingInstructions / Method | Method. Always value= SSR | Alphabetical | SSR | All Services |
ServiceDefinition / BookingInstructions / SSRCode | Service identification code | Alphabetical | Any (e.g.: DPNA) | All Services |
ServiceDefinition / Detail / ServiceItemQuantityRules / MaximumQuantity | Maximum quantity of service | Numeric | Any | All Services |
<Response / Metadata / Other / OtherMetadata / CurrencyMetadatas> | ||||
CurrencyMetadata AttributeMetadataKey | ID of the Metadata | Alphanumeric | Any | All Services |
CurrencyMetada / Decimals | Number of decimals | Numeric | Any | All Services |
<Response / Metadata / Other / OtherMetadata / PaymentFormMetadatas> | ||||
PaymentFormMetadata AttributeMetadataKey | ID of the Metadata | Alphanumeric | Any | Order Create and OrderChange payment (installments payment) |
PaymentFormMetadata / Text | Installments payment info | Alphanumeric | installments/n/X.XX where n=number of installments. where X.XX=interests rate in % Valid example: installments/3/0.00 | Order Create and OrderChange payment (installments payment) |
<Response / Metadata / Other / OtherMetadata / RuleMetadatas> | ||||
RuleMetadata AttributeMetadataKey | ID of the Metadata | Alphanumeric | Any | All Services |
RuleMetadata / RuleID | ID of the Metadata | Alphanumeric |
| All Services |
RuleMetadata / RuleID / Values / Value / Instruction | This indicator will display either of the following:
| Alphabetical |
| All Services |