Skip to content

Find return reasons

GET
/config/return-reason/return-reasons
Required scope: viskan:returnreason:read

Searches for return reasons with optional filters and pagination. Results are sorted by code (case-insensitive).

Parameters

Query parameters

page  integer
The page number to retrieve. The first page is 1. Cannot be less than 1.
Default value: 1
pageSize  integer
The size of the pages to retrieve. The default is 10. Cannot be less than 1 and larger than 100.
Default value: 10
keywords  string
Whitespace-separated keywords. Each token must match the reason code or description (case-insensitive AND across tokens).
active  enum
Filter by the active status.
Enum: ALLACTIVEINACTIVE
Default value: ACTIVE

Response

The response contains the found return reasons.