Order item REST API v2 (legacy)
Important
A newer version of this REST API (v2.1) is available. If you're new to this REST API, use the new version. Alternatively, if you're already using the old version, read about the differences between v2 and v2.1 so you can upgrade.
The orderItems object represents something that has been purchased as part of the order. For an airline reservation, an order item is typically one or more flight segments, or an ancillary item purchased in addition to the flight, such as excess baggage allowance or priority boarding.
The following table describes the order item attributes:
| Attribute | Type | Description | Example(s) |
|---|---|---|---|
type | string enum (uppercase with underscore if more than one word) | The type of order item. | Must be one of:"FLIGHT", "HOTEL", "CAR", "BAG", "INSURANCE", "CAR_SEAT", "MEAL", "FEE", "LOUNGE_ACCESS", "HOTEL_WIFI", "HOTEL_BREAKFAST", "SEAT_UPGRADE", "TAXI", "PARKING", "SEAT", "UPGRADE", "TRANSPORT", "OTHER", "INFLIGHT_ENTERTAINMENT", "ACTIVITY", "CARBON_OFFSET", "PAID_SUBSCRIPTION", "COMFORT_PACK", "INFLIGHT_VOUCHER", "PACKAGE", "SMS_ITINERARY", "SPECIAL_ASSISTANCE", "CHARITY_DONATION", "TRANSFER" *Deprecated:"BAGGAGE", "FEES", "SEAT_UPGRADES", "INFLIGHT_VOUCHERS" |
productId | string | The ID of the product. | "DUB-LAS" |
quantity | number | The number or quantity of the order item. | 2 |
orderedAt | ISO 8601 Date/Time UTC | The date and time the order item was made. | "2026-01-01T16:17.000Z" |
price | number (currency) | The organization’s price for the order item. | 50, 30.6, -45 |
currencyCode | 3 letter ISO 4217 | The organization’s currency code for the order item. | "EUR", "NZD", "USD" |
originalPrice | number (currency) | The unit price of the order item before conversion to the organization's currency. | 50 |
originalCurrencyCode | 3 letter ISO 4217 | The original currency code for the order item. | "EUR", "NZD", "USD" |
referenceId | string | An ID generated by the client to reference the order item. | "B94TXY-1" |
vendor | string (title case recommended) | The organization that is selling the order item. | "Company ABC" |
status | string (uppercase) | The status of the order item. | "RESERVED", "PENDING", "DECLINED", "CONFIRMED", "CANCELLED", "REFUNDED", "PURCHASED", "UNKNOWN" |
channel | string (uppercase) | The channel used in the order. | "AIRPORT_KIOSK", "BRANCH", "CALL_CENTER", "GDS", "KIOSK", "MOBILE_APP", "MOBILE_WEB", "OFFLINE", "OTA", "OTHER", "WEB" |
language | 2 letter ISO 639 language code (uppercase) | The language used when making the order. | "EN", "FR", "DE" |
name | string (title case recommended) | The name of the order item. A free text value for the name of the order item. Max limit: 128 | "Insurance" |
description | string (title case recommended) | A description of the order items. | "Family Insurance" |
flightSegments | JSON array of JSON objects | A list of flight segments associated with the order item. Only applicable for flight orders. | N/A |
Flight segment attributes:
| Attribute | Description | Type | Example(s) | Required/optional |
|---|---|---|---|---|
id | An ID to identify the flight segment. | string | "1234" | Required |
origin | The IATA airport or city origin code of the flight segment. | IATA airport or city code (uppercase) | "DUB", "LHR", "BCN" | Required |
destination | The IATA airport or city destination code of the flight segment. | IATA airport or city code (uppercase) | "DUB", "LHR", "BCN" | Required |
departureDateTime | The local departure date and time of the flight segment. You must pass this value in as the local departure date/time and include the Z at the end, even though it is not UTC time. | ISO 8601 date/time | "2026-08-23T16:17Z" | Required |
arrivalDateTime | The local arrival date and time of the flight segment. You must pass this value in as the local departure date/time and include the Z at the end, even though it is not UTC time. | ISO 8601 date/time | "2026-08-23T16:17Z" | Required |
flightNumber | The marketing flight number for the flight segment. | string | "12345" | Required |
fareClass | The fare class of the flight segment. | string (title case recommended) | "Economy", "Business", "First Class" | Required |
fareFamily | The fare family of the flight segment. | string (title case recommended) | "Economy Plus" | Optional |
bookingClass | The booking class of the flight segment. | string (uppercase) | "Y7 K5 M4 T6 E3" | Optional |
equipmentType | The equipment type of the flight segment. | string (uppercase) | "BOEING 777" | Optional |
carrier | The marketing carrier code for the flight segment. | IATA airline code (uppercase) | "EI", "FR", "BA" | Required |
originDestination | The origin and destination of the flight segment. | string (uppercase) | "DUB-JFK" | Optional |
operatingCarrier | The operating carrier code for the flight segment. | IATA airline code (uppercase) | "EI", "FR", "BA" | Optional |
operatingCarrierFlightNumber | The operating carrier flight number for the flight segment. | string | "5678" | Optional |
If you have suggestions for improving this article, let us know!