OrderRetrieve Request Field Descriptions

/PayloadAttributes/

Field	Description	Type	Required /Optional
<VersionNumber>	The version of the protocol being used. This should be 21.3.	Decimal	Required

 

/IATA_OrderRetrieveRQ/DistributionChain/DistributionChainLink/

Field	Description	Type	Required /Optional
<Ordinal>	The number defining the position of the distribution chain link in the distribution chain indicating the order in which the organization participated.	Integer	Required
<OrgRole>	The distribution chain role performed by the participating organization. That is, the Seller (end buyer facing), the Distributor (an intermediary), or the Carrier (the Responsible Supplier). For clarity this is different to the business model used by the participating organization, and the Nature of Business typically registered during incorporation as one of the organization's business activities.	Enumeration:  Distributor MUST BE 1 Seller MUST BE 2 Aggregator B2C: Aggregator as Distributor AND Seller OTA Direct Connect: OTA as Distributor AND Seller	Required

/IATA_OrderRetrieveRQ/DistributionChain/DistributionChainLink/ParticipatingOrg/

Field	Description	Type	Required /Optional
<OrgID>	Organization code of identifier.	Token: IATA number	Required
<Name>	Name of the organization.	Token	Required

/IATA_OrderRetrieveRQ/Request/OrderValidationFilterCriteria/BookingRefFilterCriteria/

Field	Description	Type	Required /Optional
<BookingID>	Existing booking reference Identifier.	Token	Required

/IATA_OrderRetrieveRQ/Request/OrderValidationFilterCriteria/PaxFilterCriteria/Individual/

Field	Description	Type	Required /Optional
<Surname>	Individual's hereditary name(s) common to all members of a family. Also known as family name or last name. E.g. SMITH. Excludes any potential suffix.	Token	Required

 

OrderView Response Field Descriptions

/IATA_OrderViewRS/Response/DataLists/ContactInfoList/ContactInfo/

Field	Description	Type	Required /Optional
<ContactInfoID>	Uniquely Identifies a set of Contact Information, within the context of one message.	Token	Required
<EmailAddressText>	The email address which should be used for contact purposes.	String	Required
Individual/<GivenName>	A personal name given to the individual at birth and used before a family name.	Token	Optional
Individual/<Surname>	Individual’s hereditary name common to all members of a family. Also known as family name or last name.	Token	Optional
Phone/<CountryDialingCode>	Numeric telephone dialing prefixes for the member countries of the international telecommunication union.	Token	Optional
Phone/<ExtensionNumber>	Phone extension number.	String	Optional
Phone/<PhoneNumber>	Phone number text.	String	Optional

/IATA_OrderViewRS/Response/DataLists/DatedMarketingSegmentList/DatedMarketingSegment/

Field	Description	Type	Required /Optional
<DatedMarketingSegmentId>	Unique identifier of a dated marketing segment used in a message. For the airline that is advertising and selling seats on the flight.	Token	Required
<DatedOperatingSegmentRefId>	Reference to a unique identifier of a dated operating segment used in a message.	Token	Required
<CarrierDesigCode>	Airline code assigned to a carrier. Either ICAO-defined 3-character code or IATA-defined 2-character code.	Token	Required
<MarketingCarrierFlightNumberText>	The numerical designation of a flight as it is marketed by a carrier.	String	Required
<AircraftScheduledDateTime>	The Scheduled Date and Time of Arrival of the aircraft at the terminal or departure gate at an airport.	DateTime	Required
<IATA_LocationCode>	IATA 3-letter code defining the city or airport code.	Token	Required

/IATA_OrderViewRS/Response/DataLists/DatedOperatinLegList/DatedOperatingLeg/

Field	Description	Type	Required /Optional
<DatedOperatingLegID>	Uniquely identifies a leg within the context of one message.	Token	Required
<IATA_LocationCode>	IATA 3-letter code defining the city or airport code.	Token	Required
<AircraftScheduledDateTime>	The Scheduled Date and Time of Arrival of the aircraft at the terminal or departure gate at an airport.	DateTime	Required

