21.3 IATA_OrderRetrieveRQ

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_OrderRetrieveRQ

M

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>Channel Code</iata1:OrgID>
        </iata1:ParticipatingOrg>
        <iata1:SalesAgent>
            <iata1:SalesAgentID>AgencyID</iata1:SalesAgentID>
        </iata1:SalesAgent>
        <iata1:SalesBranch>
            <iata1:SalesBranchID>AgencyCode</iata1:SalesBranchID>
        </iata1:SalesBranch>
    </iata1:DistributionChainLink>
</iata:DistributionChain>

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

XML Example for the following elements

<iata:PayloadAttributes>

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

</iata:PayloadAttributes>

PayloadAttributes

IATA payload standard attributes.

O

VersionNumber

The version of the message 

O

Elements

Details

Mandatory/Optional

Request

Order Retrieve request information.

M

XML Example for the following elements

<iata:OrderValidationFilterCriteria>
                    <iata1:OrderFilterCriteria>
                        <iata1:OrderID>G3M386</iata1:OrderID>
                        <iata1:OwnerCode>Airline Code</iata1:OwnerCode>
                    </iata1:OrderFilterCriteria>
</iata:OrderValidationFilterCriteria>

Elements

Details

Mandatory/Optional

OrderValidationFilterCriteria

Order Validation filter criteria.

M

OrderFilterCriteria

A uniquely identified record of the agreement of one party with another to receive products and services under specified terms and conditions

O

OrderID

Carrier assigned ID which uniquely identifies a specific Order across several messages.

M

OwnerCode

Designator of Airline that owns/ assigned 

M