create_quote

post

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

This tool creates a brand new quote for the customer.

When creating a quote you will receive a quote reference number, it is important that you log this as you will need this quote number if you wish to quickly create the job. Otherwise, you can create the booking using the exact same fields.

The system does not send any quote emails or SMS messages automatically when using the API.

🚧
Customer Account Information Optional
Quotes can be generated without any customer account identified, however, please be aware this also means a customer can not retrieve any previously stored quotes and you will be unable to retrieve them from their customer ID.

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

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.

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

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

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.

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

float

An internal price for the booking - generally 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.

wheelchair

string

Defaults to N

If a wheelchair accessible vehicle is required this should be set to Y.

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. Please be aware that this only influences the price of the journey, it does not get stored with the quote.

pricing_type

string

Defaults to simple

This returns back the selected pricing, "simple" will return a basic mileage, time, and start fee price, where as "advance" will return the price with all advance localisation rules and flat rates considered. "none" will mark the quote as already calculated and use the cost field provided as the fare quote. Default is "none".

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.

🚧Customer Account Information Optional

Via Points

🚧
Customer Account Information Optional