IATA_OrderCreateRQ



User Guidance - Service Input Parameters

Input Parameters

Type

Optional/Mandatory

Request Object

IATA_OrderCreateRQ

M

  • <IATA_OrderCreateRQ>

    • <MessageDoc>

    • <Party>

    • <PayloadAttributes>

    • <POS>

    • <Request>

      • <CreateOrder>

      • <DataLists>

        • <ContactInfoList>

        • <PaxList> 

      • <PaymentFunctions>

<IATA_OrderCreateRQ>

XML Example for the following elements

<iata:IATA_OrderCreateRQ>

<PayloadAttributes>

XML Example for the following elements

<iata:PayloadAttributes>

       <iata:VersionNumber>19.2</iata:VersionNumber>

</iata:PayloadAttributes>

Elements

Details

Optional/Mandatory

VersionNumber

Specify NDC schema message version. Always pass 19.2

O

<POS>

XML Example for the following elements

<iata:POS>
            <iata:Country>
               <iata:CountryCode>DE</iata:CountryCode>
            </iata:Country>
            <iata:City>
               <iata:IATA_LocationCode>AYT</iata:IATA_LocationCode>
            </iata:City>
 </iata:POS>



Elements

Details

Mandatory/Optional

Country

Point of sale location information.

 

CountryCode

Country Code

M

<MessageDoc>

XML Example for the following elements

<iata:MessageDoc>

<iata:Name>NDC</iata:Name>

<iata:RefVersionNumber>19.2</iata:RefVersionNumber>

</iata:MessageDoc>

Elements

Details

Optional/Mandatory

<MessageDoc>

NDC Message Document information

O

<Name>

Document name will be always "NDC"

O

<RefVersionNumber>

It will be NDC version

O

<Party>

XML Example for the following elements

Normal bookings/B2C bookings 

<iata:Party>

   <iata:Recipient>

       <iata:ORA>

           <iata:AirlineDesigCode>XX</iata:AirlineDesigCode>

           <iata:Name>Airline Name</iata:Name>

       </iata:ORA>

   </iata:Recipient>

   <iata:Sender>

       <iata:EnabledSystem>

          <iata:Name>Guest Website</iata:Name>

          <iata:SystemID>Guest EN</iata:SystemID>

       </iata:EnabledSystem>

   </iata:Sender>

 </iata:Party>



B2B login/travel agent login

<iata:Party>

   <iata:Recipient>

       <iata:ORA>

           <iata:AirlineDesigCode>XX</iata:AirlineDesigCode>

           <iata:Name>Airline Name</iata:Name>

       </iata:ORA>

   </iata:Recipient>

   <iata:Sender>

       <iata:TravelAgency>

          <iata:AgencyID>Agency code</iata:AgencyID>

             <iata:TravelAgent>

                      <iata:TravelAgentID>Agent ID</iata:TravelAgentID>

                </iata:TravelAgent>

          </iata:TravelAgency>

       </iata:Sender>

 </iata:Party>

Elements

Details

Optional/Mandatory

Party

Party & Sender Definition:-

NDC Message/ Transaction Party(s) information. Note that information about parties is intended for business use, it is not intended for transaction authentication and routing of the message.

M

Sender

Message Sender information.

M

EnabledSystem

Used when its B2C login/ Normal login

M

Name

Name. for eg:Guest Website

O

SystemID

Channel Name

M

TravelAgency

Agent User Sender Details. Used when its B2B login/travel agent login

M

AgencyID

Agency Seller Name

M

TravelAgentID

User ID of the Agent

M

Recipient

Named Message Recipient.

M

ORA

SUPPLIER: ORA (Offer Originating Airline)

Recipient.

M

AirlineDesigCode

Airline ID

M

Name

Airline Name

M

NOTE: Channel Information is mandatory and will be fetched from the information given in the SOAP header.

Header: api_access_key

Value: AirlineCode-Channel 

