Skip to main content
GET
List customer returns

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Query Parameters

page
integer
Required range: x >= 1
per_page
integer
default:15
Required range: 1 <= x <= 100
limit
integer

Alias for per_page, used when per_page is not supplied.

Required range: 1 <= x <= 100
status
enum<string>

Filter by return status

Available options:
Pending,
Received
restock
boolean

Filter by whether receiving the return restocks inventory

sales_order_id
integer

Filter by originating sales order (direct, or nested under a refund order)

created_at
string<date-time>

Filter by creation date

updated_at
string<date-time>

Filter by last update date

include_deleted
boolean
default:false

Include soft-deleted returns in the results. with_deleted is accepted as an alias.

only_deleted
boolean
default:false

Return only soft-deleted returns. Takes precedence over include_deleted.

Response

Successful response

data
object[]
meta
object