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.

Form Data

api_key

string

required

This is a 25 alphanumeric hash code provided to you by the fleet.

phone_number

int64

required

This is the mobile number for the customer account.

customer_pin

int32

You can also send the customers PIN number for verification, if this fails, the API command will fail. If left blank, no validation is done on the authenticity of the customer ID.

quote_id

int32

If you would like to retrieve the data stored from a quote request, put in the ID number for it here. You can override any data stored with new data by entering the appropriate fields again below.

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.

passenger_total

int32

Defaults to 1

This should contain the total number of passengers. It is important to provide this value when more than 4 passengers are required as this will limit the type of vehicles that will receive this job. The default value is 1.

cases_total

int32

Defaults to 0

This should contain the total number of cases required as part of the booking so that an appropriate vehicle is sent. Please consider larger items such as golf clubs as 2 cases. The default value is 0.

pickup_address

string

This should contain the full pick-up text with no line breaks. Please ensure each section of the address is separated by a comma. For example, you would send: 13 Down Town, London, SW13 9KD, UK If the address contains a POI (Point-of-interest), you can place this at the start by including it within brackets. For example: (Coffee Cafe) 13 Down Town, London, SW13 9KD, UK

pickup_lat

double

Latitude of the pick-up location in Decimal Degrees only. Do not use commas as decimals. For example: 51.507323

pickup_long

double

Longitude of the pick-up location in Decimal Degrees only. Do not use commas as decimals. For example: -0.127754

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_address

string

This should contain the full drop-off text with no line breaks. Please ensure each section of the address is separated by a comma. For example, you would send: 13 Down Town, London, SW13 9KD, UK If the address contains a POI (Point-of-interest), you can place this at the start by including it within brackets. For example: (Coffee Cafe) 13 Down Town, London, SW13 9KD, UK

dropoff_lat

double

Latitude of the drop-off location in Decimal Degrees only. Do not use commas as decimals. For example: 51.507323

dropoff_long

double

Longitude of the drop-off location in Decimal Degrees only. Do not use commas as decimals. For example: 51.507323

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

viapoints

json

This should be a multidimensional JSON object with the following elements in each child array. Please look further down the page for what each object within the viapoints array should include.

distance

int32

If you have already routed this journey and wish to use your own distance data please provide this value here in miles.

duration

int32

If you have already routed this journey and wish to use your own time duration data please provide this value here in minutes.

cost

double

Depending if the fleet operator has enabled this option this value lets you pre-define the set price rate for this booking. The fleet operator and driver still maintains the ability to modify this.

system_cost

double

An internal price for the booking - used for Driver/Customer Commissions

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.

vehicle_preference

string

Defaults to NA

This is the vehicle preference for the booking. Please seek "vehicle_types" API for valid vehicle types to use.

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.

custom

json

This allows you to submit custom fields in KEY>VAL pairs, with Key being the full text of the field in your Gazoop system.