{"_id":"543f0d0755bb10080009566d","is_link":false,"parentDoc":null,"project":"543005c87d487022005b3fa8","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"},"editedParams":true,"category":{"_id":"543ee0c055bb1008000955b6","__v":21,"pages":["543ee1d615d0560800502749","543ee5c015d0560800502758","543ee87715d0560800502763","543ee9e315d056080050276c","543f003c55bb100800095624","543f030555bb10080009563f","543f0b3e15d05608005027ee","543f0d0755bb10080009566d","543f0e8415d056080050281b","543f0f8f55bb10080009567e","543f109055bb100800095689","543f11d315d056080050282b","543f15c615d0560800502845","544aec7fa761f90800c41d32","545a7fae1d018b1400227eff","545e9dc97e32310e00f400ca","5603c5dde416560d00fa63ad","564ed2eb9209cf0d001d6917","56cb2acb245b841300806ea4","56e05f414685db1700d9480b","56e063e4f97d422900d639bf"],"project":"543005c87d487022005b3fa8","version":"543005c87d487022005b3fab","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-15T21:01:52.185Z","from_sync":false,"order":1,"slug":"iwebcab-api-tools","title":"Gazoop Internal API"},"editedParams2":true,"user":"543005a67d487022005b3fa7","__v":2,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-16T00:10:47.730Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"basic_auth":false,"method":"post","results":{"codes":[{"language":"json","code":"{\n    \"result\": \"valid\"\n}","name":"Success"},{"language":"json","code":"{\n    \"result\": \"error\",\n\t  \"error\": \"Reason for error (EG: Already cancelled)\"\n}","name":"Failure"}]},"try":true,"examples":{"codes":[]},"settings":"","auth":"never","params":[{"_id":"543f0d0755bb10080009566f","ref":"","in":"body","required":true,"desc":"This is a 25 alphanumeric hash code provided to you by the fleet.","default":"","type":"string","name":"api_key"},{"_id":"543f0d0755bb10080009566e","ref":"","in":"body","required":true,"desc":"This is the mobile number for the customer account.","default":"","type":"int","name":"phone_number"},{"_id":"543f0dbf15d0560800502814","ref":"","in":"body","required":false,"desc":"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.","default":"","type":"int","name":"customer_pin"},{"_id":"543f0dbf15d0560800502813","ref":"","in":"body","required":true,"desc":"This is the Job ID for the booking you wish to cancel.","default":"","type":"int","name":"job_id"},{"_id":"543f0dbf15d0560800502812","ref":"","in":"body","required":false,"desc":"This is a text-based reason for the cancellation. For example \"Customer requested cancellation\".","default":"","type":"string","name":"reason"}],"url":"/cancel_booking.json"},"isReference":false,"order":12,"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.","excerpt":"This allows you to cancel an active or pending booking.","slug":"cancel_booking","type":"endpoint","title":"cancel_booking"}

postcancel_booking

This allows you to cancel an active or pending booking.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

api_key:
required
string
This is a 25 alphanumeric hash code provided to you by the fleet.
phone_number:
required
integer
This is the mobile number for the customer account.
customer_pin:
integer
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.
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".

Result Format


Documentation

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.

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 }}