Skip to main content
Home API Orchestration Support NDC News Release Notes Airline Profile Request Response Field Descriptions Air Shopping Documentation Request Response Field Descriptions Offer Price Documentation Request Response Field Descriptions Order Create Request Response Field Descriptions Order Retrieve Request Response Field Descriptions Seat Availability Documentation Request Response Field Descriptions Order Reshop Request Response Field Descriptions Order Change Request Response Field Descriptions Order Change Notification Request Response Field Descriptions

Alaska's New Distribution Capability (NDC)

SeatAvailability Request Field Descriptions

/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
<OrgID> Organization code of identifier. Token: IATA number Required
<Name> Name of the organization. Token Required

/PayloadAttributes/

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

/Request/Pax/

Field Description Type Required
/Optional
<PaxID> Uniquely identifies a Passenger within the context of one message. Token Required

/Request/Pax/Individual/

Field Description Type Required
/Optional
<Birthdate> The Date of Birth of the Passenger. Intended to be used in NDC Anonymous Shopping requests. Example: 2017-01-13. Date Required
<GivenName> A personal name given to the individual at birth and used before a family name. Also called first name. E.g. JOHN. Token Optional
<MiddleName> Individuals middle name or initial. Token Optional
<SuffixName> Individual’s name suffixes and letters. Token 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

/Request/Pax/LoyaltyProgramAccount/LoyaltyProgram/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 Optional

/Request/Pax/LoyaltyProgramAccount/

Field Description Type Required
/Optional
<AccountNumber> Loyalty Program account number. Example: ABC123456. Token Optional

/Request/SeatAvailCoreRequest/OfferRequest/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
<OwnerCode> Airline code assigned to a carrier. Either ICAO-defined 3-character code or IATA-defined 2-character code. Token Required

/Request/SeatAvailCoreRequest/OrderRequest/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

/Request/SeatAvailCoreRequest/OrderRequest/Order/OrderItem/

Field Description Type Required
/Optional
<OrderItemID> Carrier assigned ID which exists uniquely within an Order. Token Optional (leave null in the value)
<PaxRefID> Reference to a Passenger ID from a previously returned Offer. Token Optional
<OwnerCode> Airline code assigned to a carrier. Either ICAO-defined 3-character code or IATA-defined 2-character code. Token Optional

SeatAvailability Response Field Descriptions

/Response/ALaCarteOffer/

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
<OwnerCode> Airline code assigned to a carrier. Either ICAO-defined 3-character code or IATA-defined 2-character code. Token Required

/Response/ALaCarteOffer/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
<OwnerCode> Airline code assigned to a carrier. Either ICAO-defined 3-character code or IATA-defined 2-character code. Token Optional

/Response/ALaCarteOffer/OfferItem/Service/

Field Description Type Required
/Optional
<ServiceDefinitionRefID> Reference to a service definition. Token Required
<ServiceID> Uniquely Identifies a Service within the context of one message. Token Required

/Response/ALaCarteOffer/OfferItem/UnitPrice/

Field Description Type Required
/Optional
<BaseAmount> Total Base Fare Amount. Example: 200000 (@CurCode). Decimal Optional
<TotalAmount> Total monetary price amount, including all tax, surcharge, and fee amounts. (@CurCode). Decimal Optional

/Response/ALaCarteOffer/OfferItem/UnitPrice/TaxSummary/Tax/

Field Description Type Required
/Optional
<Amount> Tax amount. Example: 15000 USD (@CurCode). Decimal Required
<TaxCode> IATA TTBS Tax Code. Example: AY, GB. Token Optional
<TotalTaxAmount> Total monetary price amount, including all tax, surcharge, and fee amounts. Decimal Optional

/Response/ALaCarteOffer/OfferItem/Eligibility/OfferFlightAssociations/PaxSegmentReferences/

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

/Response/DataLists/DatedMarketingSegmentList/DatedMarketingSegment/

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
<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. Token[0-9]{1,4} Required
<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

/Response/DataLists/DatedOperatingLegList/DatedOperatingLeg/