For e.g. V1-Guest EN

If there is username and password append that to the Value

Value:  API access key shared by IBS

<Request>

<CreateOrder>

XML Example for the following elements

<iata:CreateOrder>
                    <iata:SelectedOffer>
                        <iata:OfferRefID>OF1-eJxVy8EKQEAQgOEnopmxO9bRgVJS2C1O--u-BVLKd-.U-szj1qMxxVYsyYNjxYIzT0tmKBsnjSaLzp6ZUaLUoauMe97-ze7hyxqU8sveyJMLRpLaW.QC9lEhDA__</iata:OfferRefID>
                        <iata:OwnerCode>XQ</iata:OwnerCode>
                        <iata:SelectedOfferItem>
                            <iata:OfferItemRefID>OF1_OI1-eJxVy8EKQEAQgOEnopmxO9bRgVJS2C1O--u-BVLKd-.U-szj1qMxxVYsyYNjxYIzT0tmKBsnjSaLzp6ZUaLUoauMe97-ze7hyxqU8sveyJMLRpLaW.QC9lEhDA__</iata:OfferItemRefID>
                            <iata:PaxRefID>V1_PAX.1</iata:PaxRefID>
                           </iata:SelectedOfferItem>
                    </iata:SelectedOffer>

</iata:CreateOrder>

Elements

Details

Optional/Mandatory

<CreateOrder>

Details of Order to be created.

M

<SelectedOffer>

Offer selected by the Passenger for requesting an Order to be created.

M

<OfferRefID>

Reference to the OfferID of the selected Offer (a standard Offer) returned in a previous shopping response.

M

<OwnerCode>

Designator of Airline that owns/ assigned these IDs.

M

<SelectedOfferItem>

OfferItem selected by the Passenger.



M

<OfferItemRefID>

Reference to the OfferItemID of the selected OfferItem (a standard Offer) returned in a previous shopping response.

M

<PaxRefID>

Reference to passenger(s) for which this OfferItem and selected Services (in case of Service Bundles) applies.

M



<DataLists>

<ContactInfoList>

XML Example for the following elements

<iata:ContactInfoList>
                  <iata:ContactInfo>
                     <iata:ContactPurposeText>HOME_PRIMARY</iata:ContactPurposeText>
                     <iata:PostalAddress>
                        <iata:StreetText>3 St. Georges Road</iata:StreetText>
                        <iata:StreetText>Clifton</iata:StreetText>
                        <iata:PostalCode>BS1 5UL</iata:PostalCode>
                        <iata:CityName>Bristol</iata:CityName>
                        <iata:CountryName>United Kingdom</iata:CountryName>
                        <iata:CountryCode>GB</iata:CountryCode>
                     </iata:PostalAddress>
                     <iata:EmailAddress>
                        <iata:EmailAddressText>abcdy@hotmail.com</iata:EmailAddressText>
                     </iata:EmailAddress>
                     <iata:Phone>
                        <iata:ContactTypeText>CELL_NUMBER</iata:ContactTypeText>
                        <iata:PhoneNumber>004412332232223</iata:PhoneNumber>
                     </iata:Phone>
                     <iata:Individual>
                        <iata:TitleName>Mr</iata:TitleName>
                        <iata:GivenName>ABDUL</iata:GivenName>
                        <iata:Surname>REHUMAN</iata:Surname>
                     </iata:Individual>
                  </iata:ContactInfo>

</iata:ContactInfoList>

Elements

Details

Optional/Mandatory

<ContactInfoList>

Defines Contact information of Passenger.

O

<ContactInfo>

The electronic or geographic address which a party has provided as the contact channel. For example, contact email, contact postal address, contact phone number.

M

<ContactPurposeText>

 Defines the contact purpose.

O



<DataLists>

<PaxList>

XML Example for the following elements 

