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 three required keys: REQUESTOR_NAME, REASON_FOR_CANCEL and REMARKS. Different carriers required different keys and values for

Carrier Is options required? Required keys Value
USPS No
DHL Express Yes REQUESTOR_NAME, REASON_FOR_CANCEL REQUESTOR_NAME value required; REASON_FOR_CANCEL value optional.
FedEx Yes REMARKS REMARKS value required.

Notes:

  • Keys are case-sensitive.
  • Provide only the keys relevant to the selected carrier.
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": {
    }
}