Novantix API v1.0 v1.0

API для работы с системой Novantix

🌐 Базовый URL: https://api.novantix.ru/

📌 Эндпоинтов: 9

🔐 Типов авторизации: 3

⚠️ Кодов ошибок: 44

🔐 Типы авторизации

none

Без авторизации

credentials

Логин/пароль

key

API ключ в параметре ?key=

📡 Методы API

GET /docs Просмотр документации API Без авторизации

▼

Документация API

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

https://api.novantix.ru/docs.json

📊 Параметры

Параметр	Тип	Обязательность	Описание
`format`	string	Опциональный	Формат возвращаемой документации Допустимые значения: `html` `json` `xml` По умолчанию: `html`

📫 Ответ

html/json/xml

Документация API в запрошенном формате

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

JSON Response

Документация в запрошенном формате

GET /auth/key Получить API ключ Логин/пароль

▼

Получение API ключа для доступа к защищенным эндпоинтам

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

https://api.novantix.ru/auth/key.json?user=00002839&pass=********

📊 Параметры

Параметр	Тип	Обязательность	Описание
`user`	string	Обязательный	Имя пользователя (логин) для аутентификации Пример: `00002839`
`pass`	string	Обязательный	Пароль пользователя Пример: `********`
`format`	string	Опциональный	Формат ответа Допустимые значения: `json` `xml` По умолчанию: `json`

📫 Ответ

json/xml

Объект с API ключом и информацией о его действии

📋 Структура ответа

Поле	Тип	Описание
`key`	string	Сгенерированный API ключ для доступа к защищенным эндпоинтам
`user`	string	Имя пользователя, для которого выдан ключ
`expires_in`	integer	Время жизни ключа в секундах (по умолчанию 90 дней)

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

JSON Response

{
    "key": "xxx",
    "user": "00002839",
    "expires_in": 7776000
}

GET /references/brands Справочник брендов API ключ в параметре ?key=

▼

Получение справочника брендов автозапчастей

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

https://api.novantix.ru/references/brands.json?key=xxx

📊 Параметры

Параметр	Тип	Обязательность	Описание
`key`	string	Обязательный	API ключ, полученный через /auth/key
`format`	string	Опциональный	Формат ответа Допустимые значения: `json` `xml` По умолчанию: `json`

📫 Ответ

json/xml

Массив брендов автозапчастей

📋 Структура ответа

Поле Тип Описание

brands

array

Массив объектов брендов

Поле	Тип	Описание
`id`	integer	Уникальный идентификатор бренда в системе Novantix
`name`	string	Название бренда

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

JSON Response

{
    "brands": [
        {
            "id": 1,
            "name": "Bosch"
        },
        {
            "id": 2,
            "name": "Mann"
        }
    ]
}

GET /ordering/get_stock Поиск остатков по артикулу API ключ в параметре ?key=

▼

Получение остатков и предложений по артикулу (поиск в базе Novantix). Поиск выполняется в два этапа: 1-й этап — базовый поиск по артикулу (ограниченное число поставщиков); 2-й этап — уточнённый поиск с указанием бренда (полный список поставщиков). Для получения максимально точных результатов рекомендуется передавать brand_id или brand_name. Этап поиска возвращается в поле search_stage каждого элемента ответа.

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

https://api.novantix.ru/ordering/get_stock.json?items[0][resource_article]=2630035505&items[0][brand_name]=Hyundai&key=xxx

📊 Параметры

Параметр Тип Обязательность Описание

key

string

Обязательный

API ключ, полученный через /auth/key

items

array

Обязательный

Массив запрашиваемых артикулов

Параметр	Тип	Обязательность	Описание
`items[N][resource_article]`	string	Обязательный	Артикул товара Пример: `2630035505`
`items[N][brand_id]`	string	Опциональный	ID бренда (из справочника /references/brands). При указании выполняется 2-й этап поиска с расширенным списком поставщиков Пример: `134`
`items[N][brand_name]`	string	Опциональный	Название бренда. При указании выполняется 2-й этап поиска с расширенным списком поставщиков. Можно использовать вместо brand_id Пример: `Hyundai`

