Flight API Connection User Guide

Modified on Tue, 22 Sep at 5:34 PM

The Flight API Integration automatically retrieves real-time flight information for airport transfer bookings.


By connecting a valid flight number to a booking, the system can:

  • Track flight status automatically.
  • Display real-time flight information in Command Center.
  • Notify operators and drivers when flight details change.
  • Automatically adjust the expected pickup time based on your configured rules.

This helps reduce manual flight monitoring while improving coordination between dispatchers and drivers.


Before You Start

Before using Flight API Integration, ensure that:

  • The Flight API add-on has been successfully integrated and configured in your system.
  • Flight tracking is enabled.
  • A valid flight number is available.
  • Airport transfer bookings use the correct airport location.

Note: Flight tracking only begins after a valid IATA or ICAO flight number has been applied to the booking.


Supported Flight Numbers

The system supports both:

  • IATA Flight Numbers (e.g. QF646)
  • ICAO Flight Numbers

Always enter the complete flight number to ensure accurate flight detection.


Add Flight Information to a Booking

Flight information can be added when creating a booking or after the booking has been created.


Option 1: During Booking Creation

  1. Create a new booking.
  2. Enter an airport as the pickup location.
  3. The Flight Information section appears automatically.
  4. Enter a valid flight number.
  5. Press Tab or click outside the field.
  6. The system automatically retrieves the flight details.
flight-apply-new.png


Option 2: From Booking Details

To add or update flight information for an existing booking:

  1. Open the booking.
  2. Enter a valid flight number.
  3. Press Tab or click outside the field.
  4. Verify the retrieved flight information.
  5. Click Update Booking.
flight-apply-update.png


Important Notes:

  • Always enter the correct flight number format (example: QF646).
  • Ensure the booking date matches the actual flight date.
  • The airport address must match the flight route for accurate detection.


Flight Status Tracking

Once a flight number has been linked to a booking, operators can monitor its status directly from the Command Center.

The system automatically updates the booking as the flight progresses.

flight-tracking.png


Supported flight statuses include:

StatusDescription
ScheduledThe flight is scheduled but has not departed.
ActiveThe flight is currently in the air.
ArrivedThe aircraft has landed.

Note: Flight Actual arrival information becomes available only after the flight lands and the status changes to “Arrived”.


Flight Notifications

Flight updates are automatically delivered to both operators and drivers.


Operator Notitications

Operators receive notifications in:

  • Command Center Dashboard
flight-notification.png


  • Notification Center (filter by Flight API)
flight-notification-details.png

Notifications include important flight events such as delays, arrival updates, and status changes.


Driver Notitications

Drivers receive push notifications whenever flight information changes.

This helps drivers prepare for airport pickups using the latest arrival information.

flight-driver-app.png


Automatic Pickup Time Adjustment

Flight API can automatically update the booking's expected pickup time based on the actual flight arrival.

Configure this feature under:


Settings → General → Booking & Cancellation

flight-setting-arrival.png


Available options include:

OptionDescription
No AdjustmentKeep the original pickup time regardless of flight updates.
When Flight ArrivesUpdate the pickup time to the actual flight arrival time.
15 / 30 / 45 / 60 Minutes After ArrivalAutomatically schedule pickup after the selected waiting period.

The selected rule is applied whenever the flight information changes.

flight-cc-tracking.png


OTA & API Bookings

For bookings received from integrated channels (such as OTA or API partners):

  • If a valid flight number is included, Flight API is triggered automatically.
  • Flight tracking starts without any manual action.


Manual Bookings

For bookings created manually:

  • Enter a valid flight number.
  • Apply the flight information to the booking.
  • Flight tracking begins once the booking has been updated.
flight-apply-sync-time.png

 

flight-PWA.png


Flight Delay Handling

If a tracked flight is delayed:

  • Flight status updates automatically.
  • Operators receive notifications.
  • Drivers receive push notifications.
  • The expected pickup time is recalculated according to the configured pickup rule.

This ensures both dispatchers and drivers always work with the latest flight schedule.


Best Practices

For the most accurate flight tracking:

  • Enter the complete flight number.
  • Ensure the booking date matches the flight date.
  • Use the correct airport pickup location.
  • Verify flight information before assigning a driver.
  • Configure an appropriate Airport Arrival Pickup Time Rule for your operation.


Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article