{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/cancel_booking.json","auth":"never","examples":{"codes":[]},"method":"post","params":[{"name":"username","type":"string","default":"","desc":"This is the username for the customer account (generally a phone number in international format, excluding the + or 00)","required":true,"in":"body","ref":"","_id":"543f0d0755bb10080009566f"},{"name":"password","type":"string","default":"","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).","required":true,"in":"body","ref":"","_id":"543f0dbf15d0560800502814"},{"name":"job_id","type":"int","default":"","desc":"This is the Job ID for the booking you wish to cancel.","required":true,"in":"body","ref":"","_id":"543f0dbf15d0560800502813"},{"name":"reason","type":"string","default":"","desc":"This is a text-based reason for the cancellation. For example \"Customer requested cancellation\".","required":false,"in":"body","ref":"","_id":"543f0dbf15d0560800502812"}],"results":{"codes":[{"name":"Success","code":"{\n \"result\": \"valid\"\n}","language":"json"},{"name":"Failure","code":"{\n \"result\": \"error\",\n\t \"error\": \"Reason for error (EG: Already cancelled)\"\n}","language":"json"}]},"settings":""},"next":{"description":"","pages":[]},"title":"cancel_booking","type":"endpoint","slug":"cancel_booking2","excerpt":"This allows you to cancel an active or pending booking.","body":"This chapter describes how to cancel a booking using the CANCEL_JOB command. This is an immediate tool that can be used to cancel a job in any STATUS except for Y or V. This should also be used when a modification is required to a job so that any driver that may be en-route to the location does not continue their journey to any incorrect destinations. Modification of less vital information is currently in development and not yet available.","updates":[],"order":7,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5739147c9042980e00ad1a91","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["543005c87d487022005b3fac","54345156edce04080040964e","543ee0c055bb1008000955b6","54c82a78ab706219009e0656","57390d0e1f4b740e00b06cb2","5741d5ab28f5fb0e0063ed36","5d1e4140522cd702b31b544b","5e321f8b5517b00012831b6a"],"_id":"543005c87d487022005b3fab","__v":8,"createdAt":"2014-10-04T14:35:52.362Z","releaseDate":"2014-10-04T14:35:52.362Z","project":"543005c87d487022005b3fa8"},"parentDoc":null,"__v":1,"createdAt":"2016-05-16T00:29:48.669Z","editedParams":true,"editedParams2":true,"githubsync":"","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Gazoop Customer API","slug":"iwebcab-customer-api","order":9999,"from_sync":false,"reference":false,"_id":"57390d0e1f4b740e00b06cb2","project":"543005c87d487022005b3fa8","__v":0,"createdAt":"2016-05-15T23:58:06.028Z","version":"543005c87d487022005b3fab"},"project":"543005c87d487022005b3fa8","user":"543005a67d487022005b3fa7"}
postcancel_booking
This allows you to cancel an active or pending booking.
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).
job_id:
required
integer
This is the Job ID for the booking you wish to cancel.
reason:
string
This is a text-based reason for the cancellation. For example "Customer requested cancellation".