Официальный модуль Новая почта (редакции base и full)

Данная статья посвящена нашему официальным модулям "Новая почта" - это модули "Новая почта (base)" и "Новая почта (full)". В нашем магазине дополнений представлено (на момент написания документации) еще несколько аналогичных модулей наших партнеров. Порядок работы с ними может быть похожим, однако содержит ряд ключевых отличий.

Примечание:

Если вы используете любой другой модуль "Новая Почта" и у вас возникли ошибки или вопросы по использованию этого продукта, просим подать соответствующий запрос разработчику на прямую, через форму обратной связи на странице используемого вами модуля, в нашем магазине дополнений:


Модуль предназначен для подвязки и последующего использования способа доставки через сервис "Новая Почта".

1 Покупка модуля

Модуль "Новая Почта" не входит в сборку по умолчанию и, в момент написания статьи, является платным. Приобрести модуль можно на странице модуля в маркетплейсе или связавшись с вашим менеджером. Стоимость модуля, в момент написания статьи, составляет от 30$ до 50$ (в зависимости от выбранной версии модуля).

При условии покупки модуля, мы предлагаем бесплатную установку модуля на ваш магазин. Если же вы приобретали модуль не через менеджера, а через магазин дополнений, просим связаться с менеджером и обсудить с ним данный момент.

Внимание!
Модуль гарантировано поддерживается системой от версии 4.12 и выше.

Для использования модуля необходимо предварительно создать отдельный способ доставки и подключить уникальный Account key, который можно получить на сайте Новой Почты.

Подробнее о создании способа доставки.

К началу

1.1. Установка модуля

Рекомендуем заказать установку модуля нашим специалистам - эта услуга является бесплатной. Для этого свяжитесь с вашим менеджером. Однако, если вы желаете самостоятельно установить модуль, руководствуйтесь следующей инструкцией:

Шаг 1: Скачайте архив модуля из вашего личного кабинета на imagecms.net, в разделе "Мои дополнения":


Внимание!
Перед установкой модуля обязательно создайте полный бекап сайта и базы данных.

Шаг 2: Распакуйте содержимую в архиве папку nova_poshta посредством FTP-клиента на сервер, в директорию \application\modules


Примечание:
После загрузки папки модуля на сервер, проставьте права на папку модуля 755 рекурсивно - на все вложенные файлы и папки

Шаг 3: Перейдите в админ-профиль к списку модулей:

Осуществите переход в админ-профиле "Модули" → "Все модули" → вкладка "Установить модули":

Шаг 4: Клик по ссылке "Установить"

В открывшемся списке модулей должен отображаться модуль "Новая почта". Необходимо осуществить клик по ссылке "Установка" напротив данного модуля:

После этого начнется автоматический процесс установки, во время которого модуль автоматически пропишет новые таблицы в базе данных и поля в админ-профиле.

Шаг 5: После завершения установки - очистите кеш из админ панели

К началу

1.2. Модуль в админ-профиле

Изначально, модуль находится в списке модулей: "Модули" - "Все модули" - "Новая почта":


Что бы открыть доступ к модулю через выпадающий под-пункт главного меню "Модули", передвиньте в активное положение ползунок в колонке "Показывать в меню".

После этого модуль будет доступен по более короткому пути: "Модули" - "Новая почта".

К началу

1.3. Модуль на сервере

Все файлы модуля физически находятся на сервере в папке nova_poshta, которая должна находится в директории \application\modules:

В корневой папке модуля находится файл README.md, с содержание которого мы рекомендуем ознакомится, если вы планируете самостоятельно осуществлять работы по модулю.

К началу

1.4. Новая почта (base) в базе данных

При установке создается строка nova_poshta в таблице components, но никаких относящихся к работе модуля данных, строка не содержит.

Больше таблиц не создается

1.5. Новая почта (full) в базе данных

При установке, модуль Новая Почта (full) создает таблицу в базе данных mod_nova_poshta, которая содержит следующие колонки:

  • id
  • order_id
  • order_ref
  • order_number
  • data

