GET /labels/{orderId}

List available label types for an order, with download URLs on this API.

Scope: shipments:labels or shipments:create

Path parameters

Name	Required	Description
orderId	Yes	Order UUID from ship metadata.orderId

Request body

None.

Preconditions

• Order exists.
• order.companyId matches the API key organization.

Each available label type includes a download URL on this API.

Success response (200)

{
  "data": {
    "orderId": "uuid-order-id",
    "available": [
      {
        "code": "PDF",
        "name": {
          "en": "PDF",
          "fr": "PDF"
        },
        "url": "https://api.{env}.saveonexpress.ca/integrations/public-api/v1/labels/uuid-order-id/PDF"
      },
      {
        "code": "COMINV",
        "name": {
          "en": "Commercial Invoice",
          "fr": "Commercial Invoice"
        },
        "url": "https://api.{env}.saveonexpress.ca/integrations/public-api/v1/labels/uuid-order-id/COMINV"
      }
    ]
  }
}

Field	Type	Description
orderId	string	Order UUID
available	array	Label types for this order
available[].code	string	Label type code (use in path for download)
available[].name	object	Localized display name (en, fr)
available[].url	string	GET this URL (with X-API-Key) to download or generate the label

Common code values (carrier-dependent): PDF, ZPL, ZPLPDF, COMINV, RETINV, PACKSLIP, BOL, MANIFEST, and others returned by the carrier label service.

Error responses

HTTP	Condition
400	Missing orderId
401	API key auth failure
403	Missing scope, or order belongs to another company
404	Order not found
500	Label service error