AirShopping Request Field Descriptions

/PayloadAttributes/

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

/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

/DistributionChain/DistributionChainLink/ParticipatingOrg/

Field	Description	Type	Required /Optional
<Name>	Name of the organization.	Token	Required
<OrgID>	IATA ID for the distributor or agency. If no IATA number, please contact us to get an authorized OrgID.	Token: IATA number	Required

/Request/PaxList/Pax/ 

Field	Description	Type	Required /Optional
<PaxID>	Uniquely identifies a Passenger within the context of one message.	String	Required
<PTC>(Passenger Type Code)	Type code applying to the Passenger which typically drives pricing (e.g. ADT, CHD, etc). Please use only ADT, since passenger will be priced as ADT as long as occupying a seat.	String	Required

/Request/FlightRequest/FlightRequestOriginDestinationsCriteria/OriginDestCriteria/OriginDepCriteria/

Field	Description	Type	Required /Optional
<IATA_LocationCode>	IATA defined code identifying a city or station.	Token	Required
<Date>	The customers requested departure date.	Date	Required

/Request/FlightRequest/FlightRequestOriginDestinationsCriteria/OriginDestCriteria/OriginArrivalCriteria/

Field	Description	Type	Required /Optional
<IATA_LocationCode>	IATA defined code identifying a city or station.	Token	Required

 

AirShopping Response Field Descriptions

/Response/DataLists/DatedMarketingSegmentList/DatedMarketingSegment/

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

/Response/DataLists/DatedOperatingLegList/DatedOperatingLeg/

Field	Description	Type	Required /Optional
<DatedOperatingLegID>	Uniquely identifies a leg within the context of one message.	Token	Required
<DistanceMeasure>	Total distance between the beginning and end stations of a leg, measured by the great circle of the earth.	Decimal	Optional
<OnGroundDuration>	Total time the aircraft remains on the Ground between this leg and the leg which immediately precedes it.	Duration	Optional

/Response/DataLists/DatedOperatingLegList/DatedOperatingLeg/AirlineTaxonomy/

Field	Description	Type	Required /Optional
<DescText>	To enable the Airline to describe the Taxonomy without the need for the Seller to refer to a specifc Taxonomy optionally.	String	Optional
<CodesetCode>	Defines the codeset code that is being used in each entry related to the specified codeset defined.	Token	Optional
<ValueText>	The textural description associated to the codeset code for a given defined codeset.	String	Optional

/Response/DataLists/DatedOperatingLegList/DatedOperatingLeg/

Field	Description	Type	Required /Optional
<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	Optional

/Response/DataLists/DatedOperatingLegList/DatedOperatingLeg/CarrierAircraftType/

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

/Response/DataLists/DatedOperatingSegmentList/DatedOperatingSegment/

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

/Response/DataList/PriceClassList/PriceClass/

Field	Description	Type	Required /Optional
<CabinTypeName>	Name given to a cabin compartment (e.g. Business, First, Economy).	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
<Name>	Price class name, also known as fare family names. Example: SUPERSAVER.	Token	Required
<FareBasisCode>	Fare basis code. Example: Y26.	Token	Optional
<PriceClassID>	Uniquely Identifies a Price Class within the context of one message.	Token	Required

/Response/DataLists/DisclosureList/Disclosure/

Field	Description	Type	Required /Optional
<DisclosureID>	Uniquely Identifies a disclosure within the context of one message.	Token	Required
<DescText>	Description text value.	String	Optional

/Response/DataLists/PaxList/Pax/

Field	Description	Type	Required /Optional
<PaxID>	Uniquely identifies a passegner within the context of one message.	Token	Required
<PTC>	Type code applying to the passenger which typically drices pricing (e.g. ADT, CHD, etc.).	String	Optional

/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

/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
<DistanceMeasure>(@unitCode)	Total distance between the beginning and end stations of a leg, measured by the great circle of the earth.	Decimal	Optional
<Duration>	Total journey time including the combined air time and connection times. In case of stopover, this may or may not include stopover durations.	Duration	Optional