analogs

integer

Опциональный

Возвращать ли аналоги (0 - только оригиналы, 1 - с аналогами)
Допустимые значения: 0 1

📫 Ответ

json

Результат поиска в формате Novantix API

📋 Структура ответа

Поле Тип Описание

resources

array

Массив найденных товаров

Поле	Тип	Описание
`id`	integer	ID товара для добавления в корзину
`name`	string	Наименование товара
`article`	string	Артикул товара
`brand`	object\|null	Объект бренда
`offers`	array	Массив предложений по товару
`source_idx`	integer	Индекс во входном массиве items
`search_stage`	integer	Этап поиска: 1 — базовый поиск (бренд не указан или не найден в ответе, число поставщиков ограничено); 2 — уточнённый поиск по бренду (полный список поставщиков). Рекомендуется передавать brand_id или brand_name для получения результатов 2-го этапа

warnings

array

Массив предупреждений

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

JSON Response

{
    "resources": [
        {
            "id": 980139,
            "name": "Фильтр масляный",
            "article": "2630035505",
            "brand": {
                "id": null,
                "name": "Hyundai / KIA"
            },
            "offers": [
                {
                    "price": 270.64,
                    "quantity": 1733,
                    "reliability": 100,
                    "average_period": 2,
                    "warehouse": {
                        "id": 1,
                        "name": "Склад"
                    }
                }
            ],
            "source_idx": 0,
            "search_stage": 2
        }
    ],
    "warnings": []
}

POST /ordering/get_stock Поиск остатков по артикулу (POST) API ключ в параметре ?key=

▼

Получение остатков по артикулу. Поддерживает передачу API ключа в JSON body. Поиск выполняется в два этапа: 1-й этап — базовый поиск по артикулу (ограниченное число поставщиков); 2-й этап — уточнённый поиск с указанием бренда (полный список поставщиков). Для получения максимально точных результатов рекомендуется передавать brand_id или brand_name.

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

https://api.novantix.ru/ordering/get_stock.json (POST с JSON body)

📊 Параметры

Параметр Тип Обязательность Описание

key

string

Обязательный

API ключ, полученный через /auth/key

items

array

Обязательный

Массив запрашиваемых артикулов

Параметр	Тип	Обязательность	Описание
`items[N][resource_article]`	string	Обязательный	Артикул товара Пример: `2630035505`
`items[N][brand_id]`	string	Опциональный	ID бренда (из справочника /references/brands). При указании выполняется 2-й этап поиска с расширенным списком поставщиков Пример: `134`
`items[N][brand_name]`	string	Опциональный	Название бренда. При указании выполняется 2-й этап поиска с расширенным списком поставщиков. Можно использовать вместо brand_id Пример: `Hyundai`

analogs

integer

Опциональный

Возвращать ли аналоги (0 - только оригиналы, 1 - с аналогами)
Допустимые значения: 0 1

📫 Ответ

json

Результат поиска в формате Novantix API

📋 Структура ответа

Поле Тип Описание

resources

array

Массив найденных товаров

Поле	Тип	Описание
`id`	integer	ID товара для добавления в корзину
`name`	string	Наименование товара
`article`	string	Артикул товара
`brand`	object\|null	Объект бренда
`offers`	array	Массив предложений по товару
`source_idx`	integer	Индекс во входном массиве items
`search_stage`	integer	Этап поиска: 1 — базовый поиск (бренд не указан или не найден в ответе, число поставщиков ограничено); 2 — уточнённый поиск по бренду (полный список поставщиков). Рекомендуется передавать brand_id или brand_name для получения результатов 2-го этапа

warnings

array

Массив предупреждений

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

JSON Response

