Get

[POST] …/v1/PriceType/Get

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

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

Название Тип данных Обязательность Описание
ids array of int64 Необязательный Массив Id видов цен
currency_ids array of int64 Необязательный ID валюты
sort_orders array of SortOrders Необязательный Сортировака выходных параметров
search string Необязательный Строка поиска по: name (наименование вида цены)
limit Int32 Необязательный Количество элементов выборки, возвращаемых при запросе
offset Int32 Необязательный Смещение от начала выборки


SortOrders

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

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

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

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

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

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

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

{
    "ok": true,
    "result": [
        {
            "id": 1,
            "name": "example",
            "round_to": 0.00,
            "markup": 0.25,
            "max_discount": 0.2,
            "currency": {
                "id": 1,
                "code_num": 123,
                "code_chr": "UZS",
                "name": "Узбекский сум",
                "exchange_rate": 1,
                "is_base": true,
                "deleted": false,
                "last_update": 1533619909
            },
            "currency_additional": {
                "id": 1,
                "code_num": 123,
                "code_chr": "USD",
                "name": "Dolar",
                "exchange_rate": 1.1,
                "is_base": false,
                "deleted": false,
                "last_update": 1533619909
            },
            "last_update": 1700000000
        }
    ],
    "next_offset": 1,
    "total": 1
}