Skip to main content

Get Shiptheory Shipment Label

GET 

/api/shiptheory/:integration_instance/shipments/:shipment/label

Proxies the shipping label from Shiptheory (resolved via the parent order) and streams it back as a PDF file download (Content-Type: application/pdf). The label is fetched live and never stored.

Required scope: integrations:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Path parameter:

  • integration_instance: the numeric id of the Shiptheory integration instance.
  • shipment: the internal Shiptheory shipment id.

Returns the PDF binary on success. Returns 404 on a shipment / instance mismatch, 429 when rate-limited, or 422 when the label is unavailable.

Authentication: requires a Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type