{
    "resources": [
        {
            "id": 980139,
            "name": "Фильтр масляный",
            "article": "2630035505",
            "brand": {
                "id": null,
                "name": "Hyundai / KIA"
            },
            "offers": [
                {
                    "price": 270.64,
                    "quantity": 1733,
                    "reliability": 100,
                    "average_period": 2,
                    "warehouse": {
                        "id": 1,
                        "name": "Склад"
                    }
                }
            ],
            "source_idx": 0,
            "search_stage": 2
        }
    ],
    "warnings": []
}

GET /ordering/add_to_cart Добавление товаров в корзину API ключ в параметре ?key=

▼

Добавление товаров в корзину Novantix. Используйте item_id из результатов поиска.. Требуется API ключ для доступа

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

https://api.novantix.ru/ordering/add_to_cart.json?key=xxx&items[0][item_id]=980139&items[0][count]=1

📊 Параметры

Параметр Тип Обязательность Описание

key

string

Обязательный

API ключ

items

array

Обязательный

Массив товаров для добавления

Параметр	Тип	Обязательность	Описание
`items[N][item_id]`	string	Обязательный	ID товара из результатов поиска (поле id) Пример: `980139`
`items[N][count]`	integer	Опциональный	Количество По умолчанию: `1` Пример: `1`

📫 Ответ

json

Результат добавления товаров

📋 Структура ответа

Поле	Тип	Описание
`success`	boolean	Флаг успешности
`message`	string	Описание результата
`results`	array	Результаты для каждого товара

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

JSON Response

{
    "success": true,
    "message": "Added 1 item(s), failed for 0 item(s)",
    "results": [
        {
            "index": 0,
            "item_id": "980139",
            "status": "success",
            "cart_response": {
                "ok": true,
                "result": {
                    "id": 518,
                    "num": 1
                }
            }
        }
    ]
}

GET /references/states Справочник статусов заказа API ключ в параметре ?key=

▼

Возвращает справочник статусов заказа с идентификаторами, названиями и типами. Требуется API ключ для доступа.

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

https://api.novantix.ru/references/states.json?key=xxx

📊 Параметры

Параметр	Тип	Обязательность	Описание
`key`	string	Обязательный	API ключ для аутентификации Пример: `190f024bcb6d207f1fc227d8261f56b7f903b9938ce789d8cbd3da1d39ed6aca`
`format`	string	Опциональный	Формат ответа Допустимые значения: `json` `xml` По умолчанию: `json`

📫 Ответ

json array

Массив объектов статусов заказа

📋 Структура ответа

Поле	Тип	Описание
`id`	integer	Идентификатор статуса
`name`	string	Наименование статуса
`type`	integer	Тип статуса: 0 - обычный, 1 - при размещении заказа, 2 - при завершении обработки

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

JSON Response

[
    {
        "id": 10,
        "name": "Заказ создан",
        "type": 1
    },
    {
        "id": 20,
        "name": "В работе у менеджера",
        "type": 0
    },
    {
        "id": 30,
        "name": "Заказан у поставщика",
        "type": 0
    },
    {
        "id": 50,
        "name": "В резерве",
        "type": 0
    },
    {
        "id": 100,
        "name": "Выдан",
        "type": 2
    },
    {
        "id": 200,
        "name": "Отменен",
        "type": 2
    },
    {
        "id": 300,
        "name": "Возврат",
        "type": 2
    }
]

GET /ordering/states/active Список активных заказов API ключ в параметре ?key=

▼

Возвращает список активных заказов и статусы по ним. Требуется API ключ для доступа.

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

https://api.novantix.ru/ordering/states/active.json?key=xxx

📊 Параметры

Параметр	Тип	Обязательность	Описание
`key`	string	Обязательный	API ключ для аутентификации Пример: `190f024bcb6d207f1fc227d8261f56b7f903b9938ce789d8cbd3da1d39ed6aca`
`format`	string	Опциональный	Формат ответа Допустимые значения: `json` `xml` По умолчанию: `json`

