List Returns

get

https://api.warehance.com/v1/returns

Required permission: read_returns

Get a list of returns for your organization or client.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

sort_by

string

enum

Specifies the field by which to sort the returned returns:

created_at: Sort by the creation date of the return.

Allowed:

limit

integer

1 to 100

Defaults to 25

The maximum number of items to return in the response. Used for pagination. Must be between 1 and 100.

offset

integer

≥ 0

Defaults to 0

The number of items to skip before starting to return results. Used for offset-based pagination. Cannot be used together with the cursor parameter.

cursor

string

A cursor for pagination. Use the next_cursor value from a previous response to fetch the next page of results. This provides more efficient pagination than offset-based pagination, especially for large datasets. Cannot be used together with the offset parameter.

order_by

string

enum

Defaults to asc

Specifies the sort direction of the returned items:

asc: Ascending order. For dates, this means from oldest to newest. For numbers, this means from smallest to largest.
desc: Descending order. For dates, this means from newest to oldest. For numbers, this means from largest to smallest.

Allowed:

search_value

string

A value to search for within the items. The specific fields searched depend on the endpoint.

client_id

integer

≥ 1

Only applicable for organizations. Filters items by the specified client_id, provided the client_id belongs to the organization. Note: API keys can belong to either client level or organization level.

paid_by

string

enum

Filter returns by who paid for the return shipping label.

merchant: Returns where a label was purchased by the merchant.
customer: Returns where the customer paid (no label was generated by Warehance).

Allowed:

processed

boolean

Filter returns by their processed state.

created_at_start

date-time

Filters items by the specified created_at start date.

created_at_end

date-time

Filters items by the specified created_at end date.

updated_at_start

date-time

Filters items by the specified updated_at start date.

updated_at_end

date-time

Filters items by the specified updated_at end date.

processed_at_start

date-time

Filters items by the specified processed_at start date.

processed_at_end

date-time

Filters items by the specified processed_at end date.

latest_tracking_event_at_start

date-time

The start date-time for filtering returns whose latest tracking event occurred after this date.

latest_tracking_event_at_end

date-time

The end date-time for filtering returns whose latest tracking event occurred before this date.

Responses

200A list of returns

400Example Error Response