Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

SoapHeader

XML Example

<soapenv:Header>
      <api_access_key>AIRLINE_CODE-CHANNEL_CODE</api_access_key>
</soapenv:Header>

<api_access_key>

AirlineCode-Channel Code

User Guidance - Service Input Parameters

Input Parameters

Type

Optional/Mandatory

Request Object

IATA_OrderCreateRQ

M

  • <DistributionChain>

  • <PayloadAttributes>

  • <POS>

  • <Request>

<DistributionChain>

XML Example for the following elements

B2B Flow

<iata:DistributionChain>
            <!--1 or more repetitions:-->
            <iata1:DistributionChainLink>
               <iata1:Ordinal>1</iata1:Ordinal>
               <iata1:OrgRole>Carrier</iata1:OrgRole>
               <iata1:ParticipatingOrg>
                  <iata1:Name>AIRLINE NAME</iata1:Name>
                  <iata1:OrgID>AIRLINE CODE</iata1:OrgID>
               </iata1:ParticipatingOrg>
            </iata1:DistributionChainLink>
            <iata1:DistributionChainLink>
               <iata1:Ordinal>2</iata1:Ordinal>
               <iata1:OrgRole>Seller</iata1:OrgRole>
               <iata1:ParticipatingOrg>
                  <iata1:Name>CHANNEL NAME</iata1:Name>
                  <iata1:OrgID>CHANNEL CODE</iata1:OrgID>
               </iata1:ParticipatingOrg>
            </iata1:DistributionChainLink>
</iata:DistributionChain>

B2C Flow

<iata:DistributionChain>
    <!--1 or more repetitions:-->
    <iata1:DistributionChainLink>
        <iata1:Ordinal>1</iata1:Ordinal>
        <iata1:OrgRole>Carrier</iata1:OrgRole>
        <iata1:ParticipatingOrg>
                  <iata1:Name>AIRLINE NAME</iata1:Name>
                  <iata1:OrgID>AIRLINE CODE</iata1:OrgID>
          </iata1:ParticipatingOrg>
    </iata1:DistributionChainLink>
    <iata1:DistributionChainLink>
        <iata1:Ordinal>2</iata1:Ordinal>
        <iata1:OrgRole>Seller</iata1:OrgRole>
        <iata1:ParticipatingOrg>
            <iata1:Name>CHANNEL NAME</iata1:Name>
             <iata1:OrgID>AgencyCode</iata1:OrgID>
        </iata1:ParticipatingOrg>
        <iata1:SalesAgent>
            <iata1:SalesAgentID>AgencyID</iata1:SalesAgentID>
        </iata1:SalesAgent>
    </iata1:DistributionChainLink>
</iata:DistributionChain>

NB: If the Message goes through an Distributor then the ordinal 2 will be a Distributor and Seller will come as ordinal 3

Elements

Details

Optional/Mandatory

DistributionChain

The set of organizations involved in the development of the current transaction.

M

DistributionChainLink

An organization playing a participating role in an instance of a distribution channel.

M

Ordinal

The number defining the position of the distribution chain link in the distribution chain indicating the order in which the organization participated.

M

OrgRole

The distribution chain role performed by the participating organization

M

ParticipatingOrg

An organized structure set up for a particular purpose

M

Name

Name of the organization

O

OrgID

Organization code

M

SalesAgent

An individual conducting sales activities on behalf of a sales branch or organization.

O

SalesAgentID

The unique identifier of the sales agent. This value must be accompanied by the appropriate Sales Branch Identifier

M

SalesBranch

An organizational unit with responsibility over sales in a market, for a product or service and under any other specified criteria.

O

SalesBranchID

The industry wide unique identifier of the sales branch. 

M

<PayloadAttributes>

XML Example for the following elements

<iata:PayloadAttributes>

            <iata1:VersionNumber>21.3</iata1:VersionNumber>

</iata:PayloadAttributes>

Elements

Details

Mandatory/Optional

PayloadAttributes

IATA payload standard attributes.

O

VersionNumber

The version of the message 

O

<POS>

XML Example for the following elements

<iata:POS>
            <iata1:Country>
               <iata1:CountryCode>DE</iata1:CountryCode>
            </iata1:Country>
</iata:POS>

Elements

Details

Mandatory/Optional

POS

Point of Sale Information

O

Country

A nation with its own government

O

CountryCode

Country Code

O

<Request>

Elements

Details

Mandatory/Optional

Request

Order Create request information.

M

<CreateOrder>

