Sign in
Orders

Retrieve one or more orders

Given one or more criteria in the query string, one or more matching orders will be returned.

Results will also be paged based on offset and size.

get/orders

Query parameters

customerPhoneNumberstring
Example:1234567890

Customer phone number (without country code)

customerEmailstring
Example:peter_parker@yahoo.com

Customer email address

passengerTravelDocumentNumberstring
Example:EG12345678

Travel document number, such as passport number, of a passenger

offsetinteger
sizeinteger
dateTimeStartstring date-time

A start date-time earlier than any order returned. It should be in ISO 8601 format (UTC).

dateTimeEndstring date-time

A end date-time later than any order returned. It should be in ISO 8601 format (UTC).

orderStatus'cancelled' | 'completed' | 'error' | 'pending'

For status definition, see OrderStatus under Order Schemas.

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