/Response/DataList/OriginDestList/OriginDest/

Field	Description	Type	Required /Optional
<DestCode>	IATA defined code identifying a city or station.	Token	Required
<OriginCode>	IATA defined code identifying a city or station.	Token	Required
<OriginDestID>	Uniquely identifies an Origin Destination within the context of one message.	Token	Required
<PaxJourneyRefID>	Uniquely identifies a Passenger Journey within the context of one message.	Token	Optional

/Response/OffersGroup/CarrierOffers/Offer/

Field	Description	Type	Required /Optional
<OfferID>	Carrier assigned ID which uniquely identifies a specific Offer across several messages. Offer ID facilitates the tracking and verification of individually priced offer(s) selected from the shopping response. Only the Offer IDs of the ORA (Offer Responsible Airline) are returned in shopping responses. Offer ID is unique to each individually priced offer in the shopping response even if the offer price is zero. Offer ID may be specific to individual passengers in the offer and may be associated with a segment or a journey. The set of Offer IDs returned in a response are referenced by a Shopping Response ID.	Token	Required
/TotalPrice/<TotalAmount>(@CurCode)	Total monetary price amount, including all tax, surcharge, and fee amounts.	Decimal	Required
<OwnerCode>	Airline code assigned to a carrier. Either ICAO-defined 3-character code or IATA-defined 2-character code.	Token	Required

/Response/OffersGroup/CarrierOffers/Offer/OfferItem/

Field	Description	Type	Required /Optional
<OfferItemID>	Carrier assigned ID which exists uniquely within an Offer. Exceeding 64 characters or use of dashes is not recommended.	Token	Required
Price/<TotalAmount>(@CurCode)	Total monetary price amount, including all tax, surcharge, and fee amounts.	Decimal	Optional

/Response/OffersGroup/CarrierOffers/Offer/OfferItem/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
<PaxJourneyRefID>	Uniquely identify a Passenger Journey within the context of one message.	Token	Required

/Response/OffersGroup/CarrierOffers/Offer/OfferItem/FareDetail/

Field	Description	Type	Required /Optional
<PaxRefID>	Reference to a passenger ID.	Token	Optional
<FareTypeCode>	Fare amount type code, ex: ADC (additional charge), IT (tour inclusive), NOADC (no additional charge).	Token	Required
<PriceClassRefID>	A price point within a particular Cabin Type (sometimes referred to as 'Fare Families').	Token	Optional
<FareBasisCode>	Fare basis code. Example: Y26.	Token	Optional
<PaxSegmentRefID>	Reference to a Pax segment ID.	Token	Optional
RBD/<RBD_Code>	Code used to identify a particular RBD (e.g. P, J, W, M, etc.). (Reservation booking code).	Token	Required

/Response/OffersGroup/CarrierOffers/Offer/OfferItem/FareDetail/FareComponent/CabinType/

Field	Description	Type	Required /Optional
<CabinTypeName>	Name given to a cabin compartment (e.g. Business, First, Economy).	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

/Response/OffersGroup/CarrierOffers/Offer/OfferItem/FareDetail/FareComponent/CancelRestrictions/

Field	Description	Type	Required /Optional
<AllowedModificationInd>	Flags if cancellation is allowed used in conjunction with defined date ranges.	Boolean	Optional
<DescText>	Describes what this restriction is. e.g. cancellation allowed within dates specified with no fee.	String	Optional

/Response/OffersGroup/CarrierOffers/Offer/OfferItem/CancelRestrictions/

Field	Description	Type	Required /Optional
<AllowedModificationInd>	This flags if this condition allows any modification. If this is set to FALSE then the condition further identified by the other attributes indicates that no change is allowed.	Boolean	Optional
<DescText>	Describes what this restriction is. e.g. change allowed within dates.	String	Optional

/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