labels

Void a label by id

Void a specific label using its label id. For labels that are paid for at time of label creation, this will also request a refund from the carrier.

put/v2/labels/{label_id}/void

Request

  • Base URL: https://api.shipstation.com
  • URL: https://api.shipstation.com/v2/labels/{label_id}/void
  • Auth: API key in header api-key

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."
}

Changes

No recorded changes to this operation across all 1 revision of this API.