Get

[POST] …/v1/Stock/Get

Возвращает информацию о складе.

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

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

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

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

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

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

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

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

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

{
    "ok": true,
    "result": [
        {
            "id": 1,
            "name": "Новомосковская",
            "address": "example",
            "firm": {
                "id": 1,
                "group": {
                    "id": 1,
                    "parent_id": 0,
                    "name": "Предприятия",
                    "child_count": 0,
                    "last_update": 1715233269
                },
                "deleted_mark": false,
                "last_update": 1715863600,
                "name": "REGOS",
                "fullname": "ООО \"REGOS Software\"",
                "boss_name": "Андрей",
                "address": "Мукими, 8А",
                "phones": "+998987654321",
                "description": "EasyTrade successor",
                "inn": "305930137",
                "bank_name": "Ипак Йули",
                "mfo": "01101",
                "rs": "22125489632541254782",
                "oked": "62090",
                "vat_index": "1325489654785"
            },
            "description": "example",
            "deleted_mark": false,
            "last_update": 1705583155
        }
    ],
    "next_offset": 0,
    "total": 1
}