/IATA_OrderViewRS/Response/DataLists/DatedOperatingLegList/DatedOperatingLeg/CarrierAircraftType/

Field	Description	Type	Required /Optional
<CarrierAircraftTypeCode>	Internal code used by an carrier to identify the type of aircraft.	Token	Required
<CarrierAircraftTypeName>	Internal name given by the carrier to this aircraft type.	String	Required

/IATA_OrderViewRS/Response/DataLists/DatedOperatingLegList/DatedOperatingLeg/AirlineTaxonomy/TaxonomyFeature/

Field	Description	Type	Required /Optional
<CodesetNameCode>	Defines the codeset that is being used in each entry to define the codeset code and the associated value text.	Token	Optional
<ValueText>	The textural description associated to the codeset code for a given defined codeset.	String	Optional

/IATA_OrderViewRS/Response/DataLists/DatedOperatingSegmentList/DatedOperatingSegment/

Field	Description	Type	Required /Optional
<DatedOperatingSegmentId>	Unique identifier of a dated operating segment used in a message.	Token	Required
<OperatingCarrierFlightNumberText>	The numerical designation of a flight as it is operated by a carrier.	String	Required
<DatedOperatingLegRefID>	Uniquely identifies a leg within the context of one message.	Token	Optional
<Duration>	Total segment time including the combined air time and connection times of any legs.	Duration	Required
<CarrierDesigCode>	Airline code assigned to a carrier. Either ICAO-defined 3-character code or IATA-defined 2-character code.	Token	Required

/IATA_OrderViewRS/Response/DataLists/PaxJourneyList/PaxJourney/

Field	Description	Type	Required /Optional
<PaxJourneyID>	Uniquely identifies a Passenger Journey within the context of one message.	Token	Required
<PaxSegmentRefID>	Reference to a Passenger Segment ID within this message.	Token	Required

/IATA_OrderViewRS/Response/DataLists/PaxList/Pax/

Field	Description	Type	Required /Optional
<ContactInfoRefID>	Uniquely identifies a set of contact information, within the context of one message.	Token	Optional
<PaxID>	Uniquely identifies a passenger within the context of one message.	Token	Required
<PTC>	Type code applying to the passenger which typically drives pricing.	String	Optional
<GivenName>	A personal name given to the individual at birth and used before a family name.	Token	Optional
<IndividualID>	Uniquely Identifies an individual within the context of one message.	Token	Optional
<Surname>	Individual’s hereditary name common to all members of a family. Also known as family name or last name.	Token	Required
<GenderCode>	Gender of the individual. Refer to PADIS Codeset 6353.	Token	Optional
<Birthdate>	Holder's date of birth as written on the document.	Date	Optional
<RemarkText>	Additional, supplementary information about the document or service.	String	Optional
<RedressCaseID>	A unique government-issued identifier assigned to a redress case.	Token	Optional

/IATA_OrderViewRS/Response/DataLists/PaxList/Pax/IdentityDoc/

Field	Description	Type	Required /Optional
<IdentityDocID>	Uniquely identifies the document from all other identity documents issued by the state or organization. e.g. passport number, driver’s license number, known traveler number.	Token	Required
<IdentityDocTypeCode>	The type of passenger document. Examples: PT = Passport, CR = KTN.	Token	Required
<Surname>	An individual’s hereditary name common to all members of a family. Also known as family name or last name.	Token	Required
<Birthdate>	Holder's date of birth as written on the document.	Date	Optional
<CitizenshipCountryCode>	ISO Country Code (can be extended by bilateral agreement in case of exceptions, e.g. Kosovo). Examples: US, FR.	Token	Optional
<ExpiryDate>	The date the identity document expires.	Date	Optional
<GenderCode>	Gender of the individual. Refer to PADIS Codeset 6353.	Token	Optional
<GivenName>	Holder's first or given name, as written on the document. E.g. JOHN.	Token	Optional
<IssuingCountryCode>	ISO Country Code (can be extended by bilateral agreement in case of exceptions, e.g. Kosovo). Examples: US, FR.	Token	Optional

/IATA_OrderViewRS/Response/DataLists/PaxList/Pax/LoyaltyProgramAccount/

