Skip to main content

IATA_OrderListRQ

Request · Order Management · Implemented

Implemented

Delivers: ORDLST Order list.

Search for orders matching criteria (passenger, dates, status…).

When to use​

When you don't have an OrderID and need to find orders.

Transport​

PropertyValue
Method & pathPOST /24.4/OrderListRQ
Content-Typeapplication/xml
AuthAuthorization: Bearer <token> (or X-API-Key: <key>)
Routing headerIATA-Message-Name: IATA_OrderListRQ

See Authentication & connection for the full handshake.

Request example​

note

✅ The example below validates against the original XSD.

<?xml version="1.0" encoding="UTF-8"?>
<IATA_OrderListRQ xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
  <DistributionChain>
    <DistributionChainLink xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
      <Ordinal>1</Ordinal>
      <OrgRole>Carrier</OrgRole>
      <ParticipatingOrg>
        <OrgID>X</OrgID>
      </ParticipatingOrg>
    </DistributionChainLink>
  </DistributionChain>
  <Request>
    <OrderSearchFilterCriteria xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes"/>
  </Request>
</IATA_OrderListRQ>

Response example​

Paired response: IATA_OrderListRS.

<?xml version="1.0" encoding="UTF-8"?>
<IATA_OrderListRS xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
  <Error>
    <LangCode xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">X</LangCode>
    <TypeCode xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">X</TypeCode>
  </Error>
</IATA_OrderListRS>

Key fields​

Top-level content model of IATA_OrderListRQ (one level deep, including inherited content):

FieldTypeRequiredRepeatableNotes
AugmentationPointxs:any——extension point (AugmentationPoint)
DistributionChainDistributionChainType✓—
PayloadAttributesIATA_PayloadStandardAttributesType——
POSPOS_Type——
RequestOrderListRequestType✓—

Build it with the SDK​

The @oms/ndc-24-4 package is a reference SDK — build, serialize, parse, and validate this message in code:

import { IATA_OrderListRQ } from '@oms/ndc-24-4';

const xml = IATA_OrderListRQ.toXML(payload, { pretty: true });
const obj = IATA_OrderListRQ.parseXML(xml);    // round-trips
IATA_OrderListRQ.schema.parse(obj);            // strict Zod validation