Help CenterGitHub

List return labels

Returns a list of return shipping labels.

Parameters

Query Parameters

page integer
Page number for pagination
limit integer
Items per page (max 100)
status string (draft | generated | printed | shipped | delivered | delivered_exception | returned | cancelled | void)
Filter by return label status. Valid values: draft | generated | printed | shipped | delivered | delivered_exception | returned | cancelled | void. purchased is accepted as an alias for generated. Anything else returns 400 INVALID_STATUS.
carrier string (USPS | FEDEX | UPS | DHL | CANADA_POST)
Filter by carrier

Returns

200 List of return labels retrieved successfully
401 Authentication required

Related

Returns
GET/api/v1/returns