Edit

[POST] .../v1/retailreturnreason/edit

Edits return reason. Use this method to update an existing retail return reason while preserving references from historical returns. It returns row_affected, requires a positive id and validates optional name, description and enabled state changes when they are provided. The caller must have retail return reason edit permission; missing body, invalid id or field values, denied access, missing records, related-data restrictions and storage errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
description String Optional Additional description. When provided, it must be no longer than 300 characters.
enabled Boolean Optional Indicates whether the return reason is available for use.
id Int64 Required Return reason ID.
name String Optional Return reason name. When provided, it must be no longer than 150 characters.

Request Example

{
  "id": 6,
  "name": "Damaged item",
  "description": "Item was damaged before sale completion",
  "enabled": false
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Update Update operation result.

Response Example

{
  "ok": true,
  "result": {
    "row_affected": 1
  }
}