Skip to main content

Labels API

Purchase and manage shipping labels.

Create label​

POST /v1/labels

See Shipping API for the full request format.

Get label​

GET /v1/labels/:id

Download label​

GET /v1/labels/:id/download

Query parameters​

ParameterTypeDefaultDescription
formatstringpdfLabel format: pdf, png, or zpl

Returns the label file as a binary download.

Cancel label​

POST /v1/labels/:id/cancel

Voids the label and requests a refund from the carrier. Refunds typically process within 5-7 business days.

Response​

{
  "id": "lbl_abc123",
  "status": "cancelled",
  "refund": {
    "amount": 8.95,
    "currency": "USD",
    "status": "pending"
  }
}
note

Not all carriers support label cancellation after a certain window. USPS allows cancellation within 30 days; FedEx and UPS typically allow 24 hours.