Get

[POST] …/v1/RetailReturnReason/Get

Возвращает информацию о причинах возврата.

Входные параметры

Название Тип данных Обязательность Описание
ids Array of int64 Необязательный Массив id причин возврата
enabled Boolean Необязательный Метка о том, что причина возврата доступна для использования
sort_orders Array of SortOrders Необязательный Сортировака выходных параметров
search String Необязательный Строка поиска по полю name
limit Int32 Необязательный Лимит возвращаемых данных при запросе. Значение по умолчанию 10000. Максимальное значение 10000
offset Int32 Необязательный Смещение от начала выборки


SortOrders

Модель сортировки выходных параметров

Название Тип данных Описание
column Enum Значение для сортировки: <Id | 1> - Id причины возврата, <Name | 2> - Наименование причины, <Description | 3> - Дополнительное описание, <Enabled | 4> - Метка доступности причины, <LastUpdate | 5> - Дата изменения
direction Enum Порядок сортировки: <ASC | 1> - по возростанию, <DESC | 2> - по убыванию

Пример запроса

{
    "ids": [
        1
    ],
    "enabled": true,
    "sort_orders": [
        {
            "column": "Name",
            "direction": "desc"
        }
    ],
    "limit": 1,
    "offset": 0
}

Выходные параметры

Название Тип данных Описание
result Array of RetailReturnReason Массив причин возврата

Пример ответа

{
    "ok": true,
    "result": [
        {
            "id": 1,
            "name": "Не понравилось",
            "description": "example",
            "enabled": true,
            "last_update": 1593611279
        }
    ],
    "next_offset": 1,
    "total": 1
}