Model: airFlightInformation

1 min

Model Parameters

airFlightInformation
- flightInformationobject
  Description
  [OPTIONAL]
  - pnrstringrequired
    Example
    ABC123
    Description
    [REQUIRED] Passenger Name Record. Maximum field length = 50 characters.
  - flightTypestring<multi-city | one-way | round-trip>required
    Example
    multi-city
    Description
    [REQUIRED] Type of ticket purchased.
    Allowed
    multi-cityone-wayround-trip
  - isThirdPartyBookingstring<true | false>
    Description
    [OPTIONAL] Indicates if booked through a third-party/OTA.
    Allowed
    truefalse
  - fareBasisCodestring
    Example
    2E7N
    Description
    [OPTIONAL] The alpha-numeric code used by airlines to identify the fare type. Maximum field length = 30 characters.
  - otaIdentificationNumberstring
    Example
    ABC123
    Description
    [OPTIONAL] OTA ID number. Required if isThirdPartyBooking is true. Maximum field length = 20 characters.
  - otaNamestring
    Example
    Best Travel Agency
    Description
    [OPTIONAL] Third-party agency name corresponding to the OTA ID. Required if otaIdentificationNumber exists. Maximum field length = 50 characters.
  - initialDepartingAirportstring
    Example
    ORD
    Description
    [OPTIONAL] IATA airport code where itinerary originates. Required if pnr exists.
  - finalArrivalAirportstring
    Example
    MIA
    Description
    [OPTIONAL] IATA airport code for the itinerary's final destination. Required if pnr exists.
  - segmentsobject[]required
    Description
    [REQUIRED] Flight segments in the itinerary.
    - routeInfostring
      Example
      ORDMIA1232014-08-30T17:07:24-05:00
      Description
      [REQUIRED] Coded description of the flight details, including departure and arrival airports as the first six characters. Required if pnr exists. Maximum field length = 100 characters.
    - airlineNamestring
      Example
      Primary Airlines Ltd
      Description
      [REQUIRED] Marketing airline name for this segment. Required if pnr exists. Maximum field length = 40 characters.
    - operatingAirlinestring
      Example
      Actual Carrier Air Inc.
      Description
      [REQUIRED] Operating carrier in codeshare scenarios. Required if pnr exists. Maximum field length = 40 characters.
    - flightNumberstring
      Example
      123
      Description
      [OPTIONAL] Flight number. Maximum field length = 10 characters.
    - ticketClassstring<business | economy | first | premium>
      Example
      economy
      Description
      [REQUIRED] Ticket cabin class.
      Allowed
      businesseconomyfirstpremium
    - fareClassstring
      Example
      Y
      Description
      [REQUIRED] First letter of fare basis code. Required if pnr exists. Maximum field length = 30 characters.
    - specialFareTypestring<bereavement | corporate | employee | infant | military | senior | student | unaccompaniedMinor | other>
      Example
      bereavement
      Description
      [OPTIONAL] Special fare type when applicable.
      Allowed
      bereavementcorporateemployeeinfantmilitaryseniorstudentunaccompaniedMinorother
    - isAwardTicketstring<true | false>
      Example
      true
      Description
      [REQUIRED] Indicates award redemption ticket.
      Allowed
      truefalse
    - departureDateTimestring<date-time>
      Example
      2022-03-28T17:07:24-07:00
      Description
      [REQUIRED] Required if pnr exists. The departure date and time formatted yyyy-MM-dd'T'HH:mm
      .
      Format
      date-time
    - departureAirportCodestring
      Example
      ORD
      Description
      [REQUIRED] IATA code for departure airport. Required if pnr exists.
    - arrivalDateTimestring<date-time>
      Example
      2022-03-28T17:07:24-07:00
      Description
      [REQUIRED] Required if pnr exists. The arrival date and time formatted yyyy-MM-dd'T'HH:mm
      .
      Format
      date-time
    - arrivalAirportCodestring
      Example
      ORD
      Description
      [REQUIRED] IATA code for arrival airport. Required if pnr exists.
    - isFinalDestinationstring<true | false>
      Example
      true
      Description
      [REQUIRED] Indicates which segment array's Arrival Airport is the final destination for the PNR. Must be set to True in one and only one segment array and set to False in all other segment arrays. Set to True for the last segment of a one-way ticket.
      Allowed
      truefalse
  - passengersobject[]required
    Description
    [REQUIRED] Passenger details for the itinerary.
    - passengerIDstring
      Example
      998fsd72234
      Description
      [OPTIONAL] Passenger's unique identifier you assigned. Maximum field length = 40 characters.
    - ticketNumberstring
      Example
      ABC123
      Description
      [REQUIRED] Required if flightNumber exists. Maximum field length = 30 characters.
    - passengerDateOfBirthstring
      Example
      1985-01-24
      Description
      [OPTIONAL] Passenger date of birth in YYYY-MM-DD.
    - passengerGenderstring<F | M | U | O>
      Example
      M
      Description
      [OPTIONAL] Passenger gender. Options are:
      
      F: Female
      
      M: Male
      
      U: Undisclosed
      
      O: Other
      Allowed
      FMUO
    - passengerAdultOrChildstring<adult | child | infant>
      Example
      adult
      Description
      [OPTIONAL] Age classification.
      Allowed
      adultchildinfant
    - passengerTitlestring
      Example
      Mr
      Description
      [OPTIONAL] Honorific preceding the passenger name. Maximum field length = 10 characters. (Mr/Ms/etc.).
    - passengerFirstNamestring
      Example
      John
      Description
      [REQUIRED] Passenger first name (required if flightNumber exists). Maximum field length = 40 characters.
    - passengerMiddleNamestring
      Example
      Peter
      Description
      [OPTIONAL] Passenger middle name. Maximum field length = 20 characters.
    - passengerLastNamestring
      Example
      Smith
      Description
      [REQUIRED] Passenger last name (required if flightNumber exists). Maximum field length = 40 characters.
    - passengerPhonenumber<integer>
      Example
      3125555555
      Description
      [OPTIONAL] Passenger phone number (no country prefix). Maximum field length = 25 characters.
      Format
      integer
    - passengerPhoneCountryCodenumber
      Example
      10
      Description
      [OPTIONAL] Country code; required if passengerPhone is provided (omit '+').
    - passengerEmailAddressstring
      Example
      [email protected]
      Description
      [OPTIONAL] Passenger email address.
    - passengerCheckedBaggageCountnumber
      Example
      2
      Description
      [OPTIONAL] Number of checked bags. Maximum field length = 10 characters.
    - passengerLoyaltyNumberstring
      Example
      LL123456
      Description
      [OPTIONAL] Passenger loyalty membership number. Maximum field length = 40 characters.
    - passengerLoyaltySinceDatestring
      Example
      2000-01-18
      Description
      [OPTIONAL] Membership start date.
    - passengerLoyaltyLevelstring
      Example
      Gold
      Description
      [OPTIONAL] Membership tier/level. Maximum field length = 20 characters.
    - passengerPassportNumberstring
      Example
      P7475664383454343
      Description
      [OPTIONAL] Passport number when applicable. Maximum field length = 40 characters.
    - passengerPassportCountryCodestring
      Example
      US
      Description
      [OPTIONAL] Required if passengerPassportNumber exists. Two-letter passport country (ISO 3166-1); required if passport number is sent.
    - passengerPassportExpirationDatestring
      Example
      2015-01-24
      Description
      [OPTIONAL] Passport expiration date (required with passport number).

Shared flight schema reused by Airline and Travel APIs.