Skip to main content

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.

Required scope: integrations:read

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

Returns 404 when the label does not exist or belongs to a different instance.

Authentication: Requires a Bearer token.

Requires the integrations.show permission.

Request​

Responses​

OK

Response Headers
    Content-Type