Skip to main content

List RMAs

GET 
/api/rmas

List all RMAs with pagination, filtering, and sorting via Spatie QueryBuilder.

Authentication: Requires Bearer token.

Filter system: Uses Spatie QueryBuilder filter syntax.

  • filter[search]: Searches rma_number and related sales_order_number
  • filter[status]: draft | approved | in_transit | received | closed | canceled
  • filter[customer_id]: Filters via associated sales order
  • filter[sales_order_id]: Exact match
  • Advanced text filters: filter[rma_number][is], [is_not], [contains], [does_not_contain], [starts_with], [ends_with], [is_empty], [is_not_empty]
  • Advanced date filters: filter[rma_date][from], [to], filter[created_at][from], [to]

Allowed sorts: rma_number, status, rma_date, created_at. Default sort: -created_at.

Request​

Responses​

Successful response