create_booking

post

https://cp.gazoop.com/public_api/create_booking.json

This tool creates a brand new booking for the customer.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

When placing a booking you will receive a booking reference number which can be used to both track and manage the booking. It is important that you log this information when received. Additionally, when booking an instant job there is a 15 to 30 second delay before the job is sent to a driver when the fleet operator is using GPS Dispatch, which allows time for cancellation and/or testing before a driver gets receipt of the booking.

When processing an API booking the system ignores any default booking SMS/Email triggers. However, beyond the booking if SMS is set up for any other feature, for example, driver allocation, approaching location, cancellation, delays etc, these will still be sent to the customer. If you do not wish for these messages to be sent we suggest disabling these options with the fleet operator.

Via Points

Via Points must be provided in the following format for each array object.

Parameter	Description
text	This should contain the full via-point address text. Seek PICKUP_ADDRESS for formatting information.
lat	Via-point Latitude. Seek PICKUP_LAT for formatting information.
long	Via-point Longitude. Seek PICKUP_LONG for formatting information.

Vehicle Types

You can use any of the below for the vehicle preference option:

NA = Not Applicable / No Preference
SALOON = Saloon Car
ESTATE = Estate Car
EXEC = Executive Car
MPV = MPV
MPVPLUS = MPV Plus
8SEATER = 8 Seater Vehicle
MINIBUS = Mini Bus
LIMO = Limousine
BUS = Bus
COACH = Coach

The default setting is NA.

Form Data

username

string

required

This is the username for the customer account (generally a phone number in international format, excluding the + or 00)

password

string

required

This is the password for the customer account (generally a PIN number of a minimum 4 digit length, and up to 12 digits long).

quote_id

int32

required

This is the quote ID given in the "create_quote" API call. All details from this quote request will be placed in to the new booking. You can adjust limited data from the quote request below, any other data changes must first be sent as a new quote request.

pickup_flight

string

If the booking is a pick-up at an airport, please provide the flight number in this field including the airline code. For example: ZB734

dropoff_flight

string

If the booking is a drop-off at an airport, please provide the flight number in this field including the airline code. For example: ZB734

passenger_name

string

This should contain the lead passengers name or reference.

passenger_phone_number

int64

This should contain a mobile or landline number in international format for the lead passenger. (IE: in the UK: 447780123456 and in the US: 15468875544). The default is the PHONE_NUMBER value sent in the user parameters.

notes

string

This should include any important notes regarding the booking. This will display on the fleet operators booking information screen, and also at the very top in bold on the drivers tablet/mobile device.

pickup_time

date

Defaults to NOW

This should contain the date and time of the booking pickup. You must supply this using a valid date and time format as detailed here: http://uk3.php.net/manual/en/datetime.formats.php If however the booking is for now, you can either send the current date/time, or send the value NOW. This default value is NOW.

payment_method

string

Defaults to CASH

This should contain the customers requested payment method. The driver can still adjust this in their mobile application, however this will be the default option when closing out the job. This should either be CASH, CREDITCARD, or ACCOUNT

require_confirmation

string

Defaults to N

If this is set to Y, the fleet must mark this booking as accepted within 24 hours, if it is not confirmed within 24 hours, the booking will automatically be deleted from their system.

webhook

string

This is a webhook URL for all status and action changes. For more information about the data sent in a webhook please seek the webhook section on the bottom left of the menu.