Skip to main content

OrderList

IATA_OrderListRQ searches agency bookings and returns lightweight order summaries. Use it when you have search criteria, not a specific order ID. The current OrderRefID in the response is the Navitaire record locator, so bookings do not need to originate in Breeze Offer Order to appear in results.

Authorization

OrderList is scoped to the authenticated API key's agency code.

  • If BookingRefFilterCriteria/BookingEntity/Org/OrgID is present, it must match the API key's agency code.
  • If OrgID is omitted, Breeze searches using the API key's agency code.
  • API keys without an agency code cannot use OrderList.

Request

OrderSearchFilterCriteria supports these filters:

FieldDescription
BookingRefFilterCriteria.BookingEntity.Org.OrgIDAgency or source organization code. Case-insensitive; normalized to uppercase. Maximum 10 characters.
PaxFilterCriteria.Individual.GivenNamePassenger first name. Maximum 32 characters.
PaxFilterCriteria.Individual.SurnamePassenger surname. Maximum 32 characters.
FlightFilterCriteria.DepFilterCriteria.DepDateDeparture date in YYYY-MM-DD. Sent to Navitaire as midnight UTC for that date.
FlightFilterCriteria.DepFilterCriteria.StationCodeOrigin airport code. Case-insensitive; normalized to uppercase.
FlightFilterCriteria.ArrivalFilterCriteria.StationCodeDestination airport code. Case-insensitive; normalized to uppercase.
FlightFilterCriteria.MarketingCarrierInfoNEW.MarketingCarrierFlightNumberTextMarketing flight number.

The service does not search archives. It aggregates up to 10 upstream pages of 1000 bookings per request; if more remain, the response carries a truncation Warning (code OL1001) — refine filters such as departure date, route, or passenger name.

<?xml version="1.0"?>
<IATA_OrderListRQ xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
<DistributionChain/>
<Request>
<OrderSearchFilterCriteria xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
<BookingRefFilterCriteria>
<BookingEntity>
<Org>
<Name>Agency</Name>
<OrgID>AGENCYID</OrgID>
</Org>
</BookingEntity>
</BookingRefFilterCriteria>
<PaxFilterCriteria>
<Individual>
<GivenName>Jane</GivenName>
<Surname>Doe</Surname>
</Individual>
</PaxFilterCriteria>
<FlightFilterCriteria>
<DepFilterCriteria>
<DepDate>2026-07-10</DepDate>
<StationCode>SFO</StationCode>
</DepFilterCriteria>
<ArrivalFilterCriteria>
<StationCode>CHS</StationCode>
</ArrivalFilterCriteria>
<MarketingCarrierInfoNEW>
<CarrierDesigCode>MX</CarrierDesigCode>
<MarketingCarrierFlightNumberText>123</MarketingCarrierFlightNumberText>
</MarketingCarrierInfoNEW>
</FlightFilterCriteria>
</OrderSearchFilterCriteria>
</Request>
</IATA_OrderListRQ>

Response

MatchedOrder is omitted when no bookings match.

Each matched order can include:

FieldDescription
OrderRefIDNavitaire record locator. Use this with OrderRetrieve.
OrderStatusCodeNormalized booking status such as CONFIRMED, HELD, CANCELLED, CLOSED, or PENDING.
Dep.DepDateDeparture date, when available.
Dep.StationCodeOrigin station, when available.
PaxList.PaxPassenger name summary, when available.

The response does not include arrival data (Arrival). The IATA schema makes it optional, but when present it requires both the arrival station and the arrival date, and the arrival date is not available from the booking search — it cannot be derived from the departure date (for example, overnight flights).

<?xml version="1.0" encoding="UTF-8"?>
<IATA_OrderListRS xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
<Response xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
<MatchedOrder>
<Dep>
<DepDate>2026-07-10</DepDate>
<StationCode>SFO</StationCode>
</Dep>
<OrderRefID>ABC123</OrderRefID>
<OrderStatusCode>CONFIRMED</OrderStatusCode>
<PaxList>
<Pax>
<Individual>
<GivenName>Jane</GivenName>
<Surname>Doe</Surname>
</Individual>
<PaxID>PAX-ABC123</PaxID>
</Pax>
</PaxList>
</MatchedOrder>
</Response>
</IATA_OrderListRS>

Unsupported filters

These OrderSearchFilterCriteria children are not supported and return a 400:

  • CarrierFilterCriteria
  • CreationDateTimeFilterCriteria
  • DocFilterCriteria
  • LastModifiedDateTimeFilterCriteria
  • OrderCancellationDateFilterCriteria
  • PaxGroupFilterCriteria
  • PaymentFilterCriteria
  • ServiceFilterCriteria
  • TicketFilterCriteria
  • TravelDateFilterCriteria
  • GeneralAssociation

OrderList warnings & errors

Warnings appear as Warning elements in a successful response:

CodeMeaning
OL1001Result set truncated at the server-side page cap. Refine search filters.
CodeHTTP statusCause
ERR-1000400Malformed XML.
ERR-1003400Missing Request or OrderSearchFilterCriteria.
ERR-1004400Invalid field value, unsupported filter, invalid date, invalid station code, or over-length text.
ERR-8000401Missing or invalid API key.
ERR-8001403API key has no agency code, or request OrgID does not match the key's agency code.
ERR-8002503Authentication store unavailable.
ERR-9001500Unexpected Navitaire response shape.
ERR-9003500Booking search failed upstream.