<iata1:CreateOrder>
               <iata1:AcceptSelectedQuotedOfferList>
                  <!--1 or more repetitions:-->
                  <iata1:SelectedPricedOffer>
                     <iata1:OfferRefID>PO-eJw1jDsOgCAQBU.kYfktlGCgEyJgItW7-y3EwpliuiFrrNbMK4oQ5sgtgKxhp60TH3guOE.EkfqoEeluSEct9ZxQ2jsm9IEIgvQ7M8SybAI10zf675IxXwMRHFA_</iata1:OfferRefID>
                     <iata1:OwnerCode>AIRLINE CODE</iata1:OwnerCode>
                    <!--1 or more repetitions:-->
                     <iata1:SelectedOfferItem>
                        <iata1:OfferItemRefID>OF1_OI1-eJwzNDM1MzExNwdSxoa6-m6Gyv6ehvGGCFEjcwCIUwee</iata1:OfferItemRefID>
                        <!--1 or more repetitions:-->
                        <iata1:PaxRefID>V1_PAX.1656447765616</iata1:PaxRefID>
                     </iata1:SelectedOfferItem>
                  </iata1:SelectedPricedOffer>
               </iata1:AcceptSelectedQuotedOfferList>
            </iata1:CreateOrder>

Elements

Details

Mandatory/Optional

CreateOrder

Create Order

M

AcceptSelectedQuotedOfferList

An ability to accept selected offer items from a Quoted Offer.

M

SelectedPricedOffer

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

M

OfferRefID

Reference to the OfferItemID of the selected OfferItem 

M

OwnerCode

Designator of Airline that owns/ assigned these IDs.

M

SelectedOfferItem

OfferItem selected by the Passenger for inclusion in the requested Order. 

M

OfferItemRefID

Reference to the OfferItemID of the selected OfferItem 

M

PaxRefID

Reference to passenger(s) for which this OfferItem and selected Services

M

<DataLists>

Elements

Details

Mandatory/Optional

DataLists

Data List definition

O

<ContactInfoList>

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

Elements

Details

Mandatory/Optional

ContactInfoList

Contact info data list definition

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

Uniquely Identifies a set of Contact Information, 

O

EmailAddress

The email address which should be used for contact purposes.

O

EmailAddressText

The email address which should be used for contact purposes.

M

Individual

A single human being as distinct from a group, class, or family.

O

TitleName

A word such as Mr., Mrs., Miss or Dr that is used before an individual's name to indicate the gender, profession or marital status.

O

GivenName

A personal name given to the individual at birth and used before a family name. Also called first name. 

O

Surname

Individual's hereditary name(s) common to all members of a family. Also known as family name or last name. 

M

Phone

A telephone number

O

ContactTypeText

PADIS code list

O

CountryDialingCode

Numeric telephone dialing prefixes for the member countries of the International Telecommunication Union

O

PhoneNumber

Phone number text

O

PostalAddress

Natural or physical address used for postal service. 

O

StreetText

Street name and number

O

PostalCode

Postal Code

O

CityName

City Name

O

CountryName

Country Name

O

CountryCode

Country Code

O

<PaxList>

<iata1:PaxList>
                <!--1 or more repetitions:-->
                  <iata1:Pax>
                     <iata1:Individual>
                        <iata1:IndividualID>TEMP_ID1</iata1:IndividualID>
                        <iata1:Birthdate>1993-03-11Z</iata1:Birthdate>
                        <iata1:GenderCode>M</iata1:GenderCode>
                        <!--1 or more repetitions:-->
                        <iata1:GivenName>ABDUL</iata1:GivenName>
                        <iata1:Surname>REHUMAN</iata1:Surname>
                        <iata1:TitleName>MR</iata1:TitleName>
                     </iata1:Individual>
                     <iata1:PaxID>V1_PAX.1656447765616</iata1:PaxID>
                     <iata1:PTC>ADT</iata1:PTC>
                  </iata1:Pax>
</iata1:PaxList>

NOTE: In case of MultiPaxType scenarios if you have an Infant Pax please specify the PaxRefID( It will be the PAXID of an Adult Pax)

Elements

Details

Mandatory/Optional

PaxList

Passenger data list definition.

O

Pax

Any person except members of the crew 

M

Individual

A single human being as distinct from a group, class, or family.

O

IndividualID

Uniquely Identifies an Individual

O

Birthdate

The date on which an individual was born.

O

GenderCode

Gender of the individual.

O

GivenName

A personal name given to the individual at birth

O

Surname

Individual's hereditary name(s) common to all members of a family. 

O

TitleName

A word such as Mr., Mrs., Miss or Dr that is used before an individual's name to indicate the gender

O

PaxID

Uniquely identifies a Passenger within the context of one message.

M

PTC

Type code applying to the Passenger which typically drives pricing 

O

<PaymentFunctions>

XML Example for the following elements

<iata1:PaymentFunctions>
                <!--1 or more repetitions:-->
               <iata1:PaymentProcessingDetails>
                  <iata1:Amount CurCode="EUR">51.72</iata1:Amount>
                  <iata1:PaymentMethod>
                     <iata1:PaymentCard>
                        <iata1:CardBrandCode>MC</iata1:CardBrandCode>
                        <iata1:CardSecurityCode>/9U62/XhqbV2RCuF+jI9Jw==!$%####**^**%%$#~~~!!StlD8EsuwZD7+8eRhWevYmATPKj9ngRtX3gKFgIcDO7jbAzSmNefU