<iata:PaxList>
                  <iata:Pax>
                     <iata:Individual>
                        <iata:IndividualID>TEMP_ID1</iata:IndividualID>
                        <iata:Birthdate>1993-03-11Z</iata:Birthdate>
                        <iata:GenderCode>M</iata:GenderCode>
                        <iata:GivenName>ABDUL</iata:GivenName>
                        <iata:Surname>REHUMAN</iata:Surname>
                        <iata:TitleName>MR</iata:TitleName>
                     </iata:Individual>
                     <iata:PaxID>V1_PAX.1</iata:PaxID>
                     <iata:PTC>ADT</iata:PTC>
                  </iata:Pax>
                  <iata:Pax>
                     <iata:Individual>
                        <iata:IndividualID>TEMP_ID1</iata:IndividualID>
                        <iata:Birthdate>1995-03-11Z</iata:Birthdate>
                        <iata:GenderCode>F</iata:GenderCode>
                        <iata:GivenName>MEHR</iata:GivenName>
                        <iata:Surname>MUHSINA</iata:Surname>
                        <iata:TitleName>MRS</iata:TitleName>
                     </iata:Individual>
                     <iata:PaxID>V1_PAX.2</iata:PaxID>
                     <iata:PTC>ADT</iata:PTC>
                  </iata:Pax>
                  <iata:Pax>
                     <iata:Individual>
                        <iata:IndividualID>TEMP_ID1</iata:IndividualID>
                        <iata:Birthdate>2014-03-11Z</iata:Birthdate>
                        <iata:GenderCode>F</iata:GenderCode>
                        <iata:GivenName>RAKIL</iata:GivenName>
                        <iata:Surname>MHOK</iata:Surname>
                        <iata:TitleName>MRS</iata:TitleName>
                     </iata:Individual>
                     <iata:PaxID>V1_PAX.3</iata:PaxID>
                     <iata:PTC>CHD</iata:PTC>
                  </iata:Pax>
                  <iata:Pax>
                     <iata:Individual>
                        <iata:IndividualID>TEMP_ID1</iata:IndividualID>
                        <iata:Birthdate>2019-03-11Z</iata:Birthdate>
                        <iata:GenderCode>F</iata:GenderCode>
                        <iata:GivenName>RAKIL</iata:GivenName>
                        <iata:Surname>MHOK</iata:Surname>
                        <iata:TitleName>MRS</iata:TitleName>
                     </iata:Individual>
                     <iata:PaxID>V1_PAX.4</iata:PaxID>
                     <iata:PaxRefID>V1_PAX.1</iata:PaxRefID>
                     <iata:PTC>INF</iata:PTC>
                  </iata:Pax>
</iata:PaxList>

Elements

Details

Optional/Mandatory

<PaxList>

List all the passengers with details as received in IATA_AirShoppingRQ

O

<Pax>

Any person except members of the crew carried or to be carried with the consent of the carrier, on board of an aircraft. Holds the attributes specific to a one booking, from shopping to fulfillment.

M

<PaxID>

Uniquely identifies a Passenger.

M

<PTC>

Type code applying to the Passenger which typically drives pricing (e.g. ADT, CHD, etc).

O

<PaymentFunctions>

XML Example for the following elements

