Skip to main content
GET
List all returns

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer<int32>

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 50.

Required range: x <= 100
page
string

Cursor token to fetch next page of results.

Filter returns by formatted IDs and customer names

status
enum<string>

Filter return orders by status, can be a comma-separated list of statuses

Available options:
requested,
expected,
received,
in_progress,
completed,
cancelled

Response

A paged array of returns

data
object[]
nextPage
null | string