v1

latestOpenAPI 3.0.32026-07-14133451.7 KB

Booking

Create a booking order of specific flight

An OrderResponse containing the booking Order with an unique orderId will be returned along with totalAmount in particular currency, given an booking Order including the checkId previously returned, and information of Customer and information of each Passenger.

An optional extended map of key:value pairs can be used to assoicate certain custom data with this particular request for future tracking.

For example, it is recommended to pass a client side order ID to this extended map, so later when a response is returned it is convenient to identify the corresponding order at client side.

post/booking/orders

Request body

orderIdstring

UUID

createdAtstring date-time

Creation date/time of the booking order in ISO 8601 format (UTC)

currencystring

3-letter currency code in ISO 4217 format

totalAmountnumber

Total price amount of all passengers for the flight, including tax and miscellaneous fees.

checkIdstring required

UUID

extendedExtended

Extended data from client side to associate. This is useful for storing some information later needs to be retrieved, such as client side order ID. The data is in form of key:value pairs. All data will be returned in response.

Example request

{
  "orderId": "a7dd1cf6-dc96-490b-bdf6-8685dbf5bb87",
  "currency": "EUR",
  "totalAmount": 456.78,
  "checkId": "23246c8e-11ad-4105-845b-07ad855649c3",
  "customer": {
    "firstName": "Peter",
    "lastName": "Parker",
    "phoneCountryCode": "+1",
    "phoneNumber": "1234567890",
    "email": "peter_parker@yahoo.com"
  },
  "passengers": [
    {
      "firstName": "Peter",
      "lastName": "Parker",
      "birthday": "2001-01-01",
      "travelDocument": {
        "number": "EG12345678",
        "placeOfIssue": "USA"
      }
    }
  ],
  "extended": {
    "clientsideOrderId": "O1234",
    "clientsideCustomField1": "A",
    "clientsideCustomField2": "B",
    "clientsideCustomField3": "C"
  }
}

Response

This is an OrderResponse containing the Order with a unique orderId that can be referred to when obtaining OrderStatus.

messagestring

message returned by server side if there is any