Get

[POST] …/v1/Unit/Get

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

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

Название Тип данных Обязательность Описание
ids array of int64 Необязательный Массив id единиц измерения
type enum Необязательный Тип единицы измерения: <non_pcs | 1> (не штучный (весовой)), <pcs | 2> (штучный)
sort_orders SortOrders Необязательный Сортировка выходных данных
search string Необязательный Строка поиска по полю: name
limit Int32 Необязательный Лимит возвращаемых данных при запросе. Значение по умолчанию 10000. Максимальное значение 10000
offset Int32 Необязательный Смещение от начала выборки
SortOrders

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

Название Тип данных Описание
column enum Значение для сортировки: <Id | 1> (Id единицы измерения), <Name | 2> (Наименование единицы измерения), <Type | 3> (Тип единицы измерения), <LastUpdate | 4> (Дата изменения)
direction enum Порядок сортировки: <ASC | 1> (по возростанию), <DESC | 2> (по убыванию)

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

{
    "ids": [
        1
    ],
    "type": 1,
    "sort_orders": [
        {
            "column": "Name",
            "direction": "desc"
        }
    ],
    "search": "example",
    "limit": 20,
    "offset": 3
}

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

Название Тип данных Описание
Result array of Unit Массив единиц измерения
next_offset Int32 Смещение для следующей выборки данных
total Int32 Количество элементов выборки

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

{
    "ok": true,
    "result": [
        {
            "id": 5,
            "name": "Кг",
            "type": 2,
            "description": "Килограмм",
            "kkm_code": 235,
            "last_update": 1713435678
        }
    ],
    "next_offset": 1,
    "total": 1
}