Labels

Generate a Label

POST /v1/labels

Generates a shipping label for an existing shipment. This charges the label cost to your account.

Request

{
  "shipment_id": "shp_01HXYZ1234ABCD",
  "format": "pdf",
  "size": "4x6"
}

Response

{
  "id": "lbl_01HABC5678IJKL",
  "shipment_id": "shp_01HXYZ1234ABCD",
  "tracking_number": "9400111899223456789012",
  "carrier": "usps",
  "format": "pdf",
  "label_url": "https://cdn.orbiscommerce.com/labels/lbl_01HABC5678IJKL.pdf",
  "expires_at": "2025-06-08T14:30:00Z",
  "created_at": "2025-06-01T14:31:00Z"
}

The label_url is a pre-signed URL valid for 7 days.

Download a Label

GET /v1/labels/:id/download

Returns the label file directly as application/pdf, image/png, or application/zpl.

curl https://api.orbiscommerce.com/v1/labels/lbl_01HABC5678IJKL/download \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --output label.pdf

Void a Label

DELETE /v1/labels/:id

Voids a label and initiates a refund if eligible. Labels must be voided within 30 days of generation and must not have been scanned by the carrier.

{
  "id": "lbl_01HABC5678IJKL",
  "status": "voided",
  "refund": {
    "amount": "8.50",
    "currency": "USD",
    "estimated_at": "2025-06-05T00:00:00Z"
  }
}