Cancel Pickups

Cancel Pickups.

SecuritybearerAuth
Request
header Parameters
X-PB-Developer-Partner-Id
string

This is the Developer Partner ID. When the developer is the only partner, this field is not required.

Request Body schema: application/json
pickupIds
required
Array of strings

Unique identifiers for scheduled pickups.

required
Array of objects

An array of key-value pairs specifying additional parameters for the cancellation request.
There are two required keys: REQUESTOR_NAME and REASON_FOR_CANCEL. The value for REQUESTOR_NAME is required, while the value for REASON_FOR_CANCEL is optional.

Responses
200

Pick up cancelled successfully.

400

Invalid request.

401

The request could not be authorized.

500

The request could not be completed due to an internal error.

put/api/v1/pickups/cancel
Request samples
application/json
{
  • "pickupIds": [
    ],
  • "options": [
    ]
}
Response samples
application/json
{
  • "pickups": {
    }
}