Skip to content
extensions / Commerce extension
GET/api/projects/{project_id}/sales/rma/requests

List RMA Requests

Lists a project's RMA return requests with pagination, text search, status filtering, and sorting.

GET

Authentication

Requirement
Required
Credential type
Bearer API key
Scopes
Not specified

Permissions

  • Requests are scoped to the target project_id. API-key requests must use a key with an active connection to that project.

Headers

NameRequiredTypeDetails
AuthorizationYesNot specified
Description: Bearer credential used to authenticate the request.

Path Parameters

NameRequiredTypeDetails
project_idYesNot specified
Description: Target project identifier.

Query Parameters

NameRequiredTypeDetails
pageNointeger
Description: Page number for paginated results.
per_pageNointeger
Description: Maximum number of records to return.
qNostring
Description: Search text used by this operation.
sortNostring
Description: Sort field used by this operation.
filtersNoobject
Description: Filter object used to narrow returned records.

Request Body

Response Body

Example 200 response

json
{
  "data": [],
  "page": 1
}

Errors

500 internal_error

Availability

Available in
v0.1.0
Available since
v0.1.0
Implementation
Available
Deprecation
Not specified
Rate limits
Not specified