Get

[POST] .../v1/retailreturnreason/get

Returns return reason information. Retrieve retail return reasons for POS return workflows, return documents, reports and reference selectors. The response returns paged RetailReturnReason records with next_offset and total and supports filters, sort_orders, search, limit and offset for reason id, enabled state, name, description and update-date selection. The caller must have retail return reason select permission; missing body, denied access, invalid filters or sorting and storage errors are returned as HTTP 200 ErrorResult.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.
limit Int32 Optional Maximum number of records to return. The value is limited by server settings.
offset Int32 Optional Offset from the beginning of the result set.
search String Optional Search string for the name field.
sort_orders Array of RetailReturnReason_SortOrder Optional Output parameter sorting.

Filterable Fields

Field Type Description
enabled bool Indicates whether the return reason is available for use.
id int Return reason IDs.
name string

Sortable Fields

Field
description
enabled
id
last_update
name

Request Example

{
  "filters": [
    {
      "Field": "enabled",
      "Operator": "Equal",
      "Value": "true"
    },
    {
      "Field": "name",
      "Operator": "Like",
      "Value": "Damaged"
    }
  ],
  "sort_orders": [
    {
      "column": "name",
      "direction": "ASC"
    }
  ],
  "limit": 50,
  "offset": 0
}

Response Parameters

Name Type Description
next_offset Int32 Offset for the next data page.
ok Boolean Indicates whether the request completed successfully.
result Array of RetailReturnReason Result array.
total Int64 Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 6,
      "name": "Damaged item",
      "description": "Item was damaged before sale completion",
      "enabled": true,
      "last_update": 1712345600
    }
  ],
  "next_offset": 0,
  "total": 1
}