Detailed Returns List

Pull a detailed list of returns created within a given timeframe.

This endpoint supports pagination. We highly encourage using pagination for this endpoint.

Read the guide on paginating requests for details.

Note: If no datetimes are passed, the response defaults to only contain returns from the previous 24 hours. See Query Params below for more information.

Note: The maximum number of days in the range of the from and to properties is 120 days. If the number of days in this range exceeds 120 days, a validation error will be returned.

Note: If no state is passed, the response defaults to only contain open, closed, and expired returns. See Query Params below for more information.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

The start date and time for the returns list.

string

The end date and time for the returns list.

string
enum
Defaults to created_at

The date used to filter results.

Allowed:
string
enum

The keywords used to filter the list to only include returns in a particular state.

Defaults to only contain open, closed, and expired returns.

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json