Order consumer 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.
An order consumer represents a person who is consuming an order item. If the order item is a flight, the order consumer is the traveler or passenger of the flight segment. If more than one order consumer is consuming the same order item, it then has a quantity representing the number of order consumers.
| Attribute | Type | Description | Example(s) |
|---|---|---|---|
title | string (title case) | The title of the order consumer. | "Br", "Brigadier", "Capt", "Colonel", "Dame", "Dr", "Elder", "Fr", "General", "Hon", "Judge", "Lord", "Master", "Miss", "Mr", "Mrs", "Ms", "Mstr", "Prof", "Rabbi", "Rev", "Shaikha", "Sheikh", "Sir", "Sister", "Sr" |
firstName | string (title case recommended) | The first name of the order consumer. | "John" |
lastName | string (title case recommended) | The last name of the order consumer. | "Doe" |
gender | string (lowercase) | The gender of the order consumer. | "male", "female", "unknown" |
dateOfBirth | ISO 8601 Date UTC | The date of birth of the order consumer. | "1985-12-24T00:00Z" |
emails | array of strings (lowercase recommended) | The email address of the order consumer. | ["[email protected]", "[email protected]"] |
phoneNumbers | A JSON array of strings. | The phone number of the order consumer. | N/A |
nationality | string (title case recommended) | The nationality of the order consumer. | "Irish", "British", "Spanish", "French" |
country | 2 letter ISO 3166-1 Alpha-2 country code (uppercase) | The country where the order consumer is currently living. | "IE", "GB", "ES", "FR" |
passportNumber | string | The passport number for the order consumer. | "PZ4A9565" |
passportExpiry | ISO 8601 Date UTC | The expiry date for the order consumer's passport. | "2025-01-01T00:00.000Z" |
identifiers | A JSON array of JSON objects. | The list of identifiers for the guest. | N/A |
guest | object | The guest resource linked to this resource. | N/A |
orderItems | A JSON array of JSON objects | A list of one or more order items that are associated with this order consumer. | N/A |
order | string | The reference ID for the order. | "B94TXY-1" |
If you have suggestions for improving this article, let us know!