📫 Ответ

json array

Массив заказов (прямой массив)

📋 Структура ответа

Поле	Тип	Описание
`id`	integer	Идентификатор заказа
`created_at`	datetime	Дата и время создания заказа
`items`	array	Массив позиций заказа с информацией о статусах

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

JSON Response

[
    {
        "id": "191",
        "reference": "00000236",
        "items": [
            {
                "sequence": 1,
                "resource": {
                    "article": "2630035505",
                    "brand": "!А",
                    "name": "Hyundai / KIA"
                },
                "quantity": 1,
                "price": 270.64,
                "state": {
                    "id": 10,
                    "name": "Заказ создан"
                }
            }
        ]
    }
]

GET /ordering/states Статусы заказов по идентификаторам API ключ в параметре ?key=

▼

Возвращает статусы заказов по их идентификаторам. Требуется API ключ для доступа.

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

https://api.novantix.ru/ordering/states.json?orders[]=123&orders[]=456&key=xxx

📊 Параметры

Параметр	Тип	Обязательность	Описание
`orders[]`	array	Обязательный	Массив идентификаторов заказов Пример: `Warning: htmlspecialchars() expects parameter 1 to be string, array given in /home/userapi/api_novantix/v1/controllers/DocsController.php on line 251`
`key`	string	Обязательный	API ключ для аутентификации Пример: `190f024bcb6d207f1fc227d8261f56b7f903b9938ce789d8cbd3da1d39ed6aca`
`format`	string	Опциональный	Формат ответа Допустимые значения: `json` `xml` По умолчанию: `json`

📫 Ответ

json array

Массив заказов (прямой массив)

📋 Структура ответа

Поле	Тип	Описание
`id`	integer	Идентификатор заказа
`created_at`	datetime	Дата и время создания заказа
`items`	array	Массив позиций заказа с информацией о статусах

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

JSON Response

[
    {
        "id": "191",
        "reference": "00000236",
        "items": [
            {
                "sequence": 1,
                "resource": {
                    "article": "2630035505",
                    "brand": "!А",
                    "name": "Hyundai / KIA"
                },
                "quantity": 1,
                "price": 270.64,
                "state": {
                    "id": 10,
                    "name": "Заказ создан"
                }
            }
        ]
    }
]

⚠️ Коды ошибок

