List Returns
GET/api/portal/returns
List the active account's returns (RMAs).
Authentication: Bearer token (Personal Access Token).
Filtering: pass column filters as filter[<column>] or filter[<column>.<operator>] (e.g. filter[status]=approved, filter[rma_number.contains]=RMA-00). For AND/OR logic use filter_groups (base64-encoded JSON tree). Free-text search uses filter[search] across the RMA number and originating order number, optionally scoped via search_columns / search_strict_columns.
Sorting: sort=<field>, prefix - for descending. Allowed: id, rma_number, status, created_at.
Pagination: page (default 1), per_page (default 10, max 100).
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.