Help CenterGitHub

Retrieve a label

Retrieves the details of an existing shipping label. Supply the unique label ID.

Parameters

Path Parameters

id string Required
The label ID

Returns

200 Multi-piece shipments additionally return package_count and a packages array, one entry per box, ordered by sequence (1-based). Each entry carries that box's own tracking_number and its own label_url.

The top-level tracking_number is the shipment's master number. Label the boxes from packages[].tracking_number, not from it.

Each label_url is a distinct document — fetch and print every one. sequence: 1 resolves to the shipment document; later pieces carry &piece=N.

Verify before you ship: packages.length must equal package_count, and every tracking_number must be present and distinct. If it is not, void the shipment and retry rather than dispatching boxes that have no label.
200 Label retrieved successfully
401 Authentication required
404 Label not found

Related

Labels
GET/api/v1/labels/[id]