U/Gn83DIoMa4BRVLCNxVmg+QryonurBdMdtgzjfyD6vshO3gujaDm7StBYzl28fC0ESm7DXvOJtIdT/+Aj4JibfJk32HyH7XKfm0MljjYCNOKxcE7Exneuxn6gMBRrT30FM16MNFN3CF7co1XmWk

HdO1FiQB8xi57DqOwBFVkZUaRTk0kj2W1vF+wqnsfaWiwPP7yU3pAXdhu0Vw11VmC0J7jfYtkQ/TEcrrySTZF8MqU2uV6wjBTpz7c20RYBLlCxXrQgxE1VMPLLyxcYriPXBQnRXpy7EaA==!$%####**^**%

%$#~~~!!MNLfinvgOWR3RnWT</iata1:CardSecurityCode>
                        <iata1:CardHolderName>LvKD0NftVxQ5YWDbVYtyUg==!$%####**^**%%$#~~~!!YBcwDZ9v3iGWucixFneta7a7DUOErStkpRh5mmykqg9qgHFu1jXJhKsHa3wgCzCxpgsIBmkt0I63oDIQU

q3EweCIxlKQJq8E4Ska0Wrya8qreC1v6x2xioeTDrM8A/CFAk1hK7vI/AFE2lf18QqiLLJhk4hy44pzjMDaXR43tjlzV5MPWZKic9DlkGiFGRi8n878d1lKY+Aj40cZYn8nG50KQy/4IDXi73GoZVc0+6xSPExQSNOBS3dXd

UPyaVMuAZjBOJ7xDRubyed+Dg339Yqu2tKm1PqZsarkRNIEpOeoqOL+3GLT4

RBqWE86lVYwaA9GAgDsiJmDLwGJdEp/FA==!$%####**^**%%$#~~~!!KQvwm5QXC0aSyGY0</iata1:CardHolderName>
                        <iata1:ExpirationDate>iRG0IWZ/YZw8WcOt/6I5tg==!$%####**^**%%$#~~~!!Zf0R5Fctlz6ryVdXeBog+z9egm1fuj6WBnZJOmTuF9m1yVmf0+rErTj+

NtOaWftRFceaQteo1pu77V/9g0SZi0VB+3JMPBO45WaKtbrX9J+5J++Y53nPhXQZHZ1jEfyIwLOxP4BAjglXvGr/gxOz1Dh/iNwAEtsFd0o2s7kL3ZNfgFBnA2CLFazWThcFa8xvhEvRtbbZ8qYE/Rn

qsfvGf1ujRnm0u/lIQJZbLc9WbaV8+mUhXpvsghlht1RREydkOvwlzaDnkL1OflvmI5RJZPiovuDSxOQlEfhBTHHjRCN4WfmTwXuaMhD1F26vHmA17uYQJyvIaC+WoRnFFptwGg==!$%####**^

**%%$#~~~!!iOe8SXGJhW6PfTcJ</iata1:ExpirationDate>
                        <iata1:CardNumber>I3sIu+Wi2+hHj782acOV7omklMo7BB6x/LXGlNGHais=!$%####**^**%%$#~~~!!XvrRFneVZU62e

GzHZzKO/Ip2QgkfEaUR267Kp3wXbDB5yTboXv65KVgKP1p9oNl81iuIE59FKGhrinIixL6+x98ySr5BeO1S6iJp

Z8Wpg0cpOH2k8p1pEJbV8O1pPueiYSbkUS5baEfqJzWV5OnLuSxN4Y637VCJ/dcCIPOz1PZh+s9IcVl8/G

QLyaT5SnWz1NbpjOGjegGEYZBGBMmQEXH6isGlZr4xLoq+gz2V7WkcJT9R2ylGRulsDa9LbWf/obTR7Gggx1eGUe

78Ba/EuyEoeTSG7eOTw4dQ8nUTmpnLwe6y7UWtUiHPJ9iloMCmZzynfTDKGdkvdjSBOBkGbQ==!$%####**^**%%$#~~~!!JmpJEpQjjMiXaO4i</iata1:CardNumber>
                     </iata1:PaymentCard>
                  </iata1:PaymentMethod>
               </iata1:PaymentProcessingDetails>
            </iata1:PaymentFunctions>

Elements

Details

Mandatory/Optional

PaymentFunctions

Is the container of all payment relevant functions.

O

PaymentProcessingDetails

Contains data used to initiate a payment

O

Amount

The amount applied to the associated payment method.

M

PaymentMethod

Payment Processing Details Payment 

M

CardBrandCode

A two-letter code assigned according to IATA Resolution 728. 

CardSecurityCode

3-digit number printed on the signature panel on the back of the card

CardHolderName

Name of credit card holder.

ExpirationDate

Expiration Date of the card

CardNumber

The card number indicated on the payment card