Skip to content

Cancel a shipment

DELETE
/shipping/api/v1/shipments/{id}

Void a shipping label and request a refund. Refund eligibility depends on carrier policies.

id
required
string

The shipment ID to cancel

Example
prb8a99eb17

Shipment cancelled successfully

Shipment cannot be cancelled

object
error_messages
required

List of error messages

Array<string>
[
"to_address is required"
]
{
"error_messages": [
"Invalid request parameters"
]
}

Shipment not found

object
error_messages
required

List of error messages

Array<string>
[
"to_address is required"
]
{
"error_messages": [
"Invalid request parameters"
]
}