Skip to main content
GET
List label-purchase requests

Authorizations

Authorization
string
header
default:ShippoToken
required

Shippo API token, sent as Authorization: ShippoToken <API_TOKEN>.

Query Parameters

cursor
string | null

Opaque next-page token; use the next link from a prior response verbatim.

limit
integer
default:25

Page size, 1–100 (default 25).

Required range: 1 <= x <= 100
shipment_id
string | null

Filter to requests with this shipment_id.

tracking_number
string | null

Filter to requests with this tracking number.

status
enum<string> | null

Filter by status: processing, purchased, dry_run_completed, no_match, or failed.

Available options:
processing,
purchased,
dry_run_completed,
no_match,
failed
dry_run
boolean | null

Filter to dry-run (true) or live (false) requests.

Response

Successful Response

A page of request summaries, newest first. next links to the following page with your filters and page size already applied; it is null on the last page.

results
AutomationsLabelSummary · object[]
required
next
string | null
required