Event API
Any non-booking purchase made for this reservation
Field
Validator
Note
Required
Dynamic
Secure
Type
Max32
Price
RegExMoney
Description
Max128
Carrier
RegExCarrier
FlightNumber
RegExFlight
Indicates when a customer's baggage has arrived at its intended location.
Field
Validator
Note
Required
Dynamic
Secure
BagId
Max32
Carrier
RegExCarrier
FlightNumber
RegExFlight
Destination
RegExAirport
Arrive
RegExDateTime
Specified in airport local time
Indicates when a customer has checked a bag.
Field
Validator
Note
Required
Dynamic
Secure
BagId
Max32
Carrier
RegExCarrier
FlightNumber
RegExFlight
Origin
RegExAirport
Depart
RegExDateTime
Specified in airport local time
SpecialItem
Max64
Weight
RegExNumeric4
Fee
RegExMoney
Indicates when a customer's bag has arrived at a location other than its intended location.
Field
Validator
Note
Required
Dynamic
Secure
BagId
Max32
Carrier
RegExCarrier
FlightNumber
RegExFlight
Origin
RegExAirport
Destination
RegExAirport
Depart
RegExDateTime
Specified in airport local time
Arrive
RegExDateTime
Specified in airport local time
Description
Max128
Information about all of the bags on an airline reservation
Field
Validator
Note
Required
Dynamic
Secure
BagTotal
NumericOnly max: 4
SpecialItemTotal
NumericOnly max: 4
FeeTotal
RegExMoney
BagsArrived
NumericOnly max: 4
A booking marker for a flight itinerary.
Field
Validator
Note
Required
Dynamic
Secure
NumTravelers
RegExNumeric2Max
PlatingCarrier
RegExCarrier
ConfirmationNumber
Max64
Remark
Max1024
Indicates when a customer upgrades their flight.
Field
Validator
Note
Required
Dynamic
Secure
Carrier
RegExCarrier
FlightNumber
RegExFlight
Request
Max32
Confirmation
Max32
PaymentForm
Max32
Price
RegExMoney
Amounts related to a specific reservation cancellation.
Field
Validator
Note
Required
Dynamic
Secure
CancelReason
Max128
CancelPenalty
Boolean
CancelCharge
RegExMoney
CancelRefund
Boolean
RefundAmount
RegExMoney
Flight check-in confirmation.
Field
Validator
Note
Required
Dynamic
Secure
FlightNumber
RegExFlight
TSAPre
Boolean
BoardingGroup
RegExNumeric2Max
BoardingPosition
AlphaNumericExtras max: 6
BoardingTime
RegExDateTime
GateNumber
AlphaNumericSpace max: 6
Terminal
AlphaNumericSpace max: 6
PriorityAccess
Boolean
Flight departure confirmation.
Field
Validator
Note
Required
Dynamic
Secure
Carrier
RegExCarrier
FlightNumber
RegExFlight
Origin
RegExAirport
Depart
RegExDateTime
Flight status information.
Field
Validator
Note
Required
Dynamic
Secure
Carrier
RegExCarrier
FlightNumber
RegExFlight
Origin
RegExAirport
Destination
RegExAirport
Depart
RegExDateTime
Specified in airport local time
Arrive
RegExDateTime
Specified in airport local time
EstDepart
RegExDateTime
Specified in airport local time
EstArrive
RegExDateTime
Specified in airport local time
GateNumber
AlphaNumericSpace max: 6
Terminal
AlphaNumericSpace max: 6
Delay
Boolean
DelayCause
Max32
Human readable description
Canceled
Boolean
Information related to the purchase of trip insurance for a specific itinerary.
Field
Validator
Note
Required
Dynamic
Secure
Provider
Max64
Coverage
Max128
Cost
RegExMoney
Payment information for a specific itinerary.
Field
Validator
Note
Required
Dynamic
Secure
Amount
RegExMoney
CreditCardLast4
RegExNumeric4
Field
Validator
Note
Required
Dynamic
Secure
Fare
RegExMoney
Taxes
RegExMoney
Total
RegExMoney
BookingFee
RegExMoney
Sum of fees paid for all tickets on an itinerary
Field
Validator
Note
Required
Dynamic
Secure
Total
RegExMoney
Details about the membership or loyalty program the reservations was booked under.
Field
Validator
Note
Required
Dynamic
Secure
ProgramName
Max64
MemberNumber
Max128
MemberName
Max128
Name of the member organization for programs that are not for individuals (eg, corporate loyalty programs)
Indicates a schedule change to a specific itinerary.
Field
Validator
Note
Required
Dynamic
Secure
PrevCarrier
RegExCarrier
PrevFlightNumber
RegExFlight
PrevOrigin
RegExAirport
PrevDestination
RegExAirport
PrevDepart
RegExDateTime
Specified in airport local time
PrevArrive
RegExDateTime
Specified in airport local time
NewCarrier
RegExCarrier
NewFlightNumber
RegExFlight
NewOrigin
RegExAirport
NewDestination
RegExAirport
NewDepart
RegExDateTime
Specified in airport local time
NewArrive
RegExDateTime
Specified in airport local time
Indicates which seat was reserved for a specific itinerary.
Field
Validator
Note
Required
Dynamic
Secure
Carrier
RegExCarrier
FlightNumber
RegExFlight
SeatNumber
RegExAlphaNumeric3
Cabin
EnumCabin
SeatType
Max32
Price
RegExMoney
A segment of air travel for a customer.
Field
Validator
Note
Required
Dynamic
Secure
Carrier
RegExCarrier
FlightNumber
RegExFlight
Origin
RegExAirport
Destination
RegExAirport
MilesFlown
NumericOnly max: 5
Depart
RegExDateTime
Specified in airport local time
Arrive
RegExDateTime
Specified in airport local time
OperatingCarrier
RegExCarrier
Cabin
EnumCabin
CabinDescriptor
Max128
FareClass
RegExAlpha1
AircraftId
Max32
Delay
NumericOnly max: 4
Arrival time delay in minutes. Auto populated from AirFlightStatus events.
DepartDate
RegExDateOnly
The date (without time) that this segment departs
ArriveDate
RegExDateOnly
The date (without time) that this segment arrives
OriginMetroArea
Max64
The metropolitan area designation for the origin airport
DestinationMetroArea
Max64
The metropolitan area designation for the destination airport
A reference to a segment of air travel for a customer.
Field
Validator
Note
Required
Dynamic
Secure
Carrier
RegExCarrier
FlightNumber
RegExFlight
Origin
RegExAirport
Destination
RegExAirport
Depart
RegExDateTime
Specified in airport local time
Arrive
RegExDateTime
Specified in airport local time
Cabin
EnumCabin
CabinDescriptor
Max128
Flight transportation via means other than typical airline travel.
Field
Validator
Note
Required
Dynamic
Secure
Operator
Max32
Origin
RegExAirportExtended
Destination
RegExAirportExtended
Depart
RegExDateTime
Specified in airport local time
Arrive
RegExDateTime
Specified in airport local time
ConfirmationNumber
Max32
NumTravelers
RegExNumeric2Max
MilesFlown
NumericOnly max: 5
CabinDescriptor
Max128
AircraftId
Max32
Remark
Max1024