Cancel Shipment

CancelShipment - Cancel shipment before pickup

Use this endpoint to cancel a shipment using its trackingNumber.

A shipment can only be cancelled before it has been picked up. Once the shipment has been picked up or has moved into the delivery process, it can no longer be cancelled through this endpoint.

Important rules

Only one shipment can be cancelled per request.
The shipment must not have been picked up yet.
After pickup, cancellation is no longer allowed.

Required URL parameter

trackingNumber - Public tracking number of the shipment to cancel.

Summary

Use CancelShipment only when you need to cancel a single shipment before pickup.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

application/json

Successful response

Bodyapplication/json

Example

{
    "status": "success",
    "message": "Shipment cancelled successfully",
    "data": true
}

CancelShipment - Cancel shipment before pickup

Important rules

Required URL parameter

Summary

Request

Request Code Samples

Responses

Cancel Shipment

CancelShipment - Cancel shipment before pickup#

Important rules#

Required URL parameter#

Summary#

Request

Request Code Samples

Responses

CancelShipment - Cancel shipment before pickup

Important rules

Required URL parameter

Summary