Update RMA Setting

Updates a project's returns (RMA) configuration, including the return window, approval behavior, allowed statuses, and default return address.

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

Name	Required	Type	Details
`Authorization`	Yes	Not specified	Description: Bearer credential used to authenticate the request.

Path Parameters

Name	Required	Type	Details
`project_id`	Yes	Not specified	Description: Target project identifier.

Query Parameters

This operation does not accept query parameters.

Request Body

Schema: RmaSettingsPayload

Field	Required	Type	Details
`enabled`	No	boolean	Description: Boolean flag.
`return_window_days`	No	integer	Description: Integer value.
`require_approval`	No	boolean	Description: Boolean flag.
`allow_more_info`	No	boolean	Description: Boolean flag.
`auto_approve`	No	boolean	Description: Boolean flag.
`allowed_statuses`	No	array<string>	Description: Array value. Items: string
`default_return_address_id`	No	integer	Description: Identifier for default return address.

Response Body

Example 200 response

json

{
  "success": []
}

Errors

500 internal_error

Availability

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

Example request

PUT/api/projects/{project_id}/sales/rma/settings

Base URLhttps://api.modusell.com

curl --request PUT \
  --url "https://api.modusell.com/api/projects/example_project_id/sales/rma/settings" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{"enabled":true,"return_window_days":1,"require_approval":true,"allow_more_info":true,"auto_approve":true,"allowed_statuses":[],"default_return_address_id":1}'

Response

Examples are not available for this release.

Authentication

Required: Bearer API key.