Flitways API V1.9.1

Booking Placement

The Booking Placement function provides a simple way to place a booking into FlitWays system from the search identifier returned by the Booking Rate and Response function.
Send a request via HTTP POST to book a ride.
Live Request - HTTP POST https://flitways.com/api/booking_placement_request
Demo Testing - HTTP POST http://demo.flitways.com/api/booking_placement_request
Request fields and values:
Name Description Example
key The Partner key NBOLq1aFq4G5mt88R5COtGiqIlrwoDG3kgLeCKfohJ0xJwAaOMua3H6ft7JI
pickup_address The formatted pick-up address. San Francisco International Airport, San Francisco, CA, USA
destination_address The formatted destination address. 2800 3rd St, San Francisco, CA 94107, USA
pickup_time Pick-up date and time 2017-05-28 06:40:45    i.e YYYY-MM-DD HH:MM:SS (GMT)
asap Ride is needed now (1) or later ( 0 ) 0
miles Estimated travel distance in miles 6.11
estimate_travel_time Estimated travel time in miles 0 hour(s) 14 mins
lat_from The pick-up address latitude. 37.6213129
long_from The pick-up address longitude. -122.3789554
lat_to The destination address latitude. 37.753729
long_to The destination address longitude. -122.38830619999999
is_pickup_airport Pick-up is from the airport ( 1 ) or not ( 0 ) 1
no_of_passengers Number of passenger. Should not exceed the rate_vehicle_max_passenger value from the rate request response endpoint 3
additional_info Special message to driver I'm traveling with 5 passengers
flight_code Airline IATA code AA
flight_info Airline flight number 10104
tip_percent Tip percentage to driver 20
tip_val Tip amount to driver 5.8
airport_fee rate_airport_fee from the rate request response endpoint 2
fare rate_total from the rate request response endpoint 10.66
vehicle_fleet_id rate_vehicle_id from the rate request response endpoint 232
request_id rate_request_id from the rate request response endpoint 4MF6ubQvU1ntcr0Jyfo8zQ7kZ
passenger_name Name of passenger Jane Smith
passenger_area_code Passenger phone country code 358
passenger_phone Passenger mobile phone number 445866671
passenger_email Passenger email. If not available, set your company's support email. E.g. support@xyz.com jane_smith@mail.com (optional)
allow_passenger_alerts Allow FlitWays email/sms to passenger. 1 for Yes. 0 for No. should 1 (optional)
partner_confirmation_no Your platform unique reference no S218930 (optional)
password Password to create FlitWays passenger account At least 5 characters (optional)
card_type Credit card type visa, master_card, american_express, discover (optional)
card_number Credit card number 16 digits only e.g 4111111111111111 (optional)
card_name Credit Card Name Alphanumeric e.g Jane Smith (optional)
exp_date Credit card expiration Numeric e.g 122019 i.e MMYYYY (optional)
card_cvv Credit card CVV/CVC Max 4 digits e.g 123 or 1234 for Amex (optional)
card_zip_code Credit card zip code Numeric e.g. 90034 (optional)
save_card To save card details for future use Set false for No. Set true for Yes (optional)
Book Response fields and properties:
Name Description Example
status Status of the request true
request_id Request response id 4821430
code Response code S001
request_time Request response timestamp 05/28/2017 06:40 am
key Partner unique key NBOLq1aFq4G5mt88R5COtGiqIlrwoDG3kgLeCKfohJ0xJwAaOMua3H6ft7JI
message Response message Your booking was successful!
voucher_no FlitWays unique voucher number 2573769
rate_eta_seconds Driver ETA (in seconds) 400
JSON Booking Placement Response Example:

Booking Cancellation

The Booking Cancellation function provides a way to cancel a Booking that was placed into FlitWays system by the Booking Placement function.
Send a request via HTTP POST to cancel a booking.
Live Request - HTTP POST https://flitways.com/api/booking_cancellation_request
Demo Testing - HTTP POST http://demo.flitways.com/api/booking_cancellation_request
Request fields and values:
Name Description Example
key Partner unique keys NBOLq1aFq4G5mt88R5.....
voucher_no The voucher number 2573769
cancellation_time Date-time of the cancellation 2017-05-28 06:40 am    i.e YYYY-MM-DD HH:MM AMPM (UTC)
Request Response fields and properties:
Name Description Example
status Status of the request true/false
request_id ID of the request 4821430
code Type of the response S001
key The Partner key NBOLq1aFq4G5mt88R5COtGiqIlrwoDG3kgLeCKfohJ0xJwAaOMua3H6ft7JI
message Message of the cancellation Booking cancelled successfully - Refund Pending
voucher_no The voucher number 2573769
cancellation_fee Cancellation Fee 0.00 or 5.00 or 20.00
cancellation_time Date-time of the cancellation 05/28/2017 06:40 am
JSON Book Cancel Response Example:

