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

1. 1 Купівля модуля
2. 1.1. установка модуля
3. 1.2. Модуль в адмін-профілі
4. 1.3. Модуль на сервері
5. 1.4. Нова пошта (base) в базі даних
6. 1.5. Нова пошта (full) в базі даних
7. 1.6. гарантії розробників
8. 2. Налаштування та робота з модулем Нова пошта (base)
9. 3. Налаштування і робота з модулем Нова пошта (full)
10. 3.1 Налаштування модуля Нова пошта (full)
11. 3.2 Створення ЕН (експрес накладної)
12. 3.3 Робота зі списком замовлень в модулі Нова пошта (full)
13. 4. Висновок модуля в ранніх версіях шаблонів: Unishop, Megashop, Multishop, Good Look, Sport Line, Unishop Vertical (до версії 1.5)
14. 5. Часті питання
15. Помилка: ClassNotFoundException in ApiNovaPoshta.php line 44: Attempted to load class "Config" from...

Дана стаття присвячена нашому офіційним модулів "Нова пошта" - це модулі "Нова пошта (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> необхідно вставити:

{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