Sign in

v1

latestOpenAPI 3.0.02026-07-1397337495.2 KB
labels

Void a Label By ID

Void a label by ID to get a refund.

put/v1/labels/{label_id}/void

Response

The request was a success.

approvedboolean required

Indicates whether the attempt to void the label was successful

messagestring required
reason_code'unknown' | 'unspecified' | 'validation_failed' | 'label_not_found_within_void_period' | 'label_already_used' | 'label_already_voided' | 'contact_carrier'

The possible normalized reasons a label void request may not have been approved

Example response

{
  "message": "Unable to delete FedEx shipment. Unable to retrieve record from database."
}