<iata:PaymentFunctions>
               <iata:PaymentProcessingDetails>
                  <iata:Amount CurCode="EUR">2289.74</iata:Amount>
                  <iata:PaymentMethod>
                     <iata:PaymentCard>
                        <iata:CardBrandCode>VI</iata:CardBrandCode>
                        <iata:CardSecurityCode>eJ4x8Nm595aqaAgblN1bEg==%~~`%~~~~~~~%^**(%$#%LNTUiG8klRY/UwR/umQtLVWumtJXFnwX67XhYJDA92W2vmvQP8LhqSbdAagIoW8bl4cGROVfgRn3X8n5463flbDo9LM0C/GqTftNT9cikbx2lMGtihsgT/XjW19omeO2vFefnMUqj9DBcr4NP9LC0XGAED4QnhmOKdlNKUulfqSqzZ3ZtsC/975v5z1lfvUy0uze6UpopKKAIsYQOfyUSfxJf/X50h9vcAXYNun0V3JmUopcGAylzhE76k6knQSQgzQJR3YswADNtIqsnHrkFl0a+Qj7YfdkLCUi5NH8pNrPqYvR5rg/vW2oJyPgiaQv8sPr0GCXRkMzFP5s2+bQ6w==</iata:CardSecurityCode>
                        <iata:CardHolderName>DvOOpky17cWPy0adZ70svA==%~~`%~~~~~~~%^**(%$#%dF5A8TTu6ZG3lfnU8TS3gj/zhhjhdox21mG++jWAOtu9fbcEecMz8Hd+C9txHNUwLaVRHeRjPeGrN3rSr4MGZCptqFSWOjuKVGz8DAnoDZlLWZq+kPsk9lgJbNMdQ8+rZgx6483b0T56vyron2ZUJd1Jcduv55nft3PmLjqMuxkF6RGeZgCIpW+n/wdxm+SLoJg7EVrBH19jeguuNKsWzvTMO7xrO4WGFHQh+ktwIbJ1rF7Gw5c/umi8vKn0NyKSRicwpu46j2xX3z/t/WAjZSgSIG5JWEnFN5oeKBD01xWOq12DKytx9r292v5q7mQ1jSaRgJ0L++LNyJLE7KaUJw==</iata:CardHolderName>
                        <iata:ExpirationDate>JE3eTkjk0qmnaBeDzRZI3Q==%~~`%~~~~~~~%^**(%$#%O1eqHiQAXDWgIkSG25wwXCla1JW2mZq4NEqHVOyqp6dAW500b1/mwnr9uzbwJ5I3aZeXpxDeqxxSsAyvjFqSPa/i1g2X/CNsvyIif7qgB5/UDyTVbv7B3WS0cwCjohEL8Yk1630X0JT6QD01Yw2nmAtb9tZ2nPamAY78CpvURFCjsd8cKzqiirJRGO/2K1KtdBgQ12xRSAc5kAkWONMqT/Epd8KepIwUCeF2Po8ljsFVTatlMM5X1TfMQWQZhSzd5LZfCM/hp2/M47jVJksJKHzVTotCHQAkMSDuAyhKQvJjX1R3BWupbtaOKRMusCXLo0wex62cOjsIHxKB4sdwOQ==</iata:ExpirationDate>
                        <iata:CardNumber>QSvtguW4a5VlJx6b+P4NVIPd8+iaKdDOjiUUHxquYLs=%~~`%~~~~~~~%^**(%$#%HJp2uzHgy4VTW+EiY5Sbm4dBMqKN12iJi0uYWRUsTBmmSCHOyV2iZEH65qsY9HT/qIQhRwNeC4nAfvI8S4B96oBDJRkPc4GpODkjiwyPnPmPt7vxqU/F/aEXzJOe5FKi4LWisNPDo6IF7N8p0b1zJu6AEEzJV8P2kw3SCsPiC+voTkA+sB44F/Bb581rsyIh1p7iRqSWJCDO7mqJZhlkEZOIzLVzoECk+sZnL8yogMNhJJ50coySYm6zRhDQTR+d7FspluCDUIzNeylFJmoSkoUOHpxdfPmmz1qVC0/VbWGfAy3I3HStXHXbhEIpyplpm7sAERZTZ8tnKaOOrMBImQ==</iata:CardNumber>
                     </iata:PaymentCard>
                  </iata:PaymentMethod>
               </iata:PaymentProcessingDetails>
</iata:PaymentFunctions>

Elements

Details

Optional/Mandatory

<PaymentFunctions>



O

<PaymentProcessingDetailst>



M

<Amount>



M

<PaymentMethod>



O

<PaymentCard>



O





O





O

<CabinTypeCode>

Cabin Type Code as defined by PADIS codeset (e.g. 1, 2, 3, etc.)

O

<CabinTypeName>

Name given to a cabin compartment (e.g. Business, First, Economy).

O

<DatedOperatingLeg>

The nonstop operation of flight between the departure station and the arrival station.

O

<Arrival>

The arriving of the flight at the destined airport

M

<IATA_LocationCode>

IATA defined code identifying an airport.

O

<CarrierAircraftType>

Carrier defined internal grouping of aircrafts with the same form, function and specification.

O

<CarrierAircraftTypeCode>

Internal code used by an carrier to identify the type of aircraft.

O

<DatedOperatingLegID>

Uniquely identifies a Leg

O

<Dep>

Leaving of a flight from any airport.

M

<IATA_LocationCode>

IATA defined code identifying an airport.

O

<IATA_AircraftType>

Grouping of aircrafts with the same form, function and specification

O

<IATA_AircraftTypeCode>

Code assigned to an aircraft type in IATA SSIM

O

<Dep>

Leaving of a flight from any airport.

M

<AircraftScheduledDateTime>

The Scheduled Date and Time of Departure of the aircraft at the terminal or departure gate at an airport.

O

<IATA_LocationCode>

IATA defined code identifying an airport.

O

<Terminal>

The name of the terminal.

O

<Duration>

Total segment time.

O

<MarketingCarrierInfo>

Marketing flight details

M

<CarrierDesigCode>

Airline code assigned to a carrier

M

<MarketingCarrierFlightNumberText>

The numerical designation of a flight

M

<RBD_Code>

Code used to identify a particular fare class (e.g. P, J, W, M, etc.).

O

<PaxSegmentID>

Uniquely identifies a Passenger Segment

M

<PaxJourneyList>

XML Example for the following elements

 

<ns11:PaxJourneyList>

  <ns11:PaxJourney>

             <ns11:Duration>P0Y0M0DT3H25M0.000S</ns11:Duration>

             <ns11:PaxJourneyID>V1_FL.1390283009428</ns11:PaxJourneyID>

             <ns11:PaxSegmentRefID>V1_SEG.1390283009429</ns11:PaxSegmentRefID>

  </ns11:PaxJourney>                

</ns11:PaxJourneyList>

Elements

Details

Optional/Mandatory

<PaxJourneyList>

Flight List for the requested itinerary

O

<OriginDestList>

XML Example for the following elements

<ns11:OriginDestList> <ns11:OriginDest> <ns11:DestCode>AYT</ns11:DestCode> <ns11:OriginCode>FRA</ns11:OriginCode> <ns11:OriginDestID>V1_OD.1391561857018</ns11:OriginDestID> <ns11:PaxJourneyRefID>V1_FL.1391561857289</ns11:PaxJourneyRefID> <ns11:PaxJourneyRefID>V1_FL.1391561857470</ns11:PaxJourneyRefID> <ns11:PaxJourneyRefID>V1_FL.1391561857460</ns11:PaxJourneyRefID> <ns11:PaxJourneyRefID>V1_FL.1391561857400</ns11:PaxJourneyRefID> <ns11:PaxJourneyRefID>V1_FL.1391561857353</ns11:PaxJourneyRefID> <ns11:PaxJourneyRefID>V1_FL.1391561857381</ns11:PaxJourneyRefID> </ns11:OriginDest> </ns11:OriginDestList>



Elements

Details

Optional/Mandatory

<OriginDestList>

List of Origin and Destination for the requested itinerary

O

<OriginDest>

The Origin and Destination airport pair which confines a passenger journey or an aircraft flight.

M

<DestCode>

IATA defined code identifying a city or station.

M

<OriginCode>

IATA defined code identifying a city or station.

M

<OriginDestID>

Uniquely identifies an Origin Destination

O

<PaxJourneyRefID>

Uniquely identifies a Passenger Journey. It can be more than one flight which is associated to a route

O

 

Â