[POST] …/v1/RetailReturnReason/get
Возвращает информацию о причинах возврата
Входные параметры
Название | Тип данных | Обязательность | Описание параметра |
---|---|---|---|
ids | array of int64 | Необязательный | Массив id причин возврата |
enabled | bool | Необязательный | Метка о том, что причина возврата доступна для использования |
sort_orders | Sort_orders | Необязательный | Сортировка выходных данных - Объект класса Sort_orders |
search | string | Необязательный | Строка поиска по полю name |
limit | Int32 | Необязательный | Лимит возвращаемых данных при запросе. Значение по умолчанию 10000. Максимальное значение 10000 |
offset | Int32 | Необязательный | Смещение от начала выборки |
Модель сортировки выходных параметров
Название | Тип данных | Описание параметра |
---|---|---|
column | enum | Значение для сортировки: Id ( Id причины возврата), Name (Наименование причины), Description (Дополнительное описание), Enabled (Метка доступности причины), LastUpdate (Дата изменения) |
direction | enum | Порядок сортировки: ASC (По возрастанию), DESC (По убыванию) |
Пример запроса
{
"ids":[1,4,5],
"enabled":true,
"sort_orders":
[
{
"column":'Name',
"direction":'desc'
}
],
"limit":20,
"offset":3
}
Выходные параметры
Название | Тип данных | Обязательность | Описание параметра |
---|---|---|---|
Result | array of RetailReturnReason | Обязательный | Массив объектов RetailReturnReason |
Пример ответа
{
"ok": true,
"result": [
{
"id": 1,
"name": "Не понравилось",
"description": null,
"enabled": true,
"last_update": 1593611279
},
{
"id": 2,
"name": "test01",
"description": "test desc",
"enabled": false,
"last_update": 1594476135
}
],
"next_offset": 0,
"total": 2
}