Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

Release 2024.04

Examples of messages with complete flows can be downloaded from here.

 New or modified element

To be removed/deprecated

Unique to v2 - Branded Fares

Unique to V1 - Fare Families

Common Sections

 Common Sections

HTTP Header

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'NDC2:HTTP Header'.

Language, Version and Name Space

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'NDC2:Language, Version and Name Space'.

Point of Sale

HEADER NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

NDC SERVICES

<PointOfSale>

Location / CountryCode

The point of sale country code.

2 letter country code

List of countries

All request messages

Document

NAME

DESCRIPTION

FORMAT

ALLOWED/POSSIBLE VALUES

NDC SERVICES

<Document>

ReferenceVersion

The IATA Schema version.

Numeric

Any

 All Services

Party

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'NDC2:Party Elements'.

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'NDC2:Party Elements'.

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'NDC2:Party Elements'.

In addition to the Common Sections, this service is called with the following data:

Query

 Query - OrderCreate

Error rendering macro 'excerpt-include' : No link could be created for 'OrderCreate'.

DataLists - PassengerList

 DataLists - PassengerList

NAME

DESCRIPTION

FORMAT

ALLOWED/ POSSIBLE VALUES

NDC SERVICES

<DataLists / PassengerList>

Passenger

Attribute

PassengerID

A unique ID for each passenger.

Alphanumeric (Maximum → 20 characters)

This attribute can be filled with any value, but first character cannot be a number digit or a special character.

AirShoppingRQ/RS

OfferPriceRQ/RS

SeatAvailabilityRS

ServiceListRS

OrderCreateRQ

OrderViewRS

OrderChangeRQ

OrderReshopRQ/RS

Passenger / PTC

Passenger Type Code

3 Alphabetical 

Type of Passengers

AirShoppingRQ/RS

OfferPriceRQ/RS

SeatAvailabilityRS

ServiceListRS

OrderCreateRQ

OrderReshopRQ

OrderChangeRQ

OrderViewRS

Passenger / BirthDate

Birthdate of the passenger

Mandatory for secure flights for all passengers.

Mandatory for CHD and INF Passengers

Date (yyyy-mm-dd)

Date depends of the PTC

OrderChangeRQ

OrderCreateRQ

OrderViewRS

Passenger / Individual

Attribute

IndividualID

ID of the passenger (within this specific message), for internal use only.

Must be unique for each passenger in the message and can be referenced in Query / DataLists / ContactList / ContactInformation / IndividualRef

Alphanumeric (Maximum → 20 characters)

This attribute can be filled with any value, but first character cannot be a number digit or a special character.

OrderChangeRQ

OrderCreateRQ

Passenger / Individual / Gender

Gender of the passenger.

In secure flight:

  • Mandatory for infant passengers

  • Mandatory for all other passengers if the title is not indicated

  • Mandatory for secure flights and infant passengers in the OrderCreate message.

Alphabetical

  • Male

  • Female

  • Unspecified

OrderCreateRQ

OrderViewRS

OrderChangeRQ

Passenger / Individual / NameTitle

Title of the passenger
NDC supports followings fields (MR, MRS, MS, MISS).

If another value is introduced no error is shown, it is ignored unless the Secure Flight is involved.

In secure flight:

  • Optional for infant passengers

  • Mandatory for all other passengers if the gender is not indicated.

  • NDC Mandatory for secure flights

Alphabetical

  • MR

  • MRS

  • MS

  • MSS

  • MISS

OrderCreateRQ

OrderViewRS

OrderChangeRQ

Passenger / Individual / GivenName

Name of the passenger (which includes all given names, including first and second names).

Alphabetical

Any

OfferPriceRQ/RS

SeatAvailabilityRS

ServiceListRS

OrderCreateRQ

OrderViewRS

OrderChangeRQ

Passenger / Individual / Surname

Surname of the passenger.

If the name and surnames exceed the maximum number of characters allowed, the original name will be displayed, without trimming.

If agency has specified separated by a special character "@" first and second surname, it will be displayed as introduced with separator → e.g.: De la Morena@López)

Mandatory for schema if 'GivenName' tag is indicated.

Alphabetical

Any

OfferPriceRQ/RS

SeatAvailabilityRS

ServiceListRS

OrderCreateRQ

OrderViewRS

OrderChangeRQ

Passenger / Individual / SurnameSuffix

Can be used to indicate that the individual holds a position, educational degree, accreditation, office, or honor.

Can be used to distinguish between two passengers with exactly the same NameTitle, GivenName and Surname (i.e. John Smith, and John Smith Jr.)

Mandatory if NameTitle, GivenName and Surname are the same for two passengers.