Код	Описание
`ERR_SERVER`	Что-то пошло не так. Обратитесь к разработчикам.
`ERR_API_KEY_EMPTY`	Пустой ключ API
`ERR_API_KEY_INVALID`	Неверный ключ API
`ERR_API_VERSION_INVALID`	Неверная версия API
`ERR_SECURE_CONNECTION_EXPECTED`	Соединение должно быть защищенным (пожалуйста, проверьте, что запрос отправлен через HTTPS)
`ERR_IP_ADDRESS_FORBIDDEN`	Доступ с Вашего IP адреса запрещен
`WARN_ARTICLE_IS_AMBIGUOUS`	Пожалуйста, уточните бренд
`ERR_SEARCH_ITEMS_INVALID`	Неверные товары
`ERR_SEARCH_WAREHOUSE_TYPE_INVALID`	Неверный тип склада
`ERR_STATES_ORDERS_IDS_INVALID`	Неверные ID заказов
`ERR_VALIDATION`	Ошибка валидации параметров
`ERR_ORDER_FORM_INVALID`	Форма заказа была заполнена некорректно
`ERR_ORDER_EMPTY`	Невозможно отправить пустой заказ
`ERR_ORDER_SAVE`	Невозможно сохранить заказ
`ERR_CONTRACT_RESERVE`	Резервирование недоступно для этого договора
`ERR_ORDER_REFERENCE_RACE_CONDITION`	Данный заказ уже создается в данный момент
`ERR_ORDER_REFERENCE_NOT_UNIQUE`	Не уникальный ID заказа
`ERR_ORDER_ITEMS_RESOURCE_ID`	Неверный ID товара
`ERR_ORDER_ITEMS_RESOURCE_NOT_FOUND`	Товар не найден
`ERR_ORDER_ITEMS_WAREHOUSE_ID`	Неверный ID склада
`ERR_ORDER_ITEMS_WAREHOUSE_NOT_FOUND`	Нет товаров на данном складе
`ERR_ORDER_ITEMS_DELIVERY_TYPE`	Неверный тип доставки
`ERR_ORDER_ITEMS_DELIVERY_TYPE_NOT_FOUND`	Данный тип доставки не доступен для данного склада
`ERR_ORDER_ITEMS_QUANTITY`	Неверное количество товаров
`ERR_ORDER_ITEMS_MULTIPLICATION_FACTOR`	Количество должно быть кратно минимальному количеству для заказа
`ERR_ORDER_ITEMS_ZERO_REST_OR_PRICE`	Невозможно заказать товар с нулевой ценой
`ERR_ORDER_ITEMS_ZERO_DELIVERY_PRICE`	Невозможно заказать товар с нулевой доставкой
`ERR_ORDER_ITEMS_PRICE_EXPENSIVE`	Цена товара больше, чем указана в запросе
`ORDER_BY_END_OF_STOCK`	Позиция включена в заказ частично, по фактическому остатку
`ORDER_ITEMS_QUANTITY_LESS_STOCK`	Невозможно отправить заказ, остаток на складе меньше количества в заказе
`ORDER_GOODS_OUT_OF_STOCK`	Позиция не включена в заказ ввиду отсутствия на складе
`ORDER_ALL_GOODS_OUT_OF_STOCK`	Заказ не может быть создан - нет наличия
`DISPATCH_RUSH_DELIVERY_ADDRESS`	Данный адрес не доступен для данного типа отгрузки
`DISPATCH_RUSH_DELIVERY_DISABLED`	Срочная доставка не доступна
`DISPATCH_RUSH_DELIVERY_MIN_SUM`	Минимальная сумма заказа: %s Закажите еще на %s
`DISPATCH_TYPE_DISABLED`	Выбранный тип отгрузки не доступен
`DISPATCH_DELIVERY_DISABLED`	Доставка для данного договора не доступна
`WRONG_DISPATCH_TYPE`	Неверный тип отгрузки. Допустимые значения: 2 (самовывоз), 3 (доставка), 60580 (срочная доставка)
`PAYMENT_TYPE_DISABLED`	Указан недоступный тип оплаты
`ORDER_PAYMENT_TYPE_NOT_SPECIFIED`	Не выбран тип оплаты, доступный для договора
`ORDER_WRONG_PAYMENT_TYPE_NOT_ALLOWED`	Указан недоступный тип оплаты
`DELIVERY_ADDRESS_IS_EMPTY`	Требуется указать адрес доставки
`DELIVERY_ADDRESS_FOR_DISPATCH_SELF`	Передан адрес или id доставки при типе доставки самовывоз
`DELIVERY_ADDRESS_IS_INVALID`	Delivery address is invalid

Novantix API v1.0 v1.0

🔐 Типы авторизации

📡 Методы API

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

📊 Параметры

📫 Ответ

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

📊 Параметры

📫 Ответ

📋 Структура ответа

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

📊 Параметры

📫 Ответ

📋 Структура ответа

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

📊 Параметры

📫 Ответ

📋 Структура ответа

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

📊 Параметры

📫 Ответ

📋 Структура ответа

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

📊 Параметры

📫 Ответ

📋 Структура ответа

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

📊 Параметры

📫 Ответ

📋 Структура ответа

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

📊 Параметры

📫 Ответ

📋 Структура ответа

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

📊 Параметры

📫 Ответ

📋 Структура ответа

⚠️ Коды ошибок

📚 Документация в других форматах