{ "api": { "title": "Novantix API v1.0", "description": "API для работы с системой Novantix", "base_url": "https:\/\/api.novantix.ru\/", "version": "1.0" }, "endpoints": [ { "method": "GET", "path": "\/docs", "summary": "Просмотр документации API", "description": "Документация API", "auth_required": false, "url_example": "https:\/\/api.novantix.ru\/docs.json", "parameters": [ { "name": "format", "type": "string", "optional": true, "default": "html", "values": [ "html", "json", "xml" ], "description": "Формат возвращаемой документации" } ], "response": { "type": "html\/json\/xml", "description": "Документация API в запрошенном формате", "example": "Документация в запрошенном формате" } }, { "method": "GET", "path": "\/auth\/key", "summary": "Получить API ключ", "description": "Получение API ключа для доступа к защищенным эндпоинтам", "auth_required": "credentials", "url_example": "https:\/\/api.novantix.ru\/auth\/key.json?user=00002839&pass=********", "parameters": [ { "name": "user", "type": "string", "required": true, "example": "00002839", "description": "Имя пользователя (логин) для аутентификации" }, { "name": "pass", "type": "string", "required": true, "example": "********", "description": "Пароль пользователя" }, { "name": "format", "type": "string", "optional": true, "default": "json", "values": [ "json", "xml" ], "description": "Формат ответа" } ], "response": { "type": "json\/xml", "description": "Объект с API ключом и информацией о его действии", "fields": [ { "name": "key", "type": "string", "description": "Сгенерированный API ключ для доступа к защищенным эндпоинтам" }, { "name": "user", "type": "string", "description": "Имя пользователя, для которого выдан ключ" }, { "name": "expires_in", "type": "integer", "description": "Время жизни ключа в секундах (по умолчанию 90 дней)" } ], "example": { "key": "xxx", "user": "00002839", "expires_in": 7776000 } } }, { "method": "GET", "path": "\/references\/brands", "summary": "Справочник брендов", "description": "Получение справочника брендов автозапчастей", "auth_required": "key", "url_example": "https:\/\/api.novantix.ru\/references\/brands.json?key=xxx", "parameters": [ { "name": "key", "type": "string", "required": true, "description": "API ключ, полученный через \/auth\/key" }, { "name": "format", "type": "string", "optional": true, "default": "json", "values": [ "json", "xml" ], "description": "Формат ответа" } ], "response": { "type": "json\/xml", "description": "Массив брендов автозапчастей", "fields": [ { "name": "brands", "type": "array", "description": "Массив объектов брендов", "fields": [ { "name": "id", "type": "integer", "description": "Уникальный идентификатор бренда в системе Novantix" }, { "name": "name", "type": "string", "description": "Название бренда" } ] } ], "example": { "brands": [ { "id": 1, "name": "Bosch" }, { "id": 2, "name": "Mann" } ] } } }, { "method": "GET", "path": "\/ordering\/get_stock", "summary": "Поиск остатков по артикулу", "description": "Получение остатков и предложений по артикулу (поиск в базе Novantix). Поиск выполняется в два этапа: 1-й этап — базовый поиск по артикулу (ограниченное число поставщиков); 2-й этап — уточнённый поиск с указанием бренда (полный список поставщиков). Для получения максимально точных результатов рекомендуется передавать brand_id или brand_name. Этап поиска возвращается в поле search_stage каждого элемента ответа.", "auth_required": "key", "url_example": "https:\/\/api.novantix.ru\/ordering\/get_stock.json?items[0][resource_article]=2630035505&items[0][brand_name]=Hyundai&key=xxx", "parameters": [ { "name": "key", "type": "string", "required": true, "description": "API ключ, полученный через \/auth\/key" }, { "name": "items", "type": "array", "required": true, "description": "Массив запрашиваемых артикулов", "children": [ { "name": "items[N][resource_article]", "type": "string", "required": true, "description": "Артикул товара", "example": "2630035505" }, { "name": "items[N][brand_id]", "type": "string", "optional": true, "description": "ID бренда (из справочника \/references\/brands). При указании выполняется 2-й этап поиска с расширенным списком поставщиков", "example": "134" }, { "name": "items[N][brand_name]", "type": "string", "optional": true, "description": "Название бренда. При указании выполняется 2-й этап поиска с расширенным списком поставщиков. Можно использовать вместо brand_id", "example": "Hyundai" } ] }, { "name": "analogs", "type": "integer", "optional": true, "default": 0, "values": [ 0, 1 ], "description": "Возвращать ли аналоги (0 - только оригиналы, 1 - с аналогами)" } ], "response": { "type": "json", "description": "Результат поиска в формате Novantix API", "fields": [ { "name": "resources", "type": "array", "description": "Массив найденных товаров", "fields": [ { "name": "id", "type": "integer", "description": "ID товара для добавления в корзину" }, { "name": "name", "type": "string", "description": "Наименование товара" }, { "name": "article", "type": "string", "description": "Артикул товара" }, { "name": "brand", "type": "object|null", "description": "Объект бренда", "fields": [ { "name": "id", "type": "integer|null", "description": "ID бренда (null если не сопоставлен)" }, { "name": "name", "type": "string", "description": "Название бренда" } ] }, { "name": "offers", "type": "array", "description": "Массив предложений по товару", "fields": [ { "name": "price", "type": "float", "description": "Цена" }, { "name": "quantity", "type": "integer", "description": "Доступное количество" }, { "name": "reliability", "type": "integer", "description": "Надежность поставки (%)" }, { "name": "average_period", "type": "integer", "description": "Средний срок поставки (дни)" }, { "name": "warehouse", "type": "object", "description": "Склад", "fields": [ { "name": "id", "type": "integer", "description": "ID склада" }, { "name": "name", "type": "string", "description": "Название склада" } ] } ] }, { "name": "source_idx", "type": "integer", "description": "Индекс во входном массиве items" }, { "name": "search_stage", "type": "integer", "description": "Этап поиска: 1 — базовый поиск (бренд не указан или не найден в ответе, число поставщиков ограничено); 2 — уточнённый поиск по бренду (полный список поставщиков). Рекомендуется передавать brand_id или brand_name для получения результатов 2-го этапа" } ] }, { "name": "warnings", "type": "array", "description": "Массив предупреждений" } ], "example": { "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": [] } } }, { "method": "POST", "path": "\/ordering\/get_stock", "summary": "Поиск остатков по артикулу (POST)", "description": "Получение остатков по артикулу. Поддерживает передачу API ключа в JSON body. Поиск выполняется в два этапа: 1-й этап — базовый поиск по артикулу (ограниченное число поставщиков); 2-й этап — уточнённый поиск с указанием бренда (полный список поставщиков). Для получения максимально точных результатов рекомендуется передавать brand_id или brand_name.", "auth_required": "key", "url_example": "https:\/\/api.novantix.ru\/ordering\/get_stock.json (POST с JSON body)", "parameters": [ { "name": "key", "type": "string", "required": true, "description": "API ключ, полученный через \/auth\/key" }, { "name": "items", "type": "array", "required": true, "description": "Массив запрашиваемых артикулов", "children": [ { "name": "items[N][resource_article]", "type": "string", "required": true, "description": "Артикул товара", "example": "2630035505" }, { "name": "items[N][brand_id]", "type": "string", "optional": true, "description": "ID бренда (из справочника \/references\/brands). При указании выполняется 2-й этап поиска с расширенным списком поставщиков", "example": "134" }, { "name": "items[N][brand_name]", "type": "string", "optional": true, "description": "Название бренда. При указании выполняется 2-й этап поиска с расширенным списком поставщиков. Можно использовать вместо brand_id", "example": "Hyundai" } ] }, { "name": "analogs", "type": "integer", "optional": true, "default": 0, "values": [ 0, 1 ], "description": "Возвращать ли аналоги (0 - только оригиналы, 1 - с аналогами)" } ], "response": { "type": "json", "description": "Результат поиска в формате Novantix API", "fields": [ { "name": "resources", "type": "array", "description": "Массив найденных товаров", "fields": [ { "name": "id", "type": "integer", "description": "ID товара для добавления в корзину" }, { "name": "name", "type": "string", "description": "Наименование товара" }, { "name": "article", "type": "string", "description": "Артикул товара" }, { "name": "brand", "type": "object|null", "description": "Объект бренда", "fields": [ { "name": "id", "type": "integer|null", "description": "ID бренда (null если не сопоставлен)" }, { "name": "name", "type": "string", "description": "Название бренда" } ] }, { "name": "offers", "type": "array", "description": "Массив предложений по товару", "fields": [ { "name": "price", "type": "float", "description": "Цена" }, { "name": "quantity", "type": "integer", "description": "Доступное количество" }, { "name": "reliability", "type": "integer", "description": "Надежность поставки (%)" }, { "name": "average_period", "type": "integer", "description": "Средний срок поставки (дни)" }, { "name": "warehouse", "type": "object", "description": "Склад", "fields": [ { "name": "id", "type": "integer", "description": "ID склада" }, { "name": "name", "type": "string", "description": "Название склада" } ] } ] }, { "name": "source_idx", "type": "integer", "description": "Индекс во входном массиве items" }, { "name": "search_stage", "type": "integer", "description": "Этап поиска: 1 — базовый поиск (бренд не указан или не найден в ответе, число поставщиков ограничено); 2 — уточнённый поиск по бренду (полный список поставщиков). Рекомендуется передавать brand_id или brand_name для получения результатов 2-го этапа" } ] }, { "name": "warnings", "type": "array", "description": "Массив предупреждений" } ], "example": { "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": [] } } }, { "method": "GET", "path": "\/ordering\/add_to_cart", "summary": "Добавление товаров в корзину", "description": "Добавление товаров в корзину Novantix. Используйте item_id из результатов поиска.. Требуется API ключ для доступа", "auth_required": "key", "url_example": "https:\/\/api.novantix.ru\/ordering\/add_to_cart.json?key=xxx&items[0][item_id]=980139&items[0][count]=1", "parameters": [ { "name": "key", "type": "string", "required": true, "description": "API ключ" }, { "name": "items", "type": "array", "required": true, "description": "Массив товаров для добавления", "children": [ { "name": "items[N][item_id]", "type": "string", "required": true, "description": "ID товара из результатов поиска (поле id)", "example": "980139" }, { "name": "items[N][count]", "type": "integer", "optional": true, "default": 1, "description": "Количество", "example": 1 } ] } ], "response": { "type": "json", "description": "Результат добавления товаров", "fields": [ { "name": "success", "type": "boolean", "description": "Флаг успешности" }, { "name": "message", "type": "string", "description": "Описание результата" }, { "name": "results", "type": "array", "description": "Результаты для каждого товара" } ], "example": { "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 } } } ] } } }, { "method": "GET", "path": "\/references\/states", "summary": "Справочник статусов заказа", "description": "Возвращает справочник статусов заказа с идентификаторами, названиями и типами. Требуется API ключ для доступа.", "auth_required": "key", "url_example": "https:\/\/api.novantix.ru\/references\/states.json?key=xxx", "parameters": [ { "name": "key", "type": "string", "required": true, "example": "190f024bcb6d207f1fc227d8261f56b7f903b9938ce789d8cbd3da1d39ed6aca", "description": "API ключ для аутентификации" }, { "name": "format", "type": "string", "optional": true, "default": "json", "values": [ "json", "xml" ], "description": "Формат ответа" } ], "response": { "type": "json array", "description": "Массив объектов статусов заказа", "fields": [ { "name": "id", "type": "integer", "description": "Идентификатор статуса" }, { "name": "name", "type": "string", "description": "Наименование статуса" }, { "name": "type", "type": "integer", "description": "Тип статуса: 0 - обычный, 1 - при размещении заказа, 2 - при завершении обработки" } ], "example": [ { "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 } ] } }, { "method": "GET", "path": "\/ordering\/states\/active", "summary": "Список активных заказов", "description": "Возвращает список активных заказов и статусы по ним. Требуется API ключ для доступа.", "auth_required": "key", "url_example": "https:\/\/api.novantix.ru\/ordering\/states\/active.json?key=xxx", "parameters": [ { "name": "key", "type": "string", "required": true, "example": "190f024bcb6d207f1fc227d8261f56b7f903b9938ce789d8cbd3da1d39ed6aca", "description": "API ключ для аутентификации" }, { "name": "format", "type": "string", "optional": true, "default": "json", "values": [ "json", "xml" ], "description": "Формат ответа" } ], "response": { "type": "json array", "description": "Массив заказов (прямой массив)", "fields": [ { "name": "id", "type": "integer", "description": "Идентификатор заказа" }, { "name": "created_at", "type": "datetime", "description": "Дата и время создания заказа" }, { "name": "items", "type": "array", "description": "Массив позиций заказа с информацией о статусах" } ], "example": [ { "id": "191", "reference": "00000236", "items": [ { "sequence": 1, "resource": { "article": "2630035505", "brand": "!А", "name": "Hyundai \/ KIA" }, "quantity": 1, "price": 270.64, "state": { "id": 10, "name": "Заказ создан" } } ] } ] } }, { "method": "GET", "path": "\/ordering\/states", "summary": "Статусы заказов по идентификаторам", "description": "Возвращает статусы заказов по их идентификаторам. Требуется API ключ для доступа.", "auth_required": "key", "url_example": "https:\/\/api.novantix.ru\/ordering\/states.json?orders[]=123&orders[]=456&key=xxx", "parameters": [ { "name": "orders[]", "type": "array", "required": true, "example": [ "123", "456" ], "description": "Массив идентификаторов заказов" }, { "name": "key", "type": "string", "required": true, "example": "190f024bcb6d207f1fc227d8261f56b7f903b9938ce789d8cbd3da1d39ed6aca", "description": "API ключ для аутентификации" }, { "name": "format", "type": "string", "optional": true, "default": "json", "values": [ "json", "xml" ], "description": "Формат ответа" } ], "response": { "type": "json array", "description": "Массив заказов (прямой массив)", "fields": [ { "name": "id", "type": "integer", "description": "Идентификатор заказа" }, { "name": "created_at", "type": "datetime", "description": "Дата и время создания заказа" }, { "name": "items", "type": "array", "description": "Массив позиций заказа с информацией о статусах" } ], "example": [ { "id": "191", "reference": "00000236", "items": [ { "sequence": 1, "resource": { "article": "2630035505", "brand": "!А", "name": "Hyundai \/ KIA" }, "quantity": 1, "price": 270.64, "state": { "id": 10, "name": "Заказ создан" } } ] } ] } } ], "auth_types": { "none": "Без авторизации", "credentials": "Логин\/пароль", "key": "API ключ в параметре ?key=" }, "error_codes": { "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" } }