А также создается строка в таблице components, но никаких, относящихся к работе модуля данных, строка не содержит.

К началу

1.6. Гарантии разработчиков

Пользователям ImageCMS, которые приобрели модуль "Новая почта (base)", мы, как разработчики данного продукта, предоставляем гарантию на данный функционал сроком на месяц в следующем порядке:

  • При приобретении модуля через менеджера и установке модуля нашими специалистами - гарантия предоставляется на 30 дней с момента завершения интеграции и принятия клиентом работ.
  • При приобретении модуля через маркетплейс и самостоятельной установке - гарантия предоставляется на 30 дней с момента покупки модуля.
Внимание!

Гарантия не распространяется и не покрывает следующего:

  • Исправления ошибок, допущенных администратором при самостоятельной установке и администрировании модуля.
  • Проблем и ошибок в работе модуля, которые возникли из-за правки модуля сторонними специалистами.
  • Проблем, возникающих из-за несоответствия хостинга требованиям системы.
  • Исправление ошибок и конфликтов, которые вызваны:
    • Сторонними сервисами и дополнениями, установленными на сайте.
    • Индивидуальными доработками стандартного функционала и/или шаблона

Гарантия предоставляется только на наши официальные модули Новая почта (base) и (full); на аналогичные модули наших партнеров гарантия нами не предоставляется

В случае обнаружения ошибки, исправление которой не описано в данном документе, просим создать отдельное обращение в службу тех поддержки, при этом четко описав проблему и предоставить пошаговую инструкцию для воссоздания проблемы.

К началу

2. Настройки и работа с модулем Новая почта (base)

Прежде всего, администратору необходимо создать отдельный способ доставки и, соответственно, способы оплаты, к которому будет привязан модуль "Новая Почта".

Подробнее о создании способа доставки - в статье документации "Способы доставки".

Следующий шаг настройки - это подключение Account key. Для этого следует:

Шаг 1: Перейдите к настройкам модуля

Для этого осуществите клик по названию модуля в общем списке или в меню "Модули"

Шаг 2: Клик по ссылке "Получить"

В форме настроек модуля осуществите клик по ссылке "Получить", в строке "Получить Account key".

Далее будет осуществлен переход на сайт "Новой Почты", на котором будет необходимо зарегистрироваться и заполнить форму, необходимую для получения Account key:

Если на этом этапе у вас возникнут сложности, просим обратиться в поддержку "Новой Почты" или позвонить на горячую линию данного сервиса.

Шаг 3: Полученный Account key вставить в поле "Ключ учетной записи", в настройках модуля:

