Skip to main content

List Labels

GET 
/api/shippo/instances/:integration_instance/labels

Paginated Shippo labels (transactions) for the instance — one row per parcel. Each list row also carries parcel_count: how many labels were bought from the same rate (the M in "parcel N of M", with parcel_index giving N), counted across all pages. Includes labels bought through SKU.io and labels bought directly in Shippo (imported by the label sync). 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.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Filtering: every filter[<column>] param below accepts an operator suffix, filter[<column>.<operator>]=<value>; list operators take a comma-separated value. Alternatively pass a nested AND/OR tree in filter_groups (base64-encoded JSON) — see that param.

Sorting: id, shippo_object_id, status, carrier, servicelevel_name, tracking_number, tracking_status, refund_status, rate_amount, purchased_at, eta, delivered_at, created_at, updated_at, label_file_type, parcel_count (default -id). Pagination: per_page defaults to 10.

Returns a standard paginated envelope: data[] plus current_page, from, to, per_page, total, last_page, first_page_url, last_page_url, next_page_url, prev_page_url, path and links. Returns 404 for an unknown instance.

Authentication: Requires a Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type