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

List RMA Settings

Returns a project's returns (RMA) configuration and return addresses, creating the default settings row on first access.

GETPUT

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

This operation does not accept query parameters.

Request Body

This operation does not accept a request body.

Response Body

Example 200 response

json
{
  "project_id": 1,
  "enabled": "string",
  "return_window_days": [],
  "require_approval": "string",
  "allow_more_info": "string",
  "auto_approve": "string",
  "allowed_statuses": [],
  "default_return_address_id": 1,
  "updated_at": "2026-01-01T00:00:00Z",
  "return_addresses": []
}

Errors

500 internal_error

Availability

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