Field Description Type Required
/Optional
<IATA_LocationCode> IATA 3-letter code defining the city or airport code. Token Required
<IATA_AircraftTypeCode> Code assigned to an aircraft type in IATA SSIM. Token[0-9A-Z]{3} Optional
<DatedOperatingLegID> Uniquely identifies a leg within the context of one message. Token Required

/Response/DataLists/DatedOperatingSegmentList/DatedOperatingSegment/

Field Description Type Required
/Optional
<DatedOperatingSegmentId> 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
<OperatingCarrierFlightNumberText> The numerical designation of a flight as it is operated by a carrier. String[0-9]{1,4} Optional
<DatedOperatingLegRefID> Uniquely identifies a leg within the context of one message. Token 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
<OperatingCarrierRBD_Code> Code used to identify a particular RBD (e.g. P, J, W, M, etc.). Token Required

/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

/Response/DataLists/PaxList/Pax/

Field Description Type Required
/Optional
<PaxID> Uniquely identifies a passenger within the context of one message. Token Required

/Response/DataLists/PaxList/Pax/Individual/

Field Description Type Required
/Optional
<GivenName> A personal name given to the individual at birth and used before a family name. Also called first name. E.g. JOHN. Token Optional
<Surname> An individual 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
<BirthDate> The date on which an individual was born. Date Optional
<IndividualID> Uniquely Identifies an Individual within the context of one message. Token Optional

/Response/DataLists/PaxList/Pax/LoyaltyProgramAccount/

Field Description Type Required
/Optional
<TierName> Loyalty Program status level name. String Optional
<AirlineDesigCode> References a Passenger Segment ID from this message or from wiithin the SeatAvailability request. Token Required
<Name> Commercial name of the carrier. Token Optional

/Response/SeatMap/

Field Description Type Required
/Optional
<PaxSegmentRefID> References a Passenger Segment ID from this message or from wiithin the SeatAvailability request. Token Required
<DatedOperatingLegRefID> References a Leg ID from wiithin the SeatAvailability request. Token Optional

/Response/SeatMap/CabinCompartment/

Field Description Type Required
/Optional
<DeckCode> Aircraft deck code (Upper, Main, Lower). Token Optional
<CabinCompartmentID> Identifier assigned by a Carrier which uniquely identifies a Cabin Compartment. Token Optional
<FirstRowNumber> First row number of the Cabin Compartment. Integer Optional
<LastRowNumber> Last row number of the Cabin Compartment. Integer Optional

/Response/SeatMap/CabinCompartment/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/SeatMap/CabinCompartment/SeatRow/

Field Description Type Required
/Optional
<RowNumber> Ordinal number identifying a seat row in an aircraft. Integer Required
<ColumnID> Alphabetic character identifying a seat within a row. Token[A-Z] Required
<OccupationStatusCode> Information related to the availability of a particular Seat on Leg.

Token:

  • F: Available
  • O: Occupied
  • Z: Blocked
 Optional
<SeatCharacteristicCode>

Characteristic of an aircraft seat e.g. A (Aisle seat), E (Exit and emergency exit),..., according to PADIS code list 9825:

Accessible = "H"
AirportAssignOnly = "40"
Blocked = "1"
BlockedForInfant = "IK"
Bulkhead = "K"
ExitRowSeat = "E"
Galley = "GN"
Inoperative = "BR"
Lavatory = "LA"
NoInfant = "1A"
NoSeat = "8"
OtherAirlinePremium = "NotSupported"
Preferential = "O"
PreferredPlus = "BK"
PremiumClass = "PE"
RestrictedRecline = "1D"
UnaccompaniedMinorRecommended = "U"
Unknown = "Unknown"
Windowless = "1W"
ZoneRestricted = "Q"
First = "FS"
Business = "BS”
Unknown = "Unknown"
Window = "W"
Middle = "MS"
Aisle = "A"

Token Optional
<RowNumber> Ordinal number identifying a seat row in an aircraft. Integer Required

/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