modify_booking

This tool creates a brand new booking for the customer.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

This allows you to make adjustments to an already created booking. Please be aware that you must provide a Quote ID in order to save changes to an existing booking. Without a Quote ID, you won't be able to modify the booking.

You should submit a new job request to the Quote, then submit the Quote ID and existing Job ID to this API call to make the relevant adjustments.

Via Points

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

ParameterDescription
textThis should contain the full via-point address text. Seek PICKUP_ADDRESS for formatting information.
latVia-point Latitude. Seek PICKUP_LAT for formatting information.
longVia-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
string
required

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

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).

int32
required

The Job ID you wish to modify.

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.

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

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

string

This should contain the lead passengers name or reference.

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.

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.

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.

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

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.

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.

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!