Get

[POST] …/v1/DeliveryType/Get

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

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

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


SortOrders

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

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

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

{
    "ids":[1],
    "redefinition_option": {
        "language": "RUS",
        "app_id": 1
    },
    "sort_orders": [
        {
          "column": "Name",
          "direction": "ASC"
        }
    ],
    "search": "example",
    "limit":1,
    "offset":1
}

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

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

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

{
    "ok": true,
    "result": [
        {
            "id": 1,
            "name": "Самовывоз",
            "last_update": 1534151629
        }
    ],
    "next_offset": 1,
    "total": 1
}