Skip to content

List Returns

Mirrors the admin Sales → Returns datagrid. Each row carries the return's status and order/customer context; the detail-only fields (item, images, availableStatuses, information, packageCondition, canReopen, messagesCount) are null on the listing — fetch them with Get Return.

The response is wrapped in the { data, meta } envelope.

Endpoint

EndpointMethod
/api/admin/rma/requestsGET

Query Parameters

ParameterTypeDescription
page, per_pageintegerPagination (default per_page=10, cap 50).
idstringFilter by return id (int or comma-list).
order_idintegerExact order id.
statusstringStatus title (e.g. Pending, Accept, Declined).
customer_namestringPartial customer name.
created_at_from / _todateCreated range.
sortstringid (default), order_id, created_at.
orderstringasc, desc (default desc).

Permission

sales.rma.requests

TIP

See the Returns overview for the status workflow and action semantics.

All admin endpoints require an admin Bearer token — see Authentication.

Released under the MIT License.