Trip Status

The Trip Status function provides a way to check the status of a Booking that was placed into FlitWays system by the Booking Placement function.
Send a request via HTTP POST to check the status of a booking.
Live Request - HTTP POST https://flitways.com/api/booking_status_request
Demo Testing - HTTP POST http://demo.flitways.com/api/booking_status_request
Request fields and values:
Name Description Example
key Partner unique key NBOLq1aFq4G5mt88R5COtGiqIlrwoDG3kgLeCKfohJ0xJwAaOMua3H6ft7JI
voucher_no Trip voucher number 2573769
Request Response fields and properties:
Name Description Example
status Status of the request true/false
request_id ID of the request 4821430
code Response success or error code S001
request_time Request time stamp 05/28/2017 06:40 am
key Partner unique key NBOLq1aFq4G5mt88R5COtGiqIlrwoDG3kgLeCKfohJ0xJwAaOMua3H6ft7JI
message Response Success
voucher_no Trip voucher number 2573769
booking_status Trip status Picked Up. See "Get Trip Status Types" endpoint for full status list.
pickup_time Trip pick up time 05/28/2017 06:40 am
canceled_by The person that canceled the trip driver, passenger
driver_name Driver name Jone Dow
driver_phone Driver's mobile phone +13107896541
driver_rating Driver's rating 4.5
driver_image_url Driver photo URL http://demo.flitways.com/drivers/driver_url.jpg
vehicle_make Vehicle make Toyota
vehicle_model Vehicle model Prius
vehicle_license_plate License plate number A99999
vehicle_color Vehicle color Black
vehicle_image_url Vehicle image URL http://demo.flitways.com/cars/FlitWays_Start.png
pickup_lat Pick up address latitude 34.008336
pickup_lng Pick up address longtitude -118.401311
pickup_address Pick up address 10844 Garfield Ave, Culver City, CA 90230, US
dropoff_lat Dropoff latitude 33.942501
dropoff_lng Dropoff longtitude -118.407997
dropoff_address Dropoff address Los Angeles International Airport
location_lat Driver's location latitude 34.008336
location_lng Driver's location longtitude -118.401311
location_address Driver location address 10844 Garfield Ave, Culver City, CA 90230, US
fare_price Trip Fare Price $13.42
payment_type Payment Type Credit Card xxx1111
cancelation_state To determine if cancelation is allowed or not allow, expire
JSON Booking Status Response Example:

Get Cities

The Get Cities function provides a way to get the available cities from the FlitWays system.
Send a request via HTTP POST/GET to retrieve the available cities from FlitWays.
Live Request - HTTP POST/GET https://flitways.com/api/get_cities
Demo Testing - HTTP POST/GET http://demo.flitways.com/api/get_cities
Response fields and properties:
Name Description Example
status Status of the request true/false
data Response of the request A json array
JSON Get Cities Response Example:

Get Airports

The Get Airports function provides a way to get the available airports from the FlitWays system.
Send a request via HTTP POST/GET to retrieve the available airports from FlitWays.
Live Request - HTTP POST/GET https://flitways.com/api/get_airports
Demo Testing - HTTP POST/GET http://demo.flitways.com/api/get_airports
Response fields and properties:
Name Description Example
status Status of the request true/false
data Response of the request A json array
airport_name Airport name Los Angeles International Airport
city_name Airport city Los Angeles
airport_iata_code Airport iata code LAX
latitude Airport latitude 33.9415889
longitude Airport longtitude -118.40852999999998
JSON Get Airports Response Example:

Get Vehicle Types