Field	Description	Type	Required /Optional
<AccountNumber>	Loyalty program account number.	Token	Optional
<AirlineDesigCode>	Airline code assigned to a carrier.	Token	Required
<TierCode>	Loyalty Program status level code.	Token	Optional
<TierName>	Loyalty Program status level name.	String	Optional

/IATA_OrderViewRS/Response/DataLists/PaxSegmentList/PaxSegment/

Field	Description	Type	Required /Optional
<DatedMarketingSegmentRefId>	A reference to a unique identifier of a dated marketing segment used in a message.	Token	Required
<PaxSegmentID>	Uniquely identifies a passenger segment within the context of one message.	Token	Required
<MarketingCarrierRBD_Code>	Code used to identify a particular RBD (e.g. P, J, W, M, etc.).	Token	Required

/IATA_OrderViewRS/Response/DataLists/PaxSegmentList/PaxSegment/CabinTypeAssociationChoice/SegmentCabinType/

Field	Description	Type	Required /Optional
<CabinTypeCode>	Cabin Type Code as defined by ATSB codeset 9873. For AS NDC: 1: First Class (Includinig Refundable First) 2: Business Class (Includinig Refundable Business) 4: Main (Premium Economy) 5: Main 6: Main (Saver) 7: All else	Token	Optional
<CabinTypeName>	Name given to a cabin compartment (e.g. Business, First, Economy).	Token	Optional

/IATA_OrderViewRS/Response/DataLists/ServiceDefinitionList/ServiceDefinition/

Field	Description	Type	Required /Optional
<Name>	Service name. Example: Lounge Pass.	Token	Required
<OwnerCode>	Airline code assigned to a carrier. Either ICAO-defined 3-character code or IATA-defined 2-character code.	Token	Required
<ServiceDefinitionID>	Uniquely Identifies a Service Definition within the context of one message.	Token	Required

/IATA_OrderViewRS/Response/DataLists/ServiceDefinitionList/ServiceDefinition/BookingInstructions/SpecialService/

Field	Description	Type	Required /Optional
<FreeText>	Free Text.	String	Optional
<SpecialServiceCode>	Code that identifies the special service.	Token	Optional

/IATA_OrderViewRS/Response/Order/

Field	Description	Type	Required /Optional
<OrderID>	Carrier assigned ID which uniquely identifies a specific Order across several messages.	Token	Required
<OwnerCode>	Airline code assigned to a carrier. Either ICAO-defined 3-character code or IATA-defined 2-character code.	Token	Required
<StatusCode>	Status of the Order Status instance. See ATSB Codeset OrderStatus for possible values.	Token	Optional

/IATA_OrderViewRS/Response/Order/OrderItem/

Field	Description	Type	Required /Optional
<OrderItemID>	Carrier assigned ID which exists uniquely within an order.	Token	Required
<OwnerCode>	Airline code assigned to a carrier. Either ICAO- defined 3-character code or IATA-defined 2-character code.	Token	Required
<StatusCode>	Status of the Order Item Status instance. See ATSB Codeset OrderItem for possible values.	Token	Required

/IATA_OrderViewRS/Order/OrderItem/CancelRestrictions/

Field	Description	Type	Required /Optional
<DescText>	Describes what this restriction is. E.G -Cancellation allowed within dates(1) specified with no fee. -Cancellation allowed within dates(2) specified with fee. -Cancellation not allowed.	String	Optional
<AllowedModificationInd>	Flags if cancellation is allowed used in conjunction with defined date ranges.	Boolean	Optional

/IATA_OrderViewRS/Order/OrderItem/ChangeRestrictions/

Field	Description	Type	Required /Optional
<DescText>	Describes what this restriction is. E.G -Cancellation allowed within dates(1) specified with no fee. -Cancellation allowed within dates(2) specified with fee. -Cancellation not allowed.	String	Optional
<AllowedModificationInd>	Flags if change is allowed used in conjunction with defined date ranges.	Boolean	Optional

/IATA_OrderViewRS/Response/Order/OrderItem/FareDetail/FareComponent/