Уникальный ключ (на момент написания статьи, ключ содержит 33 знака (цифр и строчных латинских символов - например, blbyy3yx6814b7x8ihbxxqtb07s67i717 ) - именно этот код необходимо прописать в поле "Ключ учетной записи":

Шаг 4: Выберите связанный способ оплаты:

В поле "Способы доставки" выберите предварительно созданный способ доставки , который будет задействован для сервиса "Новая Почта".

Внимание!
На момент подключения способа доставки к модулю, способ доставки должен быть создан и к нему уже должны быть подвязаны способы оплаты.

Модуль "Новая почта" может использовать только один способ доставки.

Шаг 5: Сохраните настройки и очистите кеш из админ панели


К началу

3. Настройки и работа с модулем Новая почта (full)

Так как модуль "Новая почта (full)" содержит полный функционал, настройки и работа с модулем несколько сложнее и подразумевает следующие возможности:

  • Подробной настройки функционала в разделе "Настройки";
  • Создание и настройку экспресс накладной
  • Сортировку и редактирование заказов, осуществленных с выбором данного способа доставки, в списке заказов

3.1 Настройка модуля Новая почта (full)

Для перехода к настройкам модуля, откройте главную страницу модуля, осуществив переход в админ профиле, по аналогии с Новая почта (base), и осуществите клик по кнопке "Настройки":

После клика, откроется форма настроек, содержит поля, содержимое которых необходимо для работы функционала, со стороны самой Новой почты. Данная форма разделенная на две части:

Часть "Настройки" - содержит поля настроек основных данных пользователя, и содержит поля

  • Ключ учетной записи - поле, в котором следует указать уникальный идентификатор сайта. Ключ можно получить после регистрации на сайте Новой Почты. Поле обязательно для корректной работы модуля.
  • Способ доставки - поле, в котором следует подвязать способ доставки, предварительно созданный в системе, который будет использоваться для модуля (Например "Новая Почта"). Подробнее о создании способов доставки.
  • Контрагент - поле, в котором нужно указать данные о контрагенте, созданном в личном кабинете Новой Почты. Возможные значения физическое или юридическое лицо.
  • Отправитель - поле, в котором нужно указать ФИО (если пользователь зарегистрирован на сайте Новой Почты как физическое лицо) или другие данные контрагента, созданном в личном кабинете Новой Почты.
  • Город - поле, в котором нужно указать город контрагента (город отправителя по умолчанию), из настроек в личном кабинете Новой Почты.
  • Склад - поле, в котором нужно указать отделение контрагента по умолчанию (адрес склада, или отделения Новой Почты отправителя по умолчанию).
  • Плательщик - поле, в котором нужно указать данные о плательщике, из настроек в личном кабинете Новой Почты. Возможные значения:
    • Отправитель
    • Получатель
    • Третье лицо
  • Метод оплаты - поле, в котором нужно указать данные о способе осуществления оплаты, из настроек в личном кабинете Новой Почты. Возможные значения:
    • Наличными
    • Безналичный



Часть "Груз"
- содержит поля настроек основных параметров товаров, которые учитываются при доставке. Это поля:

  • Свойство "Вес" - поле, в котором необходимо указать свойство товара, созданное в системе и обозначающее вес товара в килограммах. Свойство должно быть предварительно создано, а его значение должно быть присвоено товарам.
  • Вес (По умолчанию) - поле, в котором можно указать значение веса товара по умолчанию. Данное значение будет применено к товарам, с отсутствующим параметром соответствующего отдельного свойства, указанного в поле "Свойство "Вес""
  • Свойство "Объем" - поле, в котором необходимо указать свойство товара, созданное в системе и обозначающее объем товара в метрах кубических.Свойство должно быть предварительно создано, а его значение должно быть присвоено товарам.
  • Объем (По умолчанию) - поле, в котором можно указать значение объема товара по умолчанию. Данное значение будет применено к товарам, с отсутствующим параметром соответствующего отдельного свойства, указанного в поле "Свойство "Объем"".
  • Количество мест - поле, в котором следует указать количество мест, которое занимает товар при отправке.

Примечание:

Просим учесть, что в данном разделе содержатся настройки необходимые для работы модуля, но они не импортируются в ваш личный кабинет на сайте Новой почты. Так же, нет возможности обмена настройками в обратную сторону - с Новой почты в модуль.

По этому, настройки необходимо осуществлять отдельно, и при этом, они должны соответствовать.

Если в процессе настроек у вас возникли трудности - просим поискать необходимую информацию в документации Новой почты.

К началу

3.2 Создание ЭН (экспресс накладной)

Модуль Новая почта (full) предусматривает создание экспресс накладной прямо из админ профиля. После чего данные будут импортированы в личный кабинет Новой почты. Для создания экспресс накладной, заказ должен быть оформлен покупателем и отображаться в списке заказов. Для создание накладной через админ профиль, нужно:

Шаг 1: Клик по кнопке "Создать ЭН"

В списке заказов в модуле, в колонке "Номер", в строке каждого заказа находится кнопка "Создать ЭН" - кликните по кнопке, в строке интересующего вас заказа:

Внимание:

Если заказ не требует никаких правок - перейдите к шагу №8.

Если для Оформления экспресс накладной необходимы правки - следуйте последующим шагам последовательно или выборочно, в зависимости от обстоятельств.

Шаг 2: Отредактируйте данные об отправителе

Данные о контрагенте и контактное лицо, для конкретной накладной, можно отредактировать в блоке "Отправитель", при помощи полей "Контрагент" и "Контактное лицо".

Примечание:
В данной форме нет возможности создать контрагента или контактное лицо - эти настройки должны быть осуществлены предварительно в личном кабинете Новой Почты.

Шаг 3: Отредактируйте данные о получателе

Данные о получателе и его контактных данных, заполняется самим покупателем при оформлении заказа. В случае, если указанных данных недостаточно, администратор имеет возможность дозаполнить необходимые данные в блоке Получатель.

Примечание:
Обратите внимание на значение ячейки "Создать" если значение:
  • Выбрано - открывается форма создания нового контрагента
  • Не выбрано - открывается выпадающий список, уже предварительно созданных в кабинете Новой пошты, контрагентов.

Шаг 4: Отредактируйте данные о пункте отправления

В случае необходимости, вы можете отредактировать данные о пункте отправления посылки в блоке "Адрес отправителя". В данном блоке, вы можете изменить город и отделение отправки.

Шаг 5: Отредактируйте данные о пункте отправления

В случае необходимости, вы можете отредактировать данные о пункте получения покупателем посылки в блоке "Адрес получателя". В данном блоке, вы можете изменить город и отделение отправки.

Примечание:
Данные о городах и отделениях, подтягиваются из данных сервиса "Новая Почта" и поддерживаются в актуальном состоянии самим сервисом.

Шаг 6: Отредактируйте данные об отправляемом товаре

В блоке "Настройки", отредактируйте основные сведенья о характеристиках товара (вес, объем, количество мест) а также другие параметры заказа (описание, плательщик, метод оплаты). Подробнее - в пункте 3.1 Настройка модуля Новая почта (full).

Шаг 7: Отредактируйте дату отправки товара

В блоке "Дата", отредактируйте дату отпраления товара, выбрав необходимую из календаря.

Примечание:
Возможности указать дану "задним числом" - нет. Доступна настройка даты только от текущего дня

Шаг 8: Создайте экспресс накладную, при помощи кнопки "Создать"

Примечание:
При создании экспресс накладной, очень часто могут возникать разного рода ошибки, связанные с корректронстью заполнения полей формы. В таком случае просим поискать необходимую информацию в документации Новой почты.

После того, как экспресс накладная будет создана, ей будет присвоен уникальный номер. В последующем, в списке заказов модуля, заказ с сформированной экспресс накладной будет отображатся примерно следующим образом:

Так же, после создания накладной, в форме редактирования появляется несколько дополнительных функциональных элементов, в правом верхнем углу:
Это элементы:

  • Кнопка "Редактировать" (стандартная) - стандартная кнопка системы. Позволяет перейти к форме редактирования экспресс накладной.
  • Кнопка "Распечатать" - содержит выпадающий список пунктов, позволяющих сгенерировать, скачать и распечатать маркировку или саму накладную:
    • ЭН (html) - пункт, который позволяет открыть экспресс накладную в html формате
    • ЭН (pdf)- пункт, который позволяет открыть экспресс накладную в формате pdf

    • Маркировка (html) - пункт, который позволяет открыть маркировки посылки, в html формате
    • Маркировка (pdf) - пункт, который позволяет открыть маркировки посылки, в формате pdf

  • Кнопка "Редактировать" (модуля Новая почта (full)) - содержит выпадающий список пунктов, и позволяет быстро перейти к редактированию:
    • Редактировать в "НОВА ПОШТА" - к редактированию экспресс накладной на сайте "Новой Почты"
    • Редактировать заказ - к редактированию заказа, в вашем магазине
Примечание:
Генерация страниц, при выборе почти всех выше указанных пунктов, происходит на сайте "Новой Почты". Если у вас возникли трудности с генерацией накладной или маркировки - просим обратиться в службу поддержки "Новой Почты"

К началу

3.3 Работа со списком заказов в модуле Новая почта (full)

Список заказов модуля Новая почта (full), разбит на колонки, которые позволяют осуществлять поиск заказов и фильтровать их. Это колонки:

  • ID - колонка, которая содержит уникальный идентификатор заказа в системе (то же значение, что и в аналогичной колонке списка заказов). Позволяет осуществлять поиск заказа по номеру ID заказа в системе.
  • Номер - колонка, которая содержит код экспресс накладной (если накладная уже создана для заказа) или кнопку "Создать ЭН" (если накладная для конкретного заказа еще не создана). Позволяет осуществлять поиск заказа по коду накладной.
  • Пользователь - колонка, которая сожержит имя покупателя, которые были указаны при оформлении заказа. Позволяет осуществлять поиск пользователя или заказов, по Ф.И.О.
  • Email - колонка, которая сожержит емейл покупателя, который был указан при оформлении заказа. Позволяет осуществлять поиск пользователя или заказов по адресу электронной почты.
  • Телефон - колонка, которая сожержит номер контактного телефона покупателя, который был указан при оформлении заказа. Позволяет осуществлять поиск пользователя или заказов по номеру телефона.
  • Дата - колонка, которая содержит дату и время осуществления заказа. Позволяет производить фильтр заказов по временному диапазону осуществления заказа, при помощи полей в заголовке столбца "от" и "до" (от даты до даты).
  • Цена - колонка, которая содержит суммарную стоимость покупки. Позволяет производить фильтр заказов по стоимости.
  • Статус - Позволяет производить фильтр заказов по статусу обработки заказа. Подробнее о статусах заказов

К началу

4. Вывод модуля в ранних версиях шаблонов: Unishop, Megashop, Multishop, Good Look, Sport Line, Unishop Vertical (до версии 1.5)

В новых шаблонах, от версии 1.5, вывод модуля поддерживается по умолчанию и никаких дополнительных работ по выводу модуля в шаблоне не требуется.

Однако, если вы используете один из ранних шаблонов, которые по умолчанию не поддерживают вывод модуля "Новая почта", или же один из новых шаблонов версии до 1.5, то для отображения модуля вам необходимо:

В файле cart_delivery_radio.tpl, в папке \templates\multishop\shop\includes\cart, примерно на 47-й строке, после кода <div class="delivery-radio__spoiler hidden" data-cart-delivery--spoiler> необходимо вставить:

          <!-- Nova Poshta module -->
          {if array_key_exists('nova_poshta', $modules)}
            {if module('nova_poshta')->getSelectDeliveryId() == $delivery->getId()}
              {view('nova_poshta/nova_poshta.tpl')}
            {/if}
          {/if}

После правки - очистите кеш.

Внимание!
Указанный способ вывода работает только для новых шаблонов версии до 1.5.

Если указанный способ вывода не решил проблему, рекомендуем обратиться к вашему менеджеру и заказать вывод модуля в качестве дополнительных работ, так как:

  • В этих шаблонах вывод модуля не предусмотрен изначально.
  • Структура файлов в шаблонах (особенно в шаблонах для ранних версий системы) может отличаться, следовательно - указанный способ вывода не подойдет.

Обязательно сохраните копии файлов перед внесением правок, что бы была возможность восстановить работоспособность магазина в случае ошибки.

К началу

5. Частые вопросы

После загрузки папки в директорию \application\modules, модуль не отображается в списке.

  • Попробуйте очистить кеш из админ панели и обновить список модулей, доступных для установки
  • Проверьте права на папку модуля - права должны быть 755 (или, в редких случаях - 777 - полный доступ) рекурсивно - на все вложенные файлы и папки.

К началу

Ошибка: ClassNotFoundException in ApiNovaPoshta.php line 44: Attempted to load class "Config" from namespace "NovaPoshta"....in..../public_html/application/modules/nova_poshta/classes/ApiNovaPoshta.php line 44.

Прежде всего - отключите автозагрузку модуля в списке модулей

Если это решение не поможет - перелейте модуль повторно, через ФТП, в двоичном режиме передачи и очистите кеш

Auth Key

API Search

API Console