GET v1/labels

shipengine.com

Summary: List labels
Operation ID: list_labels
Auth: unknown
Description

This endpoint returns a list of labels that you've [created](https://www.shipengine.com/docs/labels/create-a-label/). You can optionally filter the results as well as control their sort order and the number of results returned at a time. By default, all labels are returned, 25 at a time, starting with the most recently created ones. You can combine multiple filter options to narrow-down the results. For example, if you only want to get your UPS labels for your east coast warehouse you could query by both `warehouse_id` and `carrier_id`

Parameters (14)

batch_id (?, query, optional)

Only return labels that were created in a specific [batch](https://www.shipengine.com/docs/labels/bulk/)

carrier_id (?, query, optional)

Only return labels for a specific [carrier account](https://www.shipengine.com/docs/carriers/setup/)

created_at_end (string, query, optional)

Only return labels that were created on or before a specific date/time

created_at_start (string, query, optional)

Only return labels that were created on or after a specific date/time

label_status (?, query, optional)

Only return labels that are currently in the specified status

page (integer, query, optional, default: 1)

Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.

Constraints: {'minimum': 1}

page_size (integer, query, optional, default: 25)

The number of results to return per response.

Constraints: {'minimum': 1}

rate_id (?, query, optional)

Rate ID

service_code (?, query, optional)

Only return labels for a specific [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/)

shipment_id (?, query, optional)

Shipment ID

sort_by (string, query, optional, default: created_at)

Controls which field the query is sorted by.

Constraints: {'enum': ['modified_at', 'created_at']}

sort_dir (?, query, optional, default: desc)

Controls the sort order of the query.

tracking_number (string, query, optional)

Only return labels with a specific tracking number

Constraints: {'minLength': 1}

warehouse_id (?, query, optional)

Only return labels that originate from a specific [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/)

No probe data for this endpoint yet.