Appearance
GET
/config/return-reason/return-reasonsRequired scope:
viskan:returnreason:readSearches for return reasons with optional filters and pagination. Results are sorted by code (case-insensitive).
Parameters
Query parameters
page integerThe page number to retrieve. The first page is 1. Cannot be less than 1.
Default value:
1pageSize integerThe size of the pages to retrieve. The default is 10. Cannot be less than 1 and larger than 100.
Default value:
10keywords stringWhitespace-separated keywords. Each token must match the reason code or description (case-insensitive AND across tokens).
active enumFilter by the active status.
Enum:
ALLACTIVEINACTIVEDefault value:
ACTIVEResponse
The response contains the found return reasons.
JSON
[
{
"reasonId": 12345,
"reasonCode": "...",
"reasonDesc": "...",
"reasonType": "...",
"active": true
}
]
| Error code | Description |
|---|---|
invalid-page | The given page is invalid. |
invalid-page-size | The given page size is invalid. |