Alphabetical

Any

  • JR

  • SR

OrderCreateRQ

OrderViewRS

OrderChangeRQ

Passenger / LoyaltyProgramAccount / Airline / AirlineDesignator

Frequent Flyer Airline ID

Mandatory if 'LoyaltyProgramAccount' tag is indicated

Alphanumeric

Any

AirShoppingRQ/RS

OfferPriceRQ/RS

SeatAvailabilityRS

ServiceListRS

OrderCreateRQ

OrderViewRS

Passenger / LoyaltyProgramAccount / AccountNumber

Frequent Flyer number

On Business number (only to be sent in OrderCreateRQ)

Mandatory if 'LoyaltyProgramAccount' tag is indicated in OrderCreate or OrderChange

Alphanumeric

Alphanumeric

Any

Any

AirShoppingRQ/RS

OfferPriceRQ/RS

SeatAvailabilityRS

ServiceListRS

OrderCreateRQ

OrderViewRS

Passenger / FOID / FOID_Number

Number for the document

Mandatory for schema if 'FOID' tag is indicated.

Alphanumeric

PP (Passport): Any sequence of alpha numeric characters, also "-" and "." characters are accepted.

Valid examples: 1234-ABC, G.12345

NI (National ID): Only alpha numeric characters are allowed

Valid examples:

X1234567S

123456789012A

OrderChangeRQ

OrderCreateRQ

OrderViewRS

Passenger / FOID / FOID_Type

Type of the passenger ID Info

Mandatory for schema if 'FOID' tag is indicated.

2 Alphanumeric

  • PP (Passport) - Not valid for Spanish Resident and Large Family discounts

  • NI (National ID)

OrderChangeRQ

OrderCreateRQ

OrderViewRS

Passenger / InfantRef

Indicates the infant in lap associated to this adult.

If this tag is not indicated in the OrderCreateRQ, the infant in lap will be associated to the first adult in the Order automatically.

Recommended to ensure infant in lap is with correct adult.

Alphanumeric

Reference to infant PassengerID tag

OrderCreateRQ

OrderViewRS

Passenger / IdentityDocument / IdentityDocumentNumber

If Type of document is:

  • F1 - this will be the Spanish Resident certificate number 

(Optional if Spanish DNI/NIE is sent. Validated only if sent without Spanish DNI/NIE)

  • AI - this will be the Large Family certificate number

  • F - this should be the relevant fiscal information for the country.

    • The information should be sent using the following two or three elements separated by obliques "/":

      • Document Type

      • Document Number/ID

      • Company Name (optional)

    • examples:

      • "RUC/12345678X/BIG COMPANY"

      • “CUIL/9393933333

    • This fiscal information will be included on the tickets as required by local laws.

  • If any unacceptable information is sent and not included in the reservation/tickets, a warning message will be returned in the OrderViewRS.

  • Mandatory for schema if 'IdentityDocument' tag is indicated 

    NDC Mandatory for POS: PE, EC, AR and GT (FiscalID). For Infant passengers is not mandatory, so case that this document doesn’t come it will be assign the fiscal documentation from one of the Adults passengers.

Alphanumeric

  • 12 characters maximum for residence document

  • 20 characters maximum for large family document

  • 70 characters maximum for FiscalId

OrderChangeRQ

OrderCreateRQ

OrderViewRS

Passenger / IdentityDocument / IdentityDocumentType

Type of document

Mandatory for schema if 'IdentityDocument' tag is indicated  NDC Mandatory for POS: PE, EC, AR and GT (FiscalID)

2 Alphanumeric

  • F1 (Resident Discount)

  • AI (Additional information, Large Family Discount)

  • F (FiscalId)

  • Any other document

OrderChangeRQ

OrderCreateRQ

OrderViewRS

Passenger / ContactInfoRef

Reference for passenger contact info

Alphanumeric

Any

OrderChangeRQ

OrderCreateRQ

OrderViewRS

Passenger / Remark / Remark

In OrderCreate it is used to communicate the:

Municipality of residence / Community code for large family

<Remark>
  <!--Resident Discount Location Code-->
  <Remark>RESIDENT-380380</Remark>
</Remark>
<Remark>
  <!--Large Family Discount Community Code-->
  <Remark>LARGEFAMILY-380380</Remark>
</Remark>

In OrderView is is used to communicate the:

  • Type of discount applied and the Municipality/Community code for the passenger

  • Verified or not verified resident discount for passenger

<Remark>
  <Remark>RESIDENT-380380</Remark>
</Remark>
<Remark>
  <Remark>LARGEFAMILY-380380</Remark>
