Skip to main content
POST
Cancel shipment

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

reference_number
string
required

Shipment reference number

Body

application/json

Cancel payload used when no refund is required. The shipment is marked as unscheduled and can be rescheduled with another carrier or fulfilled manually.

action
string
required

Set to cancel to cancel the shipment without issuing a refund.

Allowed value: "cancel"
reason
string
required

Reason recorded against the cancellation for audit and customer communication.

Response

200 - application/json

OK

message
string
success
boolean