When you as the client cancel a job with Stuart, you can now supply us with a reason along with any other comments as to why you’re cancelling.
This is optional but helps both you and Stuart analyse and identify problem areas in your delivery solution - such as systemic problems with particular stores being closed or packages not being ready in time.
You specify the reason code along with any additional comments when calling our cancel a Job API or cancel a delivery API - included in the payload. For example:
{
"public_reason_key": "package_not_ready",
"comment": "The package is not ready to be picked up"
}
The full list of reasons you can specify are specified in the above endpoint schemas or alternatively are provided in a table in our cancellation reasons page here in our API documentation