Order View 17.2 RS
Order View RS v17 - R2.70 - RLS 2020.03
Functional Description
The purpose of this table is to show the responses for NDC services OrderCreate, OrderChange, OrderRetrieve and AirDocIssue.
Response Body (OrderViewRS)
NAME | DESCRIPTION | FORMAT | POSSIBLE VALUES | NDC Services |
---|---|---|---|---|
Version | NDC message version | Alphanumeric | Any | All Services |
PrimaryLangID | NDC message lenguage identification | Numeric | Any (Ex: es) | All Services |
xmlns | IATA oficial website | Alphabetical | Any | All Services |
<Document> | ||||
ReferenceVersion | Version | Numeric | Any | All Services |
<Errors> | ||||
Error Attribute ShortText Attribute Code |
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 must return error but only in IBPay payments |
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 | alphanumeric | Any | All Services |
<Party / Sender / TravelAgencySender / Contacts / Contact> | ||||
EmailContact / Address | Email to contact the Agency | alphanumeric | Any | All Services |
PhoneContact / Application | Agency phone type | alphabetic |
|
All Services |
PhoneContact / Number | Phone number to contact the Agency | numeric | Any | All Services |
Name / Surname | Reference Agency contact surname | alphanumeric | Any | All Services |
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 | Alphabetic | Any |
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 | Alphabetic |
|
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 |
Sender IATA number (if you have one) | Numeric | 8 numbers |
All Services |
Participants / Participant / TravelAgencyParticipant / AgencyID |
Agency ID | Alphanumeric | Any |
All Services |
<Response / OrderViewProcesing> | ||||
Remarks / Remark DisplayInd | Boolean | true | All Services | |
Remarks / Remark |
|
Alphanumeric | Any | All Services |
MarketingMessages / MarketMessage / Text | Information message | Alphabetic | Any | All Services |
<Response / Order> | ||||
Order Attribute OrderID Attribute Owner |
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 | Any |
All Services |
BookingReferences / BookingReference / ID | External reference ID | Alphabetical | XRef | All Services |
BookingReferences / BookingReference / OtherID Attribute Name |
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 Attribute OriginalOrderID |
Original order identification
|
Alphanumeric | Any |
Order Change
|
TotalOrderPrice / DetailCurrencyPrice / Total Attribute Code |
Total price of the Order with associated currency | Numeric | Any |
All Services |
TotalOrderPrice / DetailCurrencyPrice / Taxes / Total Attribute Code |
Total taxes amount of the Order with associated currency | Numeric | Any |
All Services |
TotalOrderPrice / SimpleCurrencyPrice Attribute Code |
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 |
TimeLimits / PaymentTimeLimit Attribute DateTime |
Date for payment time limit | Date | Any |
Order Create Order Retrieve |
Status / StatusCode | Shows if the order is unserviciable (UNS) | Alphabetic |
|
Order Retrieve |
<Response / Order / OrderItems / OrderItem> | ||||
OrderItemID Attribute OrderItemID |
ID for the OrderItem | Alphanumeric | Any |
All Services |
ItemStatus |
Status for the OrderItem in Partial Refunds
|
Alphabetic |
|
Order Change |
PriceDetail / TotalAmount / SimpleCurrencyPrice Attribute Code |
Total amount of the OrderItem with associated currency | Numeric | Any |
All Services |
PriceDetail / BaseAmount Attribute Code |
Base amount of the OrderItem without taxes | Numeric | Any |
All Services |
PriceDetail / Taxes / Total Attribute Code |
Total amount of taxes of the OrderItem with associated currency | Numeric | Any |
All Services |
PriceDetail / Taxes / Breakdown / Tax / Amount Attribute Code |
Each amount of tax with associated currency | Numeric | Any |
All Services |
PriceDetail / Taxes / Breakdown / Tax / TaxCode | Code for the tax | Alphanumeric | Any |
All Services |
Service Attribute ServiceID |
ID for the Serivce | Alphanumeric | Any |
All Services |
Service / PassengerRef | Passenger Identifier | Alphanumeric | Any |
All Services |
Service / SegmentRef | Segment Identifier | Alphanumeric | Any |
All Services |
Service / ServiceDefinitionRef Attribute SegmentRef |
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 Attribute Code |
Price | Numeric | Any |
All Services |
FareDetail / Price / BaseAmount Attribute Code |
Base Price | Numeric | Any |
All Services |
FareDetail / Price / Taxes / BreakDown / Tax / Amount Attribute Code |
Tax | Numeric | Any |
All Services |
FareDetail / Price / Taxes / BreakDown / Tax / TaxCode | Tax code | Alphabetical | Any |
All Services |
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 | Code of the cabin | Alphabetical | Any | All Services |
FareDetail / FareComponent / FareBasis / CabinType / CabinTypeName | Name of the cabin | Alphabetical | Any | All Services |
FareDetail / FareComponent / TicketDesig | Ticket designator | Alphanumerical |
|
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 / TicketDocNbr | Number of the ticket | Numeric | Any |
All Services |
TicketDocument / Type | Type of ticket | Alphabetical |
|
All Services |
TicketDocument / NumberofBooklets | Number of tickets | Numeric | Any (Always 1) |
All Services |
TicketDocument / DateOfIssue | Date of ticket issue | Date | yyyy-MM-dd |
All Services |
TicketDocument / TimeOfIssue | Hour of ticket issue | Hour | HH:mm |
All Services |
TicketDocument / Remark | Associated remark to baggages pieces or seat description | Alphanumeric | Any | Order Retrieve Order Change |
TicketDocument / CouponInfo / CouponNumber | Order number of the coupon | Numeric | Any | Order Retrieve Order Change |
TicketDocument / CouponInfo / FareBasisCode / Code | Code of the fare | Alphanumeric | Any | Order Retrieve Order Change |
TicketDocument / CouponInfo / CouponValid / EffectiveDatePeriod / Effective | Coupon effective date | Date | yyyy-MM-dd | Order Retrieve Order Change |
TicketDocument / CouponInfo / Status | Status of the coupon | Alphabetical |
IATA Padis Codeset - List for data element 4405 (Status, coded) Here some examples of possible values:
|
Order Retrieve Order Change |
TicketDocument / CouponInfo / AddlBaggageInfo / AllowableBag
Attribute Number |
Number of baggages allowed in fare | Numeric | Any |
Order Retrieve Order Change |
TicketDocument / CouponInfo / DateOfService |
Date of service |
Date |
yyyy-MM-dd |
Order Retrieve Order Change |
TicketDocument / CouponInfo / InConnectionWithInfo Attribute AssociateInd |
Connection with info |
Boolean |
|
Order Change Order Retrieve |
TicketDocument / CouponInfo / InConnectionWithInfo / InConnectionDocNbr |
Document in connection |
Numeric |
Numeric |
Order Change Order Retrieve |
TicketDocument / CouponInfo / InConnectionWithInfo / InConnectionCpnNbr |
Coupon in connection |
Numeric |
Numeric |
Order Change Order Retrieve |
TicketDocument / CouponInfo / ReasonForIssuance / RFIC |
Reason for Insuance |
Alphabetic |
Examples:
|
Order Change Order Retrieve |
TicketDocument / CouponInfo / ReasonForIssuance / Code |
Type of service code |
Alphanumeric |
Examples:
|
Order Change Order Retrieve |
TicketDocument / CouponInfo / ReasonForIssuance / Description |
Service description |
Alphabetic |
Examples:
|
Order Change Order Retrieve |
TicketDocument / CouponInfo / SoldAirlineInfo / DepartureDateTime Attribute ShortDate Attribute Time |
Date and hour of departure |
Date Hour |
yyyy-MM-dd HH:mm |
Order Retrieve Order Change |
TicketDocument / CouponInfo / SoldAirlineInfo / Departure / AirportCode | IATA 3 character code for the departure city/airport/station | 3 Alphanumeric | Any |
Order Retrieve Order Change |
TicketDocument / CouponInfo / SoldAirlineInfo / Departure / Date | Date of departure | Date | yyyy-MM-dd |
Order Retrieve Order Change |
TicketDocument / CouponInfo / SoldAirlineInfo / Departure / Time | Hour of departure | Hour | HH:mm |
Order Retrieve Order Change |
TicketDocument / CouponInfo / SoldAirlineInfo / Arrival / AirportCode | IATA 3 character code for the arrival city/airport/station | 3 Alphanumeric | Any |
Order Retrieve Order Change |
TicketDocument / CouponInfo / SoldAirlineInfo / MarketingCarrier / AirlineID | ID of the airline that markets the flight | Alphabetical | Any |
Order Retrieve Order Change |
TicketDocument / CouponInfo / SoldAirlineInfo / MarketingCarrier / FlightNumber | Number of the airline that markets the flight | Numeric | Any |
Order Retrieve Order Change |
TicketDocument / CouponInfo / SoldAirlineInfo / Status | Status of the coupon | Alphabetical | Any |
Order Retrieve Order Change |
TicketDocument / CouponInfo / Add1BaggageInfo / AllowableBag Attribute Number |
Allowed bags | Numeric | Any |
Order Retrieve Order Change |
TicketDocument / ReportingType | Type of reporting | Alphabetic |
|
All Services |
TicketDocument / Price / Total Attribute Code |
Currency and total price of the document | Alphanumeric | Any |
Order Retrieve Order Change |
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 Attribute PassengerID |
Passenger Identifier | Alphanumeric | Any |
All Services |
PTC | Attribute Passenger Type Code | PaxType (3 Alphabetical) | Passenger Types |
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 / NameTittle | Title of the passenger | Alphabetical |
|
All Services |
Individual / GivenName | Name of the passenger | Alphabetical | Any |
All Services |
Individual / Surname | Surname of the passenger | Alphabetical | Any |
All Services |
Individual / SurnameSuffix | Passenger suffix | Alphabetical | Any |
All Services |
LoyaltyProgramAccount / Airline / AirlineDesignator | Airline carrier for Frecuent Flyer number | 2 Alphanumeric | Any | All Services |
LoyaltyProgramAccount / AccountNumber | Frecuent Flyer number | Numeric | 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 |
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 | Description of remark | Alphanumeric | Any |
All Services |
<Response / DataLists / ContactList> | ||||
ContactInformation Attribute ContactID |
Id of the contact information | Alphanumeric | Any |
All Services |
ContactInformation / ContactProvided / ContactType | Description of contact type | Alphanumeric | Any |
All Services |
ContactInformation / ContactProvided / EmailAddress / EmailAddressValue | Email address of the contact | Alphanumeric | Any |
All Services |
ContactInformation / ContactProvided / Phone / Label | Identify type of phone number | Alphabetic | 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 | Concatened Name and Surname of emergency contact | Alphabetic | Any |
All Services |
<Response / DataLists / DescriptionList> | ||||
Description Attribute ObjectKey |
Type of private fare | Alphabetical | Any | All Services |
Description / Text | Description of private fare | Alphabetical | Any | All Services |
<Response / DataLists / FareList> | ||||
FareGroup Attribute refs Attribute ListKey |
Reference of the fare Referece 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 Attribute SegmentKey |
ID of the segment | 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 Attribute FlightKey |
ID of the flight | Alphanumeric | Any |
All Services |
Journey / Time | Duration of the flight | Alphanumeric | Any |
All Services |
SegmentReferences | References for the segments | Alphanumeric | Any |
All Services |
<Response / DataLists / OriginDestinationList> | ||||
OriginDestination Attribute OriginDestinationKey |
ID of the origin-destination | Alphanumeric | Any |
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 Attribute ListKey |
ID of the Media Item | Alphanumeric | Any |
All Services |
Media / MediaLink | Http link referring to the Media Item | Alphanumeric | Any |
All Services |
<Response / DataLists / ServiceDefinitionList> | ||||
ServiceDefinition Attribute ServiceDefinitionID |
ID reference of the service | Alphabetical | Any (Ex: DEAF, BAGSERVICE-1) |
All Services |
Name | Name of the service | Alphanumeric | Any |
All Services |
Descriptions / Description Attribute refs |
Passenger identification associated to the service | Alphanumeric | Any |
All Services |
Descriptions / Description / Text | Description of the service (Limited to 90 characters) | Alphanumeric | Any |
All Services |
BookingInstructions / SSRCode | Service identification code | Alphabetical | Any (Ex: DPNA) |
All Services |
<Response / Metadata / Other / OtherMetadata / CurrencyMetadatas> | ||||
CurrencyMetadata Attribute MetadataKey |
ID of the Metadata | Alphanumeric | Any |
All Services |
CurrencyMetada / Decimals | Number of decimals | Numeric | Any |
All Services |