post

/partner/jobs/{id}/cancellations

It cancels a given job under a restriction that allows it to be cancelled:

  1. Until its state is on pickup_arrived. This includes the following states: requested, received, queued, assigned, pending_assignment, pickup_started and pickup_arrived. When the job is on any other state, this request will be rejected.

  2. If the job is on pickup_arrived, the partner can only cancel it in the first 5 minutes the job got onto this last state. Meaning that if the courier has arrived at the pickup 6 minutes ago, the partner will not be able to cancel this job anymore.

Authorization

oauth2 - clientCredentials

Request Parameters

1 Path Parameter

Responses

1 Example
Schema
object
state
string

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
id
$$.env
1 variable not set
oauth_access_token