Skip to main content

NDC IT OrderRetrieve

Air
Reservation
REST API
Airline Carrier
Travel Agency
Try Now

What is it?

The OrderRetrieve API enables retrieval of the order that matches a requested distinct identifier, such as OrderID or booking ID.

The information returned by the OrderRetrieve API forms the complete updated version of an order in OrderViewRS.

Why use it?

The OrderRetrieve API gives you the option to retrieve an order referenced by its identifier in the following ways:

  • Allows you to retrieve an order by using the Order ID
  • Allows you to retrieve an order by using the confirmation number

How it works

OrderRetrieve using order ID

OrderRetrieve executes the following steps to retrieve the order using ID:

  • Retrieves the order details from the database using the given order ID.
  • Maps the retrieved order to the response.

OrderRetrieve using confirmation number

OrderRetrieve executes the following steps to retrieve the order confirmation number:

  • Retrieves the order details from the database using the given confirmation number.
  • Maps the retrieved order to the response.

How to use

POST /v21_3/orders/retrieve

Request: IATA_OrderRetrieveRQ

Response: IATA_OrderViewRS

Retrieve an order by ID

The following code snippet demonstrates a sample order retrieve request using the order ID with mandatory OrderID and OwnerCode.

<ns:IATA_OrderRetrieveRQ xmlns:ns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage"
                         xmlns:cns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
  <!-- DistributionChain -->
  <ns:Request>
    <cns:OrderValidationFilterCriteria>
      <cns:OrderFilterCriteria>
        <cns:OrderID>orderID</cns:OrderID>
        <cns:OwnerCode>X0</cns:OwnerCode>
      </cns:OrderFilterCriteria>
    </cns:OrderValidationFilterCriteria>
  </ns:Request>
</ns:IATA_OrderRetrieveRQ>

Retrieve an order by confirmation number

The following code snippet demonstrates a sample order retrieve request using the confirmation number with mandatory BookingID.

<ns:IATA_OrderRetrieveRQ xmlns:ns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage"
                         xmlns:cns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
  <!-- DistributionChain -->
  <ns:Request>
    <cns:OrderValidationFilterCriteria>
      <cns:BookingRefFilterCriteria>
        <cns:BookingID>confirmationNumber</cns:BookingID>
      </cns:BookingRefFilterCriteria>
    </cns:OrderValidationFilterCriteria>
  </ns:Request>
</ns:IATA_OrderRetrieveRQ>

Note: All endpoints accept NDC XML format.