Flitways API V1.8

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 address of the pick-up point. 201 Marquette Ave NW, Albuquerque, NM 87102
destination_address The formatted address of the drop off point. West Mesa Airport, Albuquerque, NM
pickup_time The pick-up date and time 2017-02-24 19:24:42    i.e YYYY-MM-DD HH:MM:SS (GMT)
asap (optional) On-demand trips for pick-up within the next 5 mins. True/False. Set 1 for true or 0 for false
miles The estimated distance between the pick-up address and the destination address (Miles) 6.11
estimate_travel_time The estimated time to travel from the pick-up address and the destination address 0 hour(s) 14 mins
lat_from The latitude of the pick-up point. 35.0884616
long_from The longitude of the pickup point. -106.64930
lat_to The latitude of the drop off point. 35.086944
long_to The longitude of the drop off point. -106.7155559
is_pickup_airport Pick-up is from the airport or not ( 1/0 ) 1
no_of_passengers Numbers of passengers 3
additional_info Special note Special message to driver
flight_info Flight details for airport pick-ups AA10104
tip_percent Booking gratuity percentage 20
tip_val Booking gratuity amount 5.8
airport_fee Airport fee 2
fare Total fare price 10.66
vehicle_fleet_id Fleet ID 232
passenger_name Name of passenger Jane Smith
passenger_area_code Passenger phone area code 1
passenger_phone Passenger phone 3107896541
passenger_email Passenger email jane_smith@mail.com
password Password to create FlitWays traveler's 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/false
request_id ID of the request 4821430
code Type of the response S001
request_time Time of search request 02/24/2017 07:24 pm
key The Partner key NBOLq1aFq4G5mt88R5COtGiqIlrwoDG3kgLeCKfohJ0xJwAaOMua3H6ft7JI
message Confirmation of the booking 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-02-24 19:24 pm    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 02/24/2017 07:24 pm
JSON Book Cancel Response Example:

Trip Status Request

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_search_request
Request fields and values:
Name Description Example
key Partner unique keys NBOLq1aFq4G5mt88R5COtGiqIlrwoDG3kgLeCKfohJ0xJwAaOMua3H6ft7JI
voucher_no The 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 Type of the response S001
request_time Time of search request 02/24/2017 07:24 pm
key The Partner key NBOLq1aFq4G5mt88R5COtGiqIlrwoDG3kgLeCKfohJ0xJwAaOMua3H6ft7JI
message Status of the booking Pending, Picked up, No Show with Fee, Cancelled with Refund, Cancelled with Fee, Refund Pending, Full Refund
voucher_no The voucher number 2573769
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 Name of the airport LAX
city_name City, where the airport is belong to Los Angeles
airport_address Address of the airport 201-599 World Way, Los Angeles International Airport, Los Angeles, CA 90045, USA
latitude Latitude of the airport 33.9415889
longitude Longitude of the airport -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 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  •