Orders

Create an order of specific flight

Given information of specific flights, customer and passengers, an order with an unique orderId will be returned along with totalAmount in particular currency.

An optional map of key:value pairs can be passed to extended, to assoicate certain custom data with this particular order for future tracking. For example, it is recommended to pass a client side order ID to this extended map, so later when an order is returned it is convenient to identify the corresponding order at client side.

post/orders

Request body

orderIdstring
createdAtstring date-time

Creation date/time of the 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.

extendedobject

Extended data from client side to associate with this particular order. 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 upon getting a order.

Example request

{
  "orderId": "a7dd1cf6-dc96-490b-bdf6-8685dbf5bb87",
  "currency": "EUR",
  "totalAmount": 456.78,
  "flights": [
    {
      "segments": [
        {
          "depDate": "20210401",
          "depTime": "12:45",
          "depAirport": "LON",
          "arrDate": "20210401",
          "arrTime": "17:50",
          "arrAirport": "CGN",
          "flightNo": "AC103",
          "carrier": "AC"
        }
      ]
    }
  ],
  "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

OK

orderIdstring
createdAtstring date-time

Creation date/time of the 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.

extendedobject

Extended data from client side to associate with this particular order. 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 upon getting a order.

Example response

{
  "orderId": "a7dd1cf6-dc96-490b-bdf6-8685dbf5bb87",
  "currency": "EUR",
  "totalAmount": 456.78,
  "flights": [
    {
      "segments": [
        {
          "depDate": "20210401",
          "depTime": "12:45",
          "depAirport": "LON",
          "arrDate": "20210401",
          "arrTime": "17:50",
          "arrAirport": "CGN",
          "flightNo": "AC103",
          "carrier": "AC"
        }
      ]
    }
  ],
  "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"
  }
}

Changes