Skip to main content

Get Shiptheory Order Label

GET 

/api/shiptheory/:integration_instance/orders/:order/label

Proxies the shipment's shipping label from Shiptheory and streams it back as a PDF file download (Content-Type: application/pdf). The label is fetched live and never stored — it is re-downloadable at any time once the order is Complete.

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.
  • order: the internal Shiptheory order id.

Returns the PDF binary on success. Returns 404 on an order / instance mismatch, 429 when Shiptheory rate-limits, or 422 when the label is unavailable (e.g. the order is not yet Complete).

Authentication: requires a Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type