The Vehicle Types Cities function provides a way to get the available vehicle types from the FlitWays system.
Send a request via HTTP POST/GET to retrieve the available vehicle types from FlitWays.
Live Request - HTTP POST/GET https://flitways.com/api/get_vehicle_types
Demo Testing - HTTP POST/GET http://demo.flitways.com/api/get_vehicle_types
Response fields and properties:
Name Description Example
status Status of the request true/false
data Response of the request A json array of vehicle types
JSON Get Vehicle Types Response Example:

Get Trip Status Types

The Get Trip Status Types function provides a way to get the available trip status types from the FlitWays system.
Send a request via HTTP POST/GET to retrieve the available trip status types from FlitWays.
Live Request - HTTP POST/GET https://flitways.com/api/get_trip_status_types
Demo Testing - HTTP POST/GET http://demo.flitways.com/api/get_trip_status_types
Response fields and properties:
Name Description Example
status Status of the request true/false
data Response of the request A json array of available trip status types
JSON Get Trip Status Types Response Example:

Get Price Estimate

The Get Price Estimate end point can be used to get price quotation for Airport Trips. E.g. Airport to City and City to Airport.
Send a request via HTTP POST/GET to retrieve the available price estimate from FlitWays.
Live Request - HTTP POST/GET https://flitways.com/api/get_price_estimates
Demo Testing - HTTP POST/GET http://demo.flitways.com/api/get_price_estimates
Response fields and properties:
Name Description Example
status Status of the request true/false
msg Response description String
data Response of the request A json array of price estimates
from_place Pick up location Los Angeles Airport, LAX
to_place Destination Los Angeles Downtown Area
from_airport_code Pick up airport code LAX
to_airport_code Destination airport code LAX
estimate_price Estimated price 45
currency Price currency USD
JSON Get Price Estimate Response Example:

Drivers Availability

The Drivers Availability function provides a way to get the available drivers for a place.
Send a request via HTTP POST/GET to retrieve the available drivers from FlitWays.
Live Request - HTTP POST/GET https://flitways.com/api/drivers_availability
Demo Testing - HTTP POST/GET http://demo.flitways.com/api/drivers_availability
Request fields and values:
Name Description Example
key Partner unique keys NBOLq1aFq4G5mt88R5COtGiqIlrwoDG3kgLeCKfohJ0xJwAaOMua3H6ft7JI
lat Latitude 34.030277
lng Longitude -118.41599889999998
Response fields and properties:
Name Description Example
status Status of the request true/false
data Response of the request A json array
lat Latitude of Driver location 34.116382
lng Longitude of Driver location -118.482286
driver_direction The dynamic radians of the driver's direction 1.6580627875
eta_seconds Driver ETA (in seconds) 445
JSON Drivers Availability Response Example:

API Errors

When error occurs for some reasons, the status property is set to error and the response property is replaced by the errors property which contains an array of error objects described below.
Fields fields and values:
Name Description Example
status Status of the request false/fail
request_id ID of the request 4821430
code Type of the response E001
message Error message The partner key does not exist!
JSON Response Example:
Contact Us
  • 24/7 Support:
    +1-855-710-0915    (US)
    +44 117 325 5593   (UK)
    +61 7 4839 7446     (Australia)
  • Investor Relations: Mon - Fri 9 A - 6 P PST
    +1-855-710-0915 ex. 5
  • Email: support@flitways.com
Say Hey
© 2016. FlitWays Technology Inc. | Privacy Policy | Terms and Conditions | SEC Filings All right reserved. FLITWAYS EVERYWHERE - Atlanta  •  Austin  •  Baltimore  •  Boston  •  Chicago  •  Charlotte  •  Charlotte  •  Dallas  •  Denver  •  Detroit  •  Fort Lauderdale  •  Franklin  •  Honolulu  •  Houston  •  Jacksonville  •  Jersey City  •  Indianapolis  •  Las Vegas  •  Los Angeles  •  Memphis  •  Miami  •  Minneapolis  •  Montreal  •  Nashville  •  New Orleans  •  New York  •  Orange County  •  Orlando  •  Philadelphia  •  Phoenix  •  Pittsburgh  •  Portland  •  Sacramento  •  San Diego  •  San Antonio  •  San Jose  •  San Francisco  •  Seattle  •  St Louis  •  Tampa  •  Toronto  •  Tucson  •  Vancouver  •  West Palm  •  Washington DC  •  CancĂșn  •  Berlin  •  Rio de Janeiro  •  London  •  Paris  •  Buenos Aires  •  Mexico City  •