IATA_OrderListRQ/RS

Introduction

The IATA_OrderListRQ/RS message pair can be used to search for Orders, as long as the airline reservation system supports this. It can be done by using an external reference, that has been stored in the Order or by using passenger and flight data.

General Usage

The IATA_OrderListRQ can be executed using an external reference or flight- and passenger-related data. If the search was successful, the IATA_OrderListRS contains 1-n found Orders with their Order IDs and a short summary of their data. If the search does not return any results, an error is returned.

Please note, that the IATA_OrderListRS does not load the response data into the cache. If the client wants to execute operations based on the found Orders, the Orders have to be retrieved by using IATA_OrderRetrieveRQ.

Sample

IATA_OrderListRQ

Search with external reference

Show/Hide Request

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<IATA_OrderListRQ xmlns="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderListRQ">
    <Party>
        <Sender>
            <EnabledSystem>
                <SystemID>123456</SystemID>
            </EnabledSystem>
        </Sender>
    </Party>
    <Request>
        <OrderFilterCriteria>
            <BookingRefFilterCriteria>
                                            <BookingEntity>
                                                    <Org>
                                                            <Name>ABC</Name>
                                                            <OrgID>ABC</OrgID>
                                                    </Org>
                                            </BookingEntity>
                <BookingID>999888777</BookingID>
            </BookingRefFilterCriteria>
        </OrderFilterCriteria>
    </Request>
</IATA_OrderListRQ>

Search with passenger- and flight-data

Show/Hide Request

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<IATA_OrderListRQ xmlns="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderListRQ">
    <Party>
        <Sender>
            <EnabledSystem>
                <SystemID>123456</SystemID>
            </EnabledSystem>
        </Sender>
    </Party>
    <Request>
        <OrderFilterCriteria>
            <FlightFilterCriteria>
                <ArrivalFilterCriteria>
                    <ArrivalDate>2020-01-17</ArrivalDate>
                    <StationCode>AYT</StationCode>
                </ArrivalFilterCriteria>
                <DepFilterCriteria>
                    <DepDate>2020-01-10</DepDate>
                    <StationCode>FRA</StationCode>
                </DepFilterCriteria>
            </FlightFilterCriteria>
            <PaxFilterCriteria>
                <Individual>
                    <GivenName>John</GivenName>
                    <Surname>Doe</Surname>
                </Individual>
                <PaxID>PX1</PaxID>
            </PaxFilterCriteria>
        </OrderFilterCriteria>
    </Request>
</IATA_OrderListRQ>

IATA_OrderListRS

Show/Hide Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<IATA_OrderListRS xmlns="http://www.iata.org/IATA/2015/00/2019.2/IATA_OrderListRS">
    <Response>
        <MatchedOrder>
            <Arrival>
                <ArrivalDate>2020-01-17</ArrivalDate>
                <StationCode>AYT</StationCode>
            </Arrival>
            <Dep>
                <DepDate>2020-01-10</DepDate>
                <StationCode>FRA</StationCode>
            </Dep>
            <OrderRefID>123456</OrderRefID>
            <OrderStatusCode>OPENED</OrderStatusCode>
            <Paxs>
                <Pax>
                    <Individual>
                        <GivenName>John</GivenName>
                        <Surname>Doe</Surname>
                    </Individual>
                    <PaxID>PX1</PaxID>
                </Pax>
            </Paxs>
        </MatchedOrder>
        <MatchedOrder>
            <Arrival>
                <ArrivalDate>2020-01-17</ArrivalDate>
                <StationCode>AYT</StationCode>
            </Arrival>
            <Dep>
                <DepDate>2020-01-10</DepDate>
                <StationCode>FRA</StationCode>
            </Dep>
            <OrderRefID>234567</OrderRefID>
            <OrderStatusCode>CLOSED</OrderStatusCode>
            <Paxs>
                <Pax>
                    <Individual>
                        <GivenName>John</GivenName>
                        <Surname>Doe</Surname>
                    </Individual>
                    <PaxID>PX1</PaxID>
                </Pax>
            </Paxs>
        </MatchedOrder>
    </Response>
</IATA_OrderListRS>