Документация по работе с API Эхолот-партнер

Базовый URL: https://eholot.eutd.ru/api


Аутентификация

Для начала работы с нашем API в заголовки запросов (headers) нужно передать 2 параметра:
Key Value
X-ClientId {Ваш ClientId}
X-Secret {Ваш API ключ}
Эти данные выдаются менеджером, их нужно передавать при каждом запросе.


Получение списка складов

Метод: GET /goods/warehouses

Пример ответа:
        [
            "warehouse_1",
            "warehouse_2"
        ]
    


Получение списка групп

Метод: GET /goods/groups

Пример ответа:
        [
            "group_1",
            "group_2"
        ]
    

Получение списка типов цены

Метод: GET /goods/pricetypes

Пример ответа:
        [
            "price_type_1",
            "price_type_2"
        ]
    


Получение данных номенклатуры

Метод: GET /goods/list

Метод поддерживает следующие параметры:
Параметр Тип Значение по умолчанию Максимальное значение Описание
take int 250 2500 Кол-во элементов получаемое за раз
offset int 0 не ограничено Кол-во пропускаемых элементов
sort_field string id не ограничено Поле по которому производится сортировка
sort string ASC не ограничено Метод сортировки (ASC \ DESC)
filter_field string warehouse\group\price_type\null не ограничено Поле по которому производится фильтрация
filter string не ограничено Значение по которому фильтруются данные
Пример ответа:
        [
            {
                "id": 1,
                "name": "Отвод П90-273х8-20 ГОСТ 17375-2001",
                "code": "УТТД0055983",
                "warehouse": "ГОТОВАЯ ПРОДУКЦИЯ СКЛАД",
                "group": "ОП90 - Продукция (ст.20)",
                "freeBalance": "161",
                "priceType": "ГАЗПРОМ",
                "amount": 10500.02,
                "visibilityRange": 1,
                "updateAt": 2000-07-01T00:00:00+00:00
            },
            {
                "id": 1,
                "name": "Отвод П90-273х8-20 ГОСТ 17375-2001",
                "code": "УТТД0055983",
                "warehouse": "ГОТОВАЯ ПРОДУКЦИЯ СКЛАД",
                "group": "ОП90 - Продукция (ст.20)",
                "freeBalance": "161",
                "priceType": "ГАЗПРОМ",
                "amount": 10500.02,
                "visibilityRange": 1,
                "updateAt": 2000-07-01T00:00:00+00:00
            }
        ]