VibeFox LP Express for OpenCart — Помощь

Требования

OpenCart: 3.0.x (проверено на 3.0.5.0) или 4.0.2 и новее (проверено на 4.1.0.3), со стандартной темой и стандартным оформлением заказа OpenCart.

PHP: 8.0 или новее.

LP Express: учётная запись API не нужна. У LP Express нет публичного API тарифов, а расширение не использует API Unisend, поэтому вы вводите собственные (договорные) тарифы. Создавайте отправления в своём аккаунте Unisend («Mano siuntos»).

Список почтовых терминалов: расширение использует открытый список терминалов LP Express (https://www.lpexpress.lt/index.php?cl=terminals&fnc=getTerminals). Ключ не нужен. Если этот онлайн-список недоступен, расширение использует последнюю загруженную копию, если она есть, а иначе ваш собственный список. Будьте готовы ввести собственный список (см. Настройка).

Литва: страна должна быть включена в разделе System > Localisation > Countries.

Лицензионный ключ VibeFox: приобретается на vibefox.net. Один ключ работает на одном домене.

Установка

Загрузка — один zip-файл с пакетами для обеих версий OpenCart. Распакуйте его на своём компьютере. Он содержит README.txt, пакет для OpenCart 3 vfd_lp_express-oc3-(version).ocmod.zip и пакет для OpenCart 4 vfd_lp_express.ocmod.zip. Устанавливайте только пакет для своей версии OpenCart. Лицензионный ключ одинаковый для обеих версий.

OpenCart 3

1. В админ-панели перейдите в Extensions > Installer, нажмите Upload и выберите файл vfd_lp_express-oc3-(version).ocmod.zip. Расширение не добавляет модификаций OCMOD, поэтому обновлять Extensions > Modifications не нужно. Вместо установщика можно скопировать содержимое папки upload из этого пакета в корневую папку вашего магазина.

2. Перейдите в Extensions > Extensions и выберите тип расширений Shipping. Найдите VibeFox LP Express и нажмите Install (зелёная кнопка +).

3. Нажмите Edit (кнопка с карандашом), чтобы открыть страницу настроек.

4. Введите лицензионный ключ VibeFox в поле License key в блоке лицензии вверху страницы Edit и нажмите Activate (см. Лицензионный ключ).

5. Заполните таблицу тарифов (хотя бы одну строку; первая новая строка — Литва) или укажите резервную стоимость. Проверьте строку статуса о почтовых терминалах в верхней части страницы и добавьте собственный список терминалов, если онлайн-список недоступен. Включите Enable/Disable и нажмите Save.

OpenCart 4

1. В админ-панели перейдите в Extensions > Installer, нажмите Upload и выберите файл vfd_lp_express.ocmod.zip. Не переименовывайте файл: OpenCart 4 берёт код расширения из имени файла, и переименованный пакет не работает.

2. Пакет появится в списке установленных расширений на той же странице. Нажмите рядом с ним Install (зелёная кнопка +).

3. Перейдите в Extensions > Extensions и выберите тип расширений Shipping. Найдите VibeFox LP Express, нажмите Install (зелёная кнопка +), затем Edit (кнопка с карандашом).

4. Введите лицензионный ключ и настройки так же, как в шагах 4 и 5 для OpenCart 3. Страница настроек и её поля одинаковы в обеих версиях.

При установке расширение создаёт две небольшие таблицы (выбранные терминалы и кэш списка терминалов) и регистрирует свои события OpenCart для оформления заказа и страницы заказа. Способ доставки выключен, пока вы не включите Enable/Disable и не сохраните настройки. Если вы устанавливаете расширение заново после удаления, используются сохранённые настройки.

Настройка

Все настройки находятся на странице расширения: Extensions > Extensions > Shipping > VibeFox LP Express > Edit. Разделы перечислены слева. Одна кнопка Save внизу сохраняет всю страницу без перезагрузки. Каждое сохранение также перезагружает список терминалов. Сохранять настройки могут только администраторы с правом изменения для этого расширения.

В верхней части страницы уведомления показывают проблемы и статус терминалов. Предупреждение появляется, когда не задана ни одна цена или нет доступных почтовых терминалов, так как тогда способ доставки не показывается при оформлении заказа, а также когда в магазине нет весового класса с единицей kg: тогда веса товаров определяются по названию их единицы (kg, g, lb, oz), а любая другая единица считается килограммами. Информационная строка показывает, сколько почтовых терминалов в скольких городах доступно и из какого источника: онлайн-списка, сохранённой копии онлайн-списка (с датой) или вашего собственного списка.

При сохранении название способа доставки, которое пусто или содержит один из символов < > ; = # { }, отклоняется с сообщением Enter a valid method title.; название длиннее 64 символов тоже отклоняется. Порядок сортировки, который не является целым числом, также отклоняется. В этих случаях ничего не сохраняется. Сумма или вес, которые не являются числом (или отрицательны), отмечаются, и сохраняется их прежнее значение. Значение Minimum weight (kg) больше Maximum weight (kg) (30 кг, если максимум пуст) тоже отмечается, так как способ доставки никогда не показывался бы; оба веса сохраняют прежние значения. Цены в таблице, которые не являются числами, отмечаются и остаются пустыми. Остальные значения сохраняются.

Общие

Enable/Disable: показывает или скрывает LP Express при оформлении заказа (статус этого расширения). По умолчанию: off.

Method title: название способа доставки, которое покупатели видят в корзине и при оформлении заказа. По умолчанию: LP Express parcel terminal. Обязательное поле, не более 64 символов.

Tax class: --- None --- (по умолчанию) означает, что приведённые ниже цены окончательные. С классом налога OpenCart добавляет налог на доставку к ценам ниже.

Sort order: место LP Express среди способов доставки при оформлении заказа. Целое число.

Цены (в валюте по умолчанию вашего магазина, которая указана в заголовке раздела; десятичные числа можно записывать как 2.99 или 2,99)

Price table: одна строка на страну назначения. Нажмите Add country, чтобы добавить строку, и кнопку удаления, чтобы убрать строку. Выберите * Any other country для всех стран без собственной строки. В каждой строке есть Base price и весовые колонки: XS до 1 кг, S до 2 кг, M до 3 кг, L до 5 кг и XL свыше 5 кг. Вес — это вес корзины или, при Per item, вес одного товара. Пустая колонка использует базовую цену строки. 0 означает бесплатно. Строка без цены не сохраняется.

Fallback cost: используется, когда в таблице тарифов нет строки (или цены) для страны назначения. Оставьте поле пустым, чтобы скрыть способ доставки для таких стран.

Calculation: как рассчитывается цена.

Per order (tier by total cart weight): одна цена на корзину: весовая колонка выбирается по общему весу корзины. Это вариант по умолчанию.

Per item (each item priced by its own weight x quantity): каждый товар оценивается по собственному весу, умноженному на количество, а затем цены суммируются.

Free shipping from: сумма корзины (товары, требующие доставки, после скидок, без налога), начиная с которой LP Express бесплатен. Условие применяется до таблицы тарифов, поэтому распространяется и на страны без собственной строки. Оставьте поле пустым, если бесплатной доставки нет.

Доступность

Minimum weight (kg): скрывает способ доставки, когда корзина легче этого значения. Пусто или 0 означает без ограничения.

Maximum weight (kg): скрывает способ доставки, когда корзина тяжелее этого значения. Терминалы LP Express принимают посылки до 30 кг. По умолчанию: 30. 0 означает без ограничения. Пусто означает 30 кг или отсутствие ограничения, если включён Ignore shipping zones.

Minimum cart total: показывает способ доставки только от этой суммы корзины (товары, требующие доставки, после скидок, без налога). Оставьте поле пустым, чтобы показывать способ всегда.

Geo zone: способ доставки предлагается только для адресов в этой геозоне. All Zones (по умолчанию) означает везде. Геозоны управляются в разделе System > Localisation > Geo Zones. Геозона не проверяется, когда включён Ignore shipping zones.

Ignore shipping zones: предлагает LP Express для стран, указанных ниже, независимо от геозоны. В этом режиме геозона не проверяется. Когда он выключен, страны определяются геозоной. Рекомендуется. По умолчанию: off.

Countries (without zones): страны назначения для этого режима. Это поле используется только когда включён Ignore shipping zones. Оставьте его пустым, чтобы предлагать способ во всех странах.

Почтовые терминалы

Terminal list: откуда берутся терминалы.

LP Express online list: онлайн-список загружается раз в сутки. Если его не удаётся загрузить, используется последняя загруженная копия, а затем ваш собственный список ниже. Это вариант по умолчанию.

Only my own list: предлагаются только терминалы, которые вы введёте ниже.

Дополнительно

Debug log: записывает подробности расчёта цен и списка терминалов в файл storage/logs/vfd_lpex_debug.log.php (в OpenCart 4 — system/storage/logs/vfd_lpex_debug.log.php). Файл нельзя прочитать из веба. Ошибки, например недоступный список терминалов или заказ без терминала, записываются всегда. Данные покупателей не записываются. Когда файл достигает 5 МБ, начинается новый журнал.

Log: показывает размер и последние записи журнала. Нажмите Clear log, чтобы очистить его.

Remove data on uninstall: когда включено, при удалении расширения удаляются настройки, сохранённый список терминалов, журнал и терминалы незавершённых оформлений заказа. Когда выключено (по умолчанию), настройки сохраняются для повторной установки. Терминал, сохранённый в заказах, всегда остаётся.

Импорт / Экспорт

Export: нажмите Download JSON, чтобы сохранить настройки в файл JSON.

Import: вставьте ранее экспортированный JSON и нажмите Import, чтобы восстановить настройки, например в другом магазине. Значения проверяются так же, как при обычном сохранении.

Как это работает при оформлении заказа

Когда OpenCart показывает способы доставки, он запрашивает у расширения цену LP Express. Если задана Geo zone и адрес находится вне её, LP Express не предлагается. При Ignore shipping zones геозона не проверяется: LP Express предлагается только для перечисленных стран (для всех стран, если список пуст). Учитываются только товары, у которых Requires Shipping установлено в Yes: другие товары не добавляют вес и не входят в сумму корзины. Сумма корзины — это цена таких товаров после скидки по купону и до налога. Подарочные сертификаты, бонусные баллы и кредит магазина не учитываются.

Расширение проверяет вес корзины и минимальную сумму корзины. Если применяется бесплатная доставка, цена равна 0. В остальных случаях цена берётся из строки страны (или строки *): весовая колонка, иначе базовая цена, иначе резервная стоимость. Если цены нет или нет доступного почтового терминала, способ доставки скрывается, чтобы покупатель никогда не увидел оформление, которое нельзя завершить.

Цены и суммы указываются в валюте по умолчанию вашего магазина. Цена округляется до своих десятичных знаков и показывается покупателю в его валюте с налогом выбранного Tax class.

Онлайн-список терминалов кэшируется на 24 часа. Неудачная загрузка запоминается на 15 минут, чтобы оформление заказа не ждало список при каждом обновлении. Время ожидания загрузки — 10 секунд. Предлагаются только активные терминалы из списка. Терминалы без города показываются в группе Other.

На OpenCart 4 покупатель нажимает Choose в блоке способа доставки на странице оформления заказа и выбирает LP Express в окне Shipping method options. Цены такие же, как в OpenCart 3.

Расширение не запрашивает тарифы LP Express или Unisend, не создаёт отправления, не печатает этикетки, не вызывает курьера и не отслеживает посылки. Создавайте отправления в своём аккаунте Unisend («Mano siuntos»). Курьерская доставка до двери не входит в этот способ.

Пункты выдачи

Когда покупатель выбирает LP Express на шаге способа доставки, под ним появляется блок LP Express parcel terminal с двумя списками: -- Select city -- и -- Select parcel terminal --. Список терминалов загружается только при выборе LP Express. Город из адреса доставки выбирается автоматически, если он совпадает с городом из списка. Каждый терминал показывается с названием, адресом и почтовым индексом. Выбор сразу сохраняется для оформления заказа, поэтому он не теряется при обновлении страницы оформления.

Терминал обязателен. Когда покупатель нажимает Continue, сервер проверяет терминал по списку ещё раз. Без терминала оформление показывает Please select an LP Express parcel terminal. Поддельный или устаревший ID терминала отклоняется сообщением The selected LP Express parcel terminal is not available any more. Please select a parcel terminal again. Если терминалы загрузить невозможно, покупатель видит The LP Express parcel terminal list is temporarily unavailable. Please try again later or choose another shipping method.

На OpenCart 4 блок LP Express parcel terminal с двумя списками появляется в окне Shipping method options под опцией LP Express, когда покупатель её выбирает. Кнопка Continue в этом окне не переходит дальше без действительного терминала, с теми же сообщениями.

ID терминала, название и город сохраняются с заказом. Блок LP Express parcel terminal на странице заказа в админ-панели (Sales > Orders, информация о заказе) показывает город, терминал и его Terminal ID. Способ доставки заказа показывает название способа, двоеточие, город и терминал (например, LP Express parcel terminal: Kaunas, …), поэтому он виден в деталях заказа покупателя, в письмах о заказе и в счёте. Если у заказа нет терминала, страница заказа в админ-панели показывает No parcel terminal was chosen for this order. Блок также показывается для оформленных заказов, пока расширение отключено. В OpenCart 4 он показывается над History. OpenCart 4 хранит один заказ для оформления и обновляет его каждый раз, когда покупатель подтверждает заказ снова, а терминал заказа обновляется вместе с ним. Если покупатель переключает этот заказ на другой способ доставки, его терминал удаляется.

Лицензионный ключ

Расширение работает с лицензионным ключом VibeFox с vibefox.net. Блок License — VibeFox LP Express — первый блок на странице Extensions > Extensions > Shipping > VibeFox LP Express > Edit, над настройками. Вставьте ключ в поле License key и нажмите Activate. После этого блок показывает ключ в маскированном виде, статус (например, дату, до которой лицензия действует, и ваш домен) и кнопки Check now, чтобы проверить статус снова, Change key, чтобы ввести другой ключ, и Remove key, чтобы удалить ключ из этого магазина. Ниже находятся строка Product: opencart-shipping-lp-express и ссылка Manage licenses and domains in your account, которая открывает ваш аккаунт на vibefox.net. Изменять ключ могут только администраторы с правом Modify для этого расширения. Тексты блока соответствуют языку админ-панели (включены английский и русский).

Если ключ не принят, блок сообщает причину, например Key not found, This key belongs to another product, Domain limit reached или License expired on с датой. После смены адреса магазина или после освобождения слота домена в вашем аккаунте нажмите Check now. Если сервер лицензий недоступен, расширение продолжает работать по последнему известному статусу.

Один ключ работает на одном домене: адрес магазина из настроек OpenCart. Удаление ключа из магазина не освобождает слот домена. Освободите слот в своём аккаунте на vibefox.net.

Без действующего ключа способ доставки LP Express не показывается покупателям при оформлении заказа, и тариф не рассчитывается. Администратор, вошедший в админ-панель в том же браузере, всё ещё видит способ доставки в магазине с пометкой (unlicensed — visible to admins only), поэтому вы можете настроить и проверить расширение до покупки ключа. В OpenCart 4 такого предпросмотра нет: магазин не видит вход администратора, поэтому без действующего ключа способ скрыт для всех. После того как вы один раз откроете страницу Edit, на странице Dashboard админ-панели появляется напоминание. Закройте его кнопкой ×, чтобы скрыть на 7 дней. Существующие заказы не затрагиваются.

Когда лицензия истекает, расширение продолжает работать, но для обновлений и поддержки нужно продление. Статус проверяется автоматически, когда вы открываете страницу Dashboard или Edit в админ-панели: раз в сутки в течение первых 14 дней после ввода ключа, затем раз в неделю. Cron-задание не нужно. При удалении расширения лицензионный ключ и статус лицензии всегда удаляются.

Устранение неполадок

LP Express не появляется при оформлении заказа: проверьте, что лицензия действует и включён Enable/Disable. Проверьте Geo zone (или что включён Ignore shipping zones и страна разрешена). Откройте страницу расширения: предупреждение объяснит, если не задана цена или нет доступного почтового терминала. Проверьте также ограничения по весу и Minimum cart total, а также что у товаров Requires Shipping установлено в Yes. Если включён Debug log, поле Log на странице расширения показывает, почему способ доставки был скрыт.

Нет почтовых терминалов: онлайн-список не удалось загрузить, и нет ни сохранённой копии, ни собственного списка. Расширение повторяет попытку каждые 15 минут. Введите собственный список в Own terminal list или выберите Only my own list.

Список терминалов устарел: нажмите Save на странице расширения. Это перезагрузит список терминалов. Если вы используете собственный список, обновляйте строки самостоятельно.

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

Селектор терминалов не появляется: селектор добавляется на шаг способа доставки стандартного оформления заказа OpenCart (на OpenCart 4 в окно Shipping method options) и проверен со стандартной темой. Сильно изменённая тема или стороннее расширение оформления заказа могут его не показывать.

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

Страница пишет "Warning: You do not have permission to modify VibeFox LP Express!": ваша группа администраторов может только просматривать настройки. Дайте группе право изменения для extension/shipping/vfd_lp_express (OpenCart 3) или extension/vfd_lp_express/shipping/vfd_lp_express (OpenCart 4) в разделе System > Users > User Groups.

Для разработчиков: адрес списка терминалов можно заменить настройкой vfd_lpex_feed_url (для тестов); на странице настроек для неё нет поля.

Удаление

Перейдите в Extensions > Extensions, выберите тип Shipping и нажмите Uninstall (красная кнопка −) рядом с VibeFox LP Express. Лицензионный ключ и статус лицензии этого расширения всегда удаляются. OpenCart всегда сбрасывает Enable/Disable, Sort order, Tax class и Geo zone. События расширения всегда удаляются, а кэш списка терминалов очищается. Если включено Remove data on uninstall, также удаляются настройки, журнал, сохранённая копия списка терминалов и терминалы незавершённых оформлений заказа. Если выключено, остальные настройки и сохранённая копия остаются и будут использованы при повторной установке расширения. Терминал, сохранённый в заказах, никогда не удаляется, и существующие заказы сохраняют терминал в своём способе доставки.

На OpenCart 4, чтобы удалить и файлы расширения, после удаления перейдите в Extensions > Installer и нажмите Uninstall (оранжевая кнопка −) рядом с VibeFox LP Express в списке установленных расширений, затем Delete (красная кнопка корзины), чтобы удалить загруженный пакет.

LP Express — торговая марка её владельца. Это расширение не связано с LP Express и не одобрено LP Express.