Skip to main content

List Returns

GET 

/api/portal/returns

List the active account's returns (RMAs).

Buyer portal token

Called by a B2B portal buyer with the bearer token POST /api/portal/auth/login returns (or the buyer's feed key) — not with a staff Personal Access Token.

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).

Which orders: by default every order the account has, whatever channel it came through (the portal, the merchant's store, phone or email orders entered by staff) — another channel's draft orders are never shown. A merchant can limit this to orders placed in the portal (Portal Settings → Order history).

Request​

Responses​

OK

Response Headers
    Content-Type