Field	Description	Type	Required /Optional
<FareBasisCode>	Fare basis code.	Token	Optional
<CabinTypeCode>	Cabin Type Code as defined by ATSB codeset 9873. For AS NDC: 1: First Class (Includinig Refundable First) 2: Business Class (Includinig Refundable Business) 4: Main (Premium Economy) 5: Main 6: Main (Saver) 7: All else	Token	Optional
<CabinTypeName>	Name given to a cabin compartment.	Token	Optional

/IATA_OrderViewRS/Response/Order/OrderItem/FareDetail/Price/

Field	Description	Type	Required /Optional
<BaseAmount (@CurCode)>	Total base fare amount.	Decimal	Optional
<TotalAmount (@CurCode)>	Total monetary price amount, including all tax, surcharge, and fee amounts.	Decimal	Optional

/IATA_OrderViewRS/Response/Order/OrderItem/FareDetail/Price/TaxSummary/

Field	Description	Type	Required /Optional
<Add1TaxCode>	A qualifier to the tax code to distinguish taxes/fees/charges with the same tax code but with different business uses.	Token	Optional
<Amount>	Tax amount.	Decimal	Required
<DescText>	Tax short description.	String	Optional
<TaxCode>	IATA TTBS tax code.	Token	Optional
<TotalTaxAmount>	Total of all applicable tax amounts included in the price. If tax breakdowns are provided, this amount should match the sum of the tax breakdown amounts.	Decimal	Optional

/IATA_OrderViewRS/Response/Order/OrderItem/Price/

Field	Description	Type	Required /Optional
<BaseAmount (@CurCode)>	Total base fare amount.	Decimal	Optional
<TotalAmount (@CurCode)>	Total monetary price amount, including all tax, surcharge, and fee amounts.	Decimal	Optional

/IATA_OrderViewRS/Response/Order/OrderItem/Price/TaxSummary/

Field	Description	Type	Required /Optional
<Add1TaxCode>	A qualifier to the tax code to distinguish taxes/fees/charges with the same tax code but with different business uses.	Token	Optional
<Amount>	Tax amount.	Decimal	Required
<DescText>	Tax short description.	String	Optional
<TaxCode>	IATA TTBS tax code.	Token	Optional
<TotalTaxAmount>	Total of all applicable tax amounts included in the price. If tax breakdowns are provided, this amount should match the sum of the tax breakdown amounts.	Decimal	Optional

/IATA_OrderViewRS/Response/Order/OrderItem/Service/

Field	Description	Type	Required /Optional
<PaxRefID>	Reference to a Passenger ID within this message.	Token	Required
<ServiceID>	Uniquely Identifies a Service within the context of one message.	Token	Required
<DeliveryStatusCode>	Status of the Service Delivery Service Status instance. See ATSB Codeset DeliveryService for possible values: CANCELLED CONFIRMED REMOVED	Token	Required
<StatusCode>	Status of the Order Service Status instance. See ATSB Codeset OrderService for possible values: EXCH ACTIVE CANCELLED CLOSED CONFIRMED IN PROGRESS REMOVED	Token	Optional

/IATA_OrderViewRS/Response/Order/OrderItem/Service/BookingRef/

Field	Description	Type	Required /Optional
<BookingID>	Existing booking reference identifier.	Token	Required

/IATA_OrderViewRS/Response/Order/OrderItem/Service/BookingRef/BookingEntity/Carrier/

Field	Description	Type	Required /Optional
<AirlineDesigCode>	Airline code assigned to a carrier. Either ICAO-defined 3-character code or IATA-defined 2-character code.	Token	Required

/IATA_OrderViewRS/Response/Order/OrderItem/Service/OrderServiceAssociation/

Field	Description	Type	Required /Optional
<PaxSegmentRefID>	Reference to a PaxSegmentID.	Token	Required
<RowNumber>	Ordinal number identifying a seat row in an aircraft.	Integer	Required
<ColumnID>	Alphabetic character identifying a seat within a row.	Token Pattern [A-Z]	Required

/IATA_OrderViewRS/Response/Order/TotalPrice/

Field	Description	Type	Required /Optional
<BaseAmount (@CurCode)>	Total base fare amount.	Decimal	Optional
<TotalAmount (@CurCode)>	Total monetary price amount, including all tax, surcharge, and fee amounts.	Decimal	Optional

/IATA_OrderViewRS/Response/TicketDocInfo/

Field	Description	Type	Required /Optional
<PaxRefID>	Reference to a Passenger ID.	Token	Required
<CouponStatusCode>	Current status of the flight/ value coupon. Example: E (Exchanged/Reissued): CTRL CKIN LFTD PPR PRT OK RFND NOGO USED VOID EXCH ACTIVE CANCELLED CLOSED CONFIRMED IN PROGRESS REMOVED	Token	Optional
<ReportingTypeCode>	For billing and settlement purposes, each time a travel agent requests an airline to perform an action on a document (Issuance, Refund, Exchange), he needs to know how to reconcile this action (via BSP, ARC, directly by ORA, etc.): AIRLINE ARC BSP NotApplicable	Token	Required
<TicketDocTypeCode>	Document type code as defined by PADIS 1001 (Document/ Message Name, coded): J T	Token	Required

/IATA_OrderViewRS/Response/TicketDocInfo/OriginalIssueInfo/

Field	Description	Type	Required /Optional
<IssueDate>	The date that the document was originally issued.	Date	Optional
<IssueTime>	The time that the document was originally issued.	Time	Optional
<AirlineDesigCode>	Airline code assigned to a carrier. Either ICAO-defined 3-character code or IATA-defined 2-character code.	Token	Required
<TicketNumber>	The document number comprised of the airline code, form code, and serial number.	String	Required
<AgencyID>	Unique Agency Seller ID. Example: CTRV.	Token	Optional
<PseudoCityID>	An identifier for a corporate user of a computer reservation system (CRS) or global distribution system (GDS), typically a travel agency. Also known as Office ID.	Token	Optional

/IATA_OrderViewRS/Response/TicketDocInfo/Ticket/

Field	Description	Type	Required /Optional
<CouponNumber>	Number assigned to the issued coupon.	Decimal	Required
<CouponStatusCode>	Current status of the flight/ value coupon. Example: E (Exchanged/Reissued). OK: Confirmed CK: Checked in BD: Boarded B: Flown/Used E: Exchanged/Reissued V: Void RF: Refunded PR: Printed S: Suspended	Token	Optional
<FareBasisCode>	Fare basis code as ticketed. Example: Y26.	Token	Optional
<RemarkText>	Additional, supplementary information about the document or service.	String	Optional
<ReportingTypeCode>	For billing and settlement purposes, each time a travel agent requests an airline to perform an action on a document (Issuance, Refund, Exchange), he needs to know how to reconcile this action (via BSP, ARC, directly by ORA, etc.).	Token	Required
<TicketDocTypeCode>	Document type code as defined by PADIS 1001 (Document/ Message Name, coded).	Token	Required
<TicketNumber>	The document number comprised of the airline code, form code, and serial number.	String	Required

/IATA_OrderViewRS/Response/TicketDocInfo/Ticket/Coupon/CurrentCouponFlightInfoRef/CurrentAirlinePaxSegmentRef/

PaxSegmentRefID/

Field	Description	Type	Required /Optional
<PaxSegmentRefID>	Reference to a PaxSegmentID.	Token	Required

/IATA_OrderViewRS/Response/Warning/

Field	Description	Type	Required /Optional
<Code>	The code corresponding to the processing warning as defined by PADIS 9321.	Token	Optional
<DescText>	Free text description of the provided warning.	String	Optional
<LangCode>	Language code associated with the warning response.	Token	Optional
<TypeCode>	Uses a bilaterally agreed set of values to indicate the warning type. The validating XSD can expect to accept values that it has not been explicitly coded for and process them by using Type = 'unknown'.	Token	Optional

/IATA_OrderViewRS/PayloadAttributes/

Field	Description	Type	Required /Optional
<CorrelationID>	Allow end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.	Token	Required
<VersionNumber>	For all IATA versioned messages, the version of the message is indicated by a decimal value.	Decimal	Required