Skip to main content

OrderList

GET /json/{version}/orders searches agency bookings and returns lightweight order summaries. Use it when you have search criteria, not a specific order ID. It is the JSON counterpart of the NDC IATA_OrderListRQ. The recordLocator 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 organization code.

  • If organizationCode is present, it must match the API key's agency code.
  • If organizationCode is omitted, Breeze searches using the API key's agency code.
  • API keys without an associated organization code cannot use OrderList.

Read-only API keys can use OrderList; full transaction permissions are not required.

Request

All query parameters are optional. Unrecognized parameters are ignored.

ParameterDescription
organizationCodeAgency or source organization code. Case-insensitive; normalized to uppercase. Maximum 10 characters.
firstNamePassenger first name. Maximum 32 characters.
lastNamePassenger surname. Maximum 32 characters.
departureDateDeparture date in YYYY-MM-DD. Matches flights departing on that exact UTC date only — not before or after. To search a date range, query once per day. When omitted, results default to flights departing from yesterday (UTC) onward.
originOrigin airport code. Case-insensitive; normalized to uppercase.
destinationDestination airport code. Case-insensitive; normalized to uppercase.
flightNumberMarketing flight number.
pageSizeResults per page, 101000. Defaults to 1000.
lastIndexPagination cursor. Send page.lastIndex from the previous response; start at 0 (the default).
GET /json/v0/orders?organizationCode=AGENCYID&departureDate=2026-07-10&origin=SFO&destination=CHS&pageSize=50
Authorization: <bearer token from /auth/token>
Accept: application/json

Pagination

Fetch the first page with lastIndex=0. For each subsequent page, send the page.lastIndex value from the previous response and repeat while page.hasMore is true. page.count can be less than pageSize because duplicate journeys and past flights are filtered out server-side — do not treat a short page as the last page.

Response

data.orders is empty when no bookings match. data.page echoes pageSize and reports count (orders in this page), lastIndex (the cursor for the next page), and hasMore.

Results contain one summary per booking. For round trips, when origin or destination is supplied the summary shows the journey matching those filters. Orders without a flight date (closed bookings) are excluded.

Each order summary can include:

FieldDescription
orderIdOrder identifier. Use this with order retrieve.
recordLocatorNavitaire record locator.
statusCodeNormalized booking status: CONFIRMED, ONHOLD, CANCELLED, CLOSED, or PENDING.
departureDateDeparture date in YYYY-MM-DD, when available.
flightNumberMarketing flight number, when available.
originOrigin station, when available.
destinationDestination station, when available.
sourceOrganizationCodeOriginating organization code, when available.
passengerNamePassenger name summary (title, givenName, middleName, surname, suffix), when available.

orderId and recordLocator are always present; other fields are omitted when unknown.

{
"data": {
"orders": [
{
"orderId": "ABC123",
"recordLocator": "ABC123",
"statusCode": "CONFIRMED",
"departureDate": "2026-07-10",
"origin": "SFO",
"destination": "CHS",
"passengerName": {
"givenName": "Jane",
"surname": "Doe"
}
}
],
"page": {
"pageSize": 50,
"lastIndex": 1,
"count": 1,
"hasMore": false
}
},
"error": null
}

OrderList errors

CodeHTTP statusCause
ERR-1002404Unsupported version segment in the path.
ERR-1005422Invalid parameter value: bad date, invalid airport code, pageSize out of range, or over-length text.
ERR-8000401Missing or invalid API key or bearer token.
ERR-8001403API key has no agency code, or organizationCode does not match the key's agency code.
ERR-8002503Authentication store unavailable.
ERR-9003500Booking search failed upstream.