</Remark>
<Remark>
  <Remark>UNVERIFIED RESIDENT STATUS</Remark>
</Remark>

Mandatory for schema if 'IdentityDocument' tag is indicated.

Alphanumeric

  • RESIDENT-Code of Location

  • LARGEFAMILY-Code of Community

INE - Relación de municipios y códigos por provincias

OrderChangeRQ

OrderCreateRQ

OrderViewRS

DataLists - ContactList

 DataLists - ContactList

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'NDC2:ContactList'.

DataLists - FlightSegmentList

 DataLists - FlightSegmentList

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'NDC2:FlightSegmentList'.

DataLists - InstructionsList

 DataLists - InstructionsList

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'NDC2:InstructionsList'.

DataLists - ServiceDefinitionList

 DataLists - ServiceDefinitionList

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'NDC2:ServiceDefinitionList'.

Metadata

 Metadata - Forms of Payment

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'NDC2:Metadata'.

Example OrderCreateRQ:

 XML Sample
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Header/>
   <soapenv:Body>
      <OrderCreateRQ Version="5.000" xmlns="http://www.iata.org/IATA/EDIST/2017.2">
         <PointOfSale>
            <Location>
               <CountryCode>ES</CountryCode>
            </Location>
         </PointOfSale>
         <Document>
            <ReferenceVersion>5.000</ReferenceVersion>
         </Document>
         <Party>
            <Sender>
               <TravelAgencySender>
                  <Name>AgencyName</Name>
                  <Contacts>
                     <Contact>
                        <EmailContact>
                           <Address>ibprueb2@gmail.com</Address>
                        </EmailContact>
                        <PhoneContact>
                           <Application>BUSINESS</Application>
                           <Number>+34666554433</Number>
                        </PhoneContact>
                        <Name>
                           <Surname>Martínez</Surname>
                           <Given>Pepe</Given>
                        </Name>
                     </Contact>
                  </Contacts>
                  <IATA_Number>78298065</IATA_Number>
                  <AgencyID>INTEROPA VIAJES</AgencyID>
               </TravelAgencySender>
            </Sender>
         </Party>
         <Query>
            <Order>
               <Offer OfferID="IB700fb61f0530487abb23d62f37d536c6OC" Owner="IB" ResponseID="Qm9va2luZ0AxNjI3NDYxNzk2ODY4LUdjUmtu">
                  <OfferItem OfferItemID="IB700fb61f0530487abb23d62f37d536c6OC_01">
                     <PassengerRefs>ADULT_01 ADULT_02 ADULT_03 ADULT_04</PassengerRefs>
                  </OfferItem>
               </Offer>
               <!--Introducción de los servicios especiales-->
               <Offer OfferID="ALACARTE_SSR_IB7e5c68abeb5e482c839c6efbdf4472ac" Owner="IB" ResponseID="Qm9va2luZ0AxNjI3NDYxNzk2ODY4LUdjUmtu">
                  <OfferItem OfferItemID="IB700fb61f0530487abb23d62f37d536c6OC_DEAF">
                     <PassengerRefs>ADULT_01</PassengerRefs>
                     <ServiceSelection ServiceID="SSR_SN_c9db38dc-ada9-4955-b9db-7a16875ed74f">
                        <ServiceDefinitionID>SPECIAL_NEED-DEAF</ServiceDefinitionID>
                     </ServiceSelection>
                  </OfferItem>
                  <OfferItem OfferItemID="IB700fb61f0530487abb23d62f37d536c6OC_SVAN">
                     <PassengerRefs>ADULT_01</PassengerRefs>
                     <ServiceSelection ServiceID="SSR_SN_5e6fb112-7c1d-4242-92a4-b7b48408cacf">
                        <ServiceDefinitionID>SPECIAL_NEED-SVAN</ServiceDefinitionID>
                     </ServiceSelection>
                  </OfferItem>
               </Offer>
            </Order>
            <Payments>
               <Payment>
                  <Type>MS</Type>
                  <Method>
                     <Voucher>
                        <Number>BONO100EUR</Number>
                     </Voucher>
                  </Method>
                  <Amount Code="EUR">1243.56</Amount>
                  <Payer>
                     <ContactInfoRefs>Payer</ContactInfoRefs>
                  </Payer>
               </Payment>
               <Payment>
                  <Type>CA</Type>
                  <Method>
                     <Cash CashInd="true"/>
                  </Method>
                  <Amount Code="EUR">0</Amount>
                  <Payer>
                     <ContactInfoRefs>Payer</ContactInfoRefs>
                  </Payer>
               </Payment>
            </Payments>
            <DataLists>
               <PassengerList>
                  <Passenger PassengerID="ADULT_01">
                     <PTC>ADT</PTC>
                     <Birthdate>1993-12-23</Birthdate>
                     <Individual IndividualID="IND_ADULT_01">
                        <Gender>Male</Gender>
                        <NameTitle>MR</NameTitle>
                        <GivenName>ADULTO</GivenName>
                        <Surname>UNO PRUEBA</Surname>
                     </Individual>
                     <FOID>
                        <FOID_Number>12345678Z</FOID_Number>
                        <FOID_Type>NI</FOID_Type>
                     </FOID>
                     <ContactInfoRef>REFUSE_CONTACT</ContactInfoRef>
                  </Passenger>
                  <Passenger PassengerID="ADULT_02">
                     <PTC>ADT</PTC>
                     <Birthdate>1987-08-23</Birthdate>
                     <Individual IndividualID="IND_ADULT_02">
                        <Gender>Female</Gender>
                        <NameTitle>MRS</NameTitle>
                        <GivenName>ADULTA</GivenName>
                        <Surname>UNA PRUEBA</Surname>
                     </Individual>
                     <FOID>
                        <FOID_Number>75481546P</FOID_Number>
                        <FOID_Type>NI</FOID_Type>
                     </FOID>
                     <ContactInfoRef>REFUSE_CONTACT</ContactInfoRef>
                  </Passenger>
                  <Passenger PassengerID="ADULT_03">
                     <PTC>ADT</PTC>
                     <Birthdate>1993-12-23</Birthdate>
                     <Individual IndividualID="IND_ADULT_03">
                        <Gender>Male</Gender>
                        <NameTitle>MR</NameTitle>
                        <GivenName>ADULTO</GivenName>
                        <Surname>TRES PRUEBA</Surname>
                     </Individual>                     
                     <FOID>
                        <FOID_Number>25369424X</FOID_Number>
                        <FOID_Type>NI</FOID_Type>
                     </FOID>
                     <ContactInfoRef>REFUSE_CONTACT</ContactInfoRef>
                  </Passenger>
                  <Passenger PassengerID="ADULT_04">
                     <PTC>ADT</PTC>
                     <Birthdate>1987-08-23</Birthdate>
                     <Individual IndividualID="IND_ADULT_04">
                        <Gender>Female</Gender>
                        <NameTitle>MRS</NameTitle>
                        <GivenName>ADULTA</GivenName>
                        <Surname>CUATRO PRUEBA</Surname>
                     </Individual>
                     <FOID>
                        <FOID_Number>74582559E</FOID_Number>
                        <FOID_Type>NI</FOID_Type>
                     </FOID>
                     <ContactInfoRef>REFUSE_CONTACT</ContactInfoRef>
                  </Passenger>
               </PassengerList>
               <ContactList>
                  <ContactInformation ContactID="Payer">
                     <ContactType>Payer</ContactType>
                     <ContactProvided>
                        <EmailAddress>
                           <EmailAddressValue>pasajeroib@bylup.com</EmailAddressValue>
                        </EmailAddress>
                     </ContactProvided>
                     <IndividualRef>IND_ADULT_01</IndividualRef>
                  </ContactInformation>
                  <ContactInformation ContactID="REFUSE_CONTACT">
                     <ContactNotProvided/>
                  </ContactInformation>
               </ContactList>
               <ServiceDefinitionList>
                  <ServiceDefinition ServiceDefinitionID="SPECIAL_NEED-DEAF">
                     <Name>Deaf Passenger</Name>
                     <Descriptions>
                        <Description refs="ADULT_01">
                           <Text>Request Service Animal if travelling with one*/?()</Text>
                        </Description>
                     </Descriptions>
                     <BookingInstructions>
                        <SSRCode>DEAF</SSRCode>
                     </BookingInstructions>
                  </ServiceDefinition>
                  <ServiceDefinition ServiceDefinitionID="SPECIAL_NEED-SVAN">
                     <Name>Service Animal</Name>
                     <Descriptions>
                        <Description refs="ADULT_01">
                           <Text>Service Animal travelling in the cabin with Blind, Deaf, Disabled passengers or Certified Instructors. Specify breed and weight of animal</Text>
                        </Description>
                     </Descriptions>
                     <BookingInstructions>
                        <SSRCode>SVAN</SSRCode>
                     </BookingInstructions>
                  </ServiceDefinition>
               </ServiceDefinitionList>
            </DataLists>
         </Query>
      </OrderCreateRQ>
   </soapenv:Body>
</soapenv:Envelope>

Error messages

For further information about all kind of error messages, please go to the following link:

Error Codes

  • No labels