Get Label
GET/api/shippo/instances/:integration_instance/labels/:label
Returns one Shippo label. Each label carries its status (raw status plus status_label), carrier and service level, postage (rate_amount/rate_currency and the local-currency amount), tracking (number, status, substatus, carrier tracking URL, eta, delivered_at), the label format, download_url (streams the stored label document; null until purchased), refund state (refund_status, refund_requested_at), is_live (purchased and not refunded) and is_refundable (live and not yet scanned by the carrier), plus cross-links to the fulfillment order, sales order, sales order fulfillment and Shippo order.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Returns 404 when the label does not exist or belongs to a different instance.
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
Response Headers
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.