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.
integrations:readGrant 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
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.