OrderRetrieve Request Field Descriptions

/PayloadAttributes/

Field	Descripción	Tipo	Obligatorio /Optional
<VersionNumber>	The version of the protocol being used. This should be 21.3.	Decimal	Obligatorio

 

/IATA_OrderRetrieveRQ/DistributionChain/DistributionChainLink/

Field	Descripción	Tipo	Obligatorio /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	Obligatorio
<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	Obligatorio

/IATA_OrderRetrieveRQ/DistributionChain/DistributionChainLink/ParticipatingOrg/

Field	Descripción	Tipo	Obligatorio /Optional
<OrgID>	Organization code of identifier.	Token: IATA number	Obligatorio
<Name>	Name of the organization.	Token	Obligatorio

/IATA_OrderRetrieveRQ/Request/OrderValidationFilterCriteria/BookingRefFilterCriteria/

Field	Descripción	Tipo	Obligatorio /Optional
<BookingID>	Existing booking reference Identifier.	Token	Obligatorio

/IATA_OrderRetrieveRQ/Request/OrderValidationFilterCriteria/PaxFilterCriteria/Individual/

Field	Descripción	Tipo	Obligatorio /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	Obligatorio

 

OrderView Response Field Descriptions

/IATA_OrderViewRS/Response/DataLists/ContactInfoList/ContactInfo/

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

/IATA_OrderViewRS/Response/DataLists/DatedMarketingSegmentList/DatedMarketingSegment/

Field	Descripción	Tipo	Obligatorio /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	Obligatorio
<DatedOperatingSegmentRefId>	Reference to a unique identifier of a dated operating segment used in a message.	Token	Obligatorio
<CarrierDesigCode>	Airline code assigned to a carrier. Either ICAO-defined 3-character code or IATA-defined 2-character code.	Token	Obligatorio
<MarketingCarrierFlightNumberText>	The numerical designation of a flight as it is marketed by a carrier.	String	Obligatorio
<AircraftScheduledDateTime>	The Scheduled Date and Time of Arrival of the aircraft at the terminal or departure gate at an airport.	DateTime	Obligatorio
<IATA_LocationCode>	IATA 3-letter code defining the city or airport code.	Token	Obligatorio

/IATA_OrderViewRS/Response/DataLists/DatedOperatinLegList/DatedOperatingLeg/

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

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

Field	Descripción	Tipo	Obligatorio /Optional
<CarrierAircraftTypeCode>	Internal code used by an carrier to identify the type of aircraft.	Token	Obligatorio
<CarrierAircraftTypeName>	Internal name given by the carrier to this aircraft type.	String	Obligatorio

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

Field	Descripción	Tipo	Obligatorio /Optional
<CodesetNameCode>	Defines the codeset that is being used in each entry to define the codeset code and the associated value text.	Token	Opcional
<ValueText>	The textural description associated to the codeset code for a given defined codeset.	String	Opcional

/IATA_OrderViewRS/Response/DataLists/DatedOperatingSegmentList/DatedOperatingSegment/

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

/IATA_OrderViewRS/Response/DataLists/PaxJourneyList/PaxJourney/

Field	Descripción	Tipo	Obligatorio /Optional
<PaxJourneyID>	Uniquely identifies a Passenger Journey within the context of one message.	Token	Obligatorio
<PaxSegmentRefID>	Reference to a Passenger Segment ID within this message.	Token	Obligatorio

/IATA_OrderViewRS/Response/DataLists/PaxList/Pax/

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

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

Field	Descripción	Tipo	Obligatorio /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	Obligatorio
<IdentityDocTypeCode>	The type of passenger document. Examples: PT = Passport, CR = KTN.	Token	Obligatorio
<Surname>	An individual’s hereditary name common to all members of a family. Also known as family name or last name.	Token	Obligatorio
<Birthdate>	Holder's date of birth as written on the document.	Fecha	Opcional
<CitizenshipCountryCode>	ISO Country Code (can be extended by bilateral agreement in case of exceptions, e.g. Kosovo). Examples: US, FR.	Token	Opcional
<ExpiryDate>	The date the identity document expires.	Fecha	Opcional
<GenderCode>	Gender of the individual. Refer to PADIS Codeset 6353.	Token	Opcional
<GivenName>	Holder's first or given name, as written on the document. E.g. JOHN.	Token	Opcional
<IssuingCountryCode>	ISO Country Code (can be extended by bilateral agreement in case of exceptions, e.g. Kosovo). Examples: US, FR.	Token	Opcional

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

Field	Descripción	Tipo	Obligatorio /Optional
<AccountNumber>	Loyalty program account number.	Token	Opcional
<AirlineDesigCode>	Airline code assigned to a carrier.	Token	Obligatorio
<TierCode>	Loyalty Program tier code.	Token	Opcional
<TierName>	Loyalty Program tier name.	String	Opcional

/IATA_OrderViewRS/Response/DataLists/PaxSegmentList/PaxSegment/

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

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

Field	Descripción	Tipo	Obligatorio /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	Opcional
<CabinTypeName>	Name given to a cabin compartment (e.g. Business, First, Economy).	Token	Opcional

/IATA_OrderViewRS/Response/DataLists/ServiceDefinitionList/ServiceDefinition/

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

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

Field	Descripción	Tipo	Obligatorio /Optional
<FreeText>	Free Text.	String	Opcional
<SpecialServiceCode>	Code that identifies the special service.	Token	Opcional

/IATA_OrderViewRS/Response/Order/

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

/IATA_OrderViewRS/Response/Order/OrderItem/

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

/IATA_OrderViewRS/Order/OrderItem/CancelRestrictions/

Field	Descripción	Tipo	Obligatorio /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	Opcional
<AllowedModificationInd>	Flags if cancellation is allowed used in conjunction with defined date ranges.	Boolean	Opcional

/IATA_OrderViewRS/Order/OrderItem/ChangeRestrictions/

Field	Descripción	Tipo	Obligatorio /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	Opcional
<AllowedModificationInd>	Flags if change is allowed used in conjunction with defined date ranges.	Boolean	Opcional

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

Field	Descripción	Tipo	Obligatorio /Optional
<FareBasisCode>	Fare basis code.	Token	Opcional
<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	Opcional
<CabinTypeName>	Name given to a cabin compartment.	Token	Opcional

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

Field	Descripción	Tipo	Obligatorio /Optional
<BaseAmount (@CurCode)>	Total base fare amount.	Decimal	Opcional
<TotalAmount (@CurCode)>	Total monetary price amount, including all tax, surcharge, and fee amounts.	Decimal	Opcional

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

Field	Descripción	Tipo	Obligatorio /Optional
<Add1TaxCode>	A qualifier to the tax code to distinguish taxes/fees/charges with the same tax code but with different business uses.	Token	Opcional
<Amount>	Tax amount.	Decimal	Obligatorio
<DescText>	Tax short description.	String	Opcional
<TaxCode>	IATA TTBS tax code.	Token	Opcional
<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	Opcional

/IATA_OrderViewRS/Response/Order/OrderItem/Price/

Field	Descripción	Tipo	Obligatorio /Optional
<BaseAmount (@CurCode)>	Total base fare amount.	Decimal	Opcional
<TotalAmount (@CurCode)>	Total monetary price amount, including all tax, surcharge, and fee amounts.	Decimal	Opcional

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

Field	Descripción	Tipo	Obligatorio /Optional
<Add1TaxCode>	A qualifier to the tax code to distinguish taxes/fees/charges with the same tax code but with different business uses.	Token	Opcional
<Amount>	Tax amount.	Decimal	Obligatorio
<DescText>	Tax short description.	String	Opcional
<TaxCode>	IATA TTBS tax code.	Token	Opcional
<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	Opcional

/IATA_OrderViewRS/Response/Order/OrderItem/Service/

Field	Descripción	Tipo	Obligatorio /Optional
<PaxRefID>	Reference to a Passenger ID within this message.	Token	Obligatorio
<ServiceID>	Uniquely Identifies a Service within the context of one message.	Token	Obligatorio
<StatusCode>	Status of the Order Service Status instance. See ATSB Codeset OrderService for possible values.	Token	Obligatorio

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

Field	Descripción	Tipo	Obligatorio /Optional
<BookingID>	Existing booking reference identifier.	Token	Obligatorio

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

Field	Descripción	Tipo	Obligatorio /Optional
<AirlineDesigCode>	Airline code assigned to a carrier. Either ICAO-defined 3-character code or IATA-defined 2-character code.	Token	Obligatorio

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

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

/IATA_OrderViewRS/Response/Order/TotalPrice/

Field	Descripción	Tipo	Obligatorio /Optional
<BaseAmount (@CurCode)>	Total base fare amount.	Decimal	Opcional
<TotalAmount (@CurCode)>	Total monetary price amount, including all tax, surcharge, and fee amounts.	Decimal	Opcional

/IATA_OrderViewRS/Response/TicketDocInfo/

Field	Descripción	Tipo	Obligatorio /Optional
<PaxRefID>	Reference to a Passenger ID.	Token	Obligatorio

/IATA_OrderViewRS/Response/TicketDocInfo/OriginalIssueInfo/

Field	Descripción	Tipo	Obligatorio /Optional
<IssueDate>	The date that the document was originally issued.	Fecha	Opcional
<IssueTime>	The time that the document was originally issued.	Tiempo	Opcional
<AirlineDesigCode>	Airline code assigned to a carrier. Either ICAO-defined 3-character code or IATA-defined 2-character code.	Token	Obligatorio
<TicketNumber>	The document number comprised of the airline code, form code, and serial number.	String	Obligatorio
<AgencyID>	Unique Agency Seller ID. Example: CTRV.	Token	Opcional
<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	Opcional

/IATA_OrderViewRS/Response/TicketDocInfo/Ticket/

Field	Descripción	Tipo	Obligatorio /Optional
<CouponNumber>	Number assigned to the issued coupon.	Decimal	Obligatorio
<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	Opcional
<FareBasisCode>	Fare basis code as ticketed. Example: Y26.	Token	Opcional
<RemarkText>	Additional, supplementary information about the document or service.	String	Opcional
<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	Obligatorio
<TicketDocTypeCode>	Document type code as defined by PADIS 1001 (Document/ Message Name, coded).	Token	Obligatorio
<TicketNumber>	The document number comprised of the airline code, form code, and serial number.	String	Obligatorio

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

PaxSegmentRefID/

Field	Descripción	Tipo	Obligatorio /Optional
<PaxSegmentRefID>	Reference to a PaxSegmentID.	Token	Obligatorio

/IATA_OrderViewRS/Response/Warning/

Field	Descripción	Tipo	Obligatorio /Optional
<Code>	The code corresponding to the processing warning as defined by PADIS 9321.	Token	Opcional
<DescText>	Free text description of the provided warning.	String	Opcional
<LangCode>	Language code associated with the warning response.	Token	Opcional
<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	Opcional

/IATA_OrderViewRS/PayloadAttributes/

Field	Descripción	Tipo	Obligatorio /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	Obligatorio
<VersionNumber>	For all IATA versioned messages, the version of the message is indicated by a decimal value.	Decimal	Obligatorio