{"_id":"573913074dea9d0e000519b3","user":"543005a67d487022005b3fa7","editedParams":true,"version":{"_id":"543005c87d487022005b3fab","__v":6,"project":"543005c87d487022005b3fa8","createdAt":"2014-10-04T14:35:52.362Z","releaseDate":"2014-10-04T14:35:52.362Z","categories":["543005c87d487022005b3fac","54345156edce04080040964e","543ee0c055bb1008000955b6","54c82a78ab706219009e0656","57390d0e1f4b740e00b06cb2","5741d5ab28f5fb0e0063ed36"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"editedParams2":true,"parentDoc":null,"project":"543005c87d487022005b3fa8","__v":5,"githubsync":"","category":{"_id":"57390d0e1f4b740e00b06cb2","project":"543005c87d487022005b3fa8","__v":0,"version":"543005c87d487022005b3fab","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-05-15T23:58:06.028Z","from_sync":false,"order":9999,"slug":"iwebcab-customer-api","title":"Gazoop Customer API"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-16T00:23:35.678Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","results":{"codes":[{"name":"Success","code":"{\n    \"result\": \"valid\",\n \t\t\"job_id\": \"12345\"\n}","language":"json"},{"name":"Failure","code":"{\n    \"result\": \"error\",\n\t  \"error\": \"Reason for error\"\n}","language":"json"}]},"settings":"","examples":{"codes":[]},"auth":"never","params":[{"_id":"543f0b3e15d0560800502805","ref":"","in":"body","required":true,"desc":"This is the username for the customer account (generally a phone number in international format, excluding the + or 00)","default":"","type":"string","name":"username"},{"_id":"543f0b3e15d0560800502804","ref":"","in":"body","required":true,"desc":"This is the password for the customer account (generally a PIN number of a minimum 4 digit length, and up to 12 digits long).","default":"","type":"string","name":"password"},{"_id":"573919b975724e0e00f206c2","ref":"","in":"body","required":true,"desc":"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.","default":"","type":"int","name":"quote_id"},{"_id":"543f0b3e15d05608005027fa","ref":"","in":"body","required":false,"desc":"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","default":"","type":"string","name":"pickup_flight"},{"_id":"543f0b3e15d05608005027f6","ref":"","in":"body","required":false,"desc":"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","default":"","type":"string","name":"dropoff_flight"},{"_id":"543f0b3e15d05608005027f5","ref":"","in":"body","required":false,"desc":"This should contain the lead passengers name or reference.","default":"","type":"string","name":"passenger_name"},{"_id":"5741d1a171cca10e00621012","ref":"","in":"body","required":false,"desc":"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.","default":"","type":"string","name":"passenger_phone_number"},{"_id":"543f0b3e15d05608005027f1","ref":"","in":"body","required":false,"desc":"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.","default":"","type":"string","name":"notes"},{"_id":"543f0b3e15d05608005027ef","ref":"","in":"body","required":false,"desc":"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.","default":"NOW","type":"datetime","name":"pickup_time"},{"_id":"56cb21b70549f0130068de51","ref":"","in":"body","required":false,"desc":"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","default":"CASH","type":"string","name":"payment_method"},{"_id":"5741d2ad91fd8d0e00713ba0","ref":"","in":"body","required":false,"desc":"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.","default":"N","type":"string","name":"require_confirmation"},{"_id":"5741d5a428f5fb0e0063ed35","ref":"","in":"body","required":false,"desc":"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.","default":"","type":"string","name":"webhook"}],"url":"/create_booking.json"},"isReference":false,"order":6,"body":"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.\n\nWhen 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.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Via Points\"\n}\n[/block]\nVia Points must be provided in the following format for each array object.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"text\",\n    \"0-1\": \"This should contain the full via-point address text. Seek PICKUP_ADDRESS for formatting information.\",\n    \"1-0\": \"lat\",\n    \"1-1\": \"Via-point Latitude. Seek PICKUP_LAT for formatting information.\",\n    \"2-0\": \"long\",\n    \"2-1\": \"Via-point Longitude. Seek PICKUP_LONG for formatting information.\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Vehicle Types\"\n}\n[/block]\nYou can use any of the below for the vehicle preference option:\n\n  * NA = Not Applicable / No Preference\n  * SALOON = Saloon Car\n  * ESTATE = Estate Car\n  * EXEC = Executive Car\n  * MPV = MPV\n  * MPVPLUS = MPV Plus\n  * 8SEATER = 8 Seater Vehicle\n  * MINIBUS = Mini Bus\n  * LIMO = Limousine\n  * BUS = Bus\n  * COACH = Coach\n\nThe default setting is NA.","excerpt":"This tool creates a brand new booking for the customer.","slug":"create_booking2","type":"endpoint","title":"create_booking"}

postcreate_booking

This tool creates a brand new booking for the customer.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

username:
required
string
This is the username for the customer account (generally a phone number in international format, excluding the + or 00)
password:
required
string
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:
required
integer
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:
string
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:
datetimeNOW
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:
stringCASH
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:
stringN
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.

Result Format


Documentation

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. [block:api-header] { "type": "basic", "title": "Via Points" } [/block] Via Points must be provided in the following format for each array object. [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Description", "0-0": "text", "0-1": "This should contain the full via-point address text. Seek PICKUP_ADDRESS for formatting information.", "1-0": "lat", "1-1": "Via-point Latitude. Seek PICKUP_LAT for formatting information.", "2-0": "long", "2-1": "Via-point Longitude. Seek PICKUP_LONG for formatting information." }, "cols": 2, "rows": 3 } [/block] [block:api-header] { "type": "basic", "title": "Vehicle Types" } [/block] 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.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}