VibeFox Loggi for PrestaShop — Помощь

Требования

PrestaShop: 8.0–9.x.

PHP: 8.0 или новее. Модуль не устанавливается на более старых версиях PHP.

Аккаунт Loggi (только для цен в реальном времени): цена в реальном времени использует GraphQL API Loggi с ключом API, который Loggi выдаёт для бизнес-аккаунтов. Обратитесь к вашему менеджеру по аккаунту Loggi или в службу поддержки интеграций Loggi (integracoes@loggi.com), см. также документацию API Loggi на docs.api.loggi.com. Нужны три значения: e-mail вашего аккаунта Loggi, ключ API и числовой ID вашего магазина. Если в вашем аккаунте Loggi есть только учётные данные для новой REST-платформы API Loggi (client ID и secret), цена в реальном времени недоступна и используются фиксированные цены. Если вы используете только фиксированные цены, аккаунт Loggi не нужен.

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

Установка

1. В панели администрирования откройте Modules > Module Manager и нажмите Upload a module. Выберите ZIP-файл модуля.

2. По завершении загрузки нажмите Configure или позже найдите VibeFox Loggi в списке модулей и нажмите Configure.

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

4. Введите e-mail API Loggi, ключ API, Shop ID и адрес забора, а если основная валюта вашего магазина не BRL — курс BRL. Добавьте фиксированные цены как страховку (см. Настройки) и нажмите Save.

5. Добавьте Бразилию в зоны перевозчика Loggi в Shipping > Carriers или включите Ignore shipping zones и выберите страны.

При установке модуль создаёт перевозчика Loggi с текстом срока доставки Courier delivery in Brazil. Перевозчик назначается всем зонам и всем группам клиентов. Зоны, группы клиентов, срок доставки, логотип и ограничения по размеру можно изменить в Shipping > Carriers. Цены там не задавайте: цена всегда берётся из модуля.

Настройки

Все настройки находятся на странице модуля: Modules > Module Manager > VibeFox Loggi > Configure. Они применяются ко всем зонам перевозчика. У каждого раздела своя кнопка Save, которая сохраняет всю страницу. Каждое сохранение также очищает кэш цен Loggi.

Предупреждения вверху страницы показывают неполную настройку: нет учётных данных API (используются только фиксированные цены), нет учётных данных API и фиксированных цен (перевозчик никогда не показывается), нет адреса забора, нет курса BRL, либо единица веса или габаритов магазина не распознаётся модулем (тогда она считается как кг или см; задайте единицы в International > Localization). Если значение неверно, например отрицательное число, страница показывает ошибку и ничего не сохраняется.

Общие

Enable Loggi: включает или выключает перевозчика. Это тот же переключатель, что и статус перевозчика в Shipping > Carriers.

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

API Loggi (цена в реальном времени) (оставьте учётные данные пустыми, чтобы использовать только фиксированные цены)

API e-mail: e-mail вашего аккаунта Loggi. Ключ API принадлежит ему. Должен быть корректным адресом e-mail.

API key: ваш ключ API Loggi. Он передаётся только в Loggi и никогда не записывается в журнал. После сохранения поле остаётся пустым и показывает Saved — leave empty to keep it; clear the API e-mail to remove it. Вводите новое значение, только если хотите его изменить. Если вы меняете API e-mail, введите также ключ API для нового e-mail, иначе страница покажет ошибку и ничего не сохранится. Чтобы удалить сохранённый ключ, очистите API e-mail и сохраните.

Shop ID: числовой ID (pk) вашего магазина в панели Loggi. Принимается только положительное число. Другое значение отклоняется с ошибкой.

Staging: использовать тестовую среду Loggi (staging) с тестовыми учётными данными. Staging и рабочая среда имеют разные аккаунты и ключи. По умолчанию: выключено.

Pickup address: адрес, по которому Loggi забирает посылки, одной строкой: улица и номер дома, район, город, штат и CEP, например Rua Example, 123 - Bairro, São Paulo - SP, 01310-100. Оставьте пустым, чтобы использовать адрес магазина из Shop Parameters > Contact > Stores, если он в Бразилии и имеет адрес и город. Без адреса забора Loggi не может рассчитать цену, и используются только фиксированные цены.

BRL exchange rate: цены Loggi указаны в бразильских реалах. Если основная валюта вашего магазина BRL, это поле не нужно, и страница об этом сообщает. Иначе введите, сколько стоит 1 BRL в валюте вашего магазина, например 0.16. Без него цены в реальном времени не используются. Принимается только положительное число. В качестве десятичного разделителя принимаются и точка, и запятая.

Фиксированные цены (в основной валюте вашего магазина, без налога)

Фиксированные цены используются, когда API Loggi не настроен, для направлений за пределами Бразилии или без полного CEP, а также всякий раз, когда Loggi не возвращает цену (API недоступен, ключ отклонён, адрес вне зоны обслуживания).

Price table: одна строка на страну назначения. Нажмите Add country, чтобы добавить строку, и значок корзины, чтобы удалить её. Выберите * All other countries для всех стран без собственной строки. В каждой строке есть Base price и весовые колонки: XS ≤1 kg, S ≤2 kg, M ≤3 kg, L ≤5 kg и XL >5 kg. Пустая (или нулевая) весовая колонка использует базовую цену. Базовая цена 0 означает бесплатную доставку. Принимаются как «9.99», так и «9,99». Пустые строки и вторая строка для той же страны удаляются при сохранении.

Price for countries not in the table: используется, когда нет актуальной цены Loggi и в таблице нет строки для страны назначения (и нет строки *). Оставьте пустым, чтобы в таком случае скрыть перевозчика.

Fixed price applies: способ расчёта фиксированных цен. Актуальная цена Loggi уже покрывает всю корзину и никогда не умножается.

Условия

Minimum weight: скрывает перевозчика, когда корзина весит меньше, в кг. 0 означает без ограничения.

Maximum weight: скрывает перевозчика, когда корзина весит больше, в кг. По умолчанию: 30. 0 означает без ограничения. Minimum weight не может быть больше Maximum weight.

Minimum order amount: показывает перевозчика, только когда промежуточная сумма корзины (после скидок, без налога) достигает этой суммы. Оставьте пустым, чтобы показывать всегда.

Free shipping from: промежуточная сумма корзины (после скидок, без налога), начиная с которой доставка Loggi бесплатна. Оставьте пустым, если бесплатной доставки нет.

Tax: налоговое правило перевозчика или No tax. Выберите No tax, если ваши цены и цена Loggi уже включают налоги.

Для ограничений по весу и весовых колонок товар без веса считается как 0 кг.

Доступность без зон доставки

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

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

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

Debug log: записывает расчёты цен и запросы к Loggi в logs/vfd_lggi_debug.log.php в папке модуля. Файл нельзя открыть через веб. Ошибки API всегда записываются, даже если эта опция выключена. Ключ API и адреса покупателей никогда не записываются в журнал.

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

Remove data on uninstall: если включено, удаление модуля стирает настройки Loggi, перевозчика, кэш цен и журналы. Если выключено, всё сохраняется для повторной установки.

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

На шаге доставки PrestaShop запрашивает у модуля цену Loggi. Учитываются только физические товары: виртуальные товары не добавляют вес и не входят в сумму заказа. Модуль сначала проверяет условия: разрешённые страны (с Ignore shipping zones), вес корзины и минимальную сумму заказа. Если применяется бесплатная доставка, цена равна 0 и запрос в Loggi не отправляется.

Для адреса в Бразилии с полным 8-значным CEP модуль формирует посылки Loggi: каждый товар поворачивается так, чтобы его наименьшая сторона была высотой, и товары укладываются в одну посылку, пока она остаётся в пределах 55 × 55 × 55 см и 20 кг. Товары без веса или габаритов считаются как 1 см по каждой стороне, а каждая посылка весит не менее 100 г. Loggi принимает 2 посылки на один расчёт, поэтому крупные корзины отправляются несколькими запросами, а итоги суммируются. Модуль передаёт в Loggi ваш Shop ID, адрес забора, адрес доставки и посылки и переводит итоговую сумму Loggi из BRL в основную валюту вашего магазина. Затем цена показывается в валюте корзины покупателя.

Каждая цена Loggi кэшируется на 1 час для каждой корзины, адреса, аккаунта и среды, чтобы одна и та же корзина не вызывала новый запрос. Неудачный расчёт кэшируется на 10 минут. Если Loggi вообще недоступен, запросы приостанавливаются на 2 минуты, чтобы оформление заказа не ждало Loggi при каждом обновлении. Тайм-аут API — 10 секунд.

Вместо этого используются фиксированные цены, если API не настроен, адрес за пределами Бразилии или полного CEP пока нет, отсутствует курс BRL, нет адреса забора, товар крупнее посылки Loggi, корзине нужно больше 10 посылок, либо Loggi возвращает ошибку, отклонённую посылку, адрес вне зоны обслуживания или нулевой итог. Если нет и фиксированной цены, перевозчик скрывается. Покупатель никогда не видит ошибку API. Причина записывается в журнал отладки.

Если вы редактируете перевозчика в Shipping > Carriers после того, как у него появились заказы, PrestaShop сохраняет его как новую версию перевозчика. Модуль автоматически следует за новой версией.

Модуль только рассчитывает цены. Он не создаёт заказы и отправления Loggi, не печатает этикетки, не отслеживает посылки, не показывает срок доставки при оформлении заказа и не предлагает пункты выдачи или постаматы. Создавайте отправления в панели Loggi. Loggi доставляет только в пределах Бразилии. Для других стран используйте фиксированные цены.

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

Модуль работает с лицензионным ключом VibeFox с vibefox.net. Блок лицензии License — VibeFox Loggi — это первый блок на странице Modules > Module Manager > VibeFox Loggi > Configure, над настройками. Введите ключ в поле License key и нажмите Activate. После этого блок показывает ключ в скрытом виде, статус (например, дату, до которой действует лицензия, и ваш домен) и кнопки Check now для повторной проверки статуса, Change key для ввода другого ключа и Remove key для удаления ключа из этого магазина. Ниже находятся строка Product: presta-shipping-loggi и ссылка Manage licenses and domains in your account, которая открывает ваш аккаунт vibefox.net. Изменить ключ могут только сотрудники с правом Configure для модуля. Тексты блока соответствуют языку бэк-офиса (включены английский и русский).

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

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

Без активного ключа перевозчик Loggi не показывается покупателям при оформлении заказа, и стоимость не рассчитывается. Витрина PrestaShop не знает, что вы вошли в бэк-офис, поэтому перевозчик скрыт и для вас: вы можете настроить модуль до покупки ключа, но не можете проверить его при оформлении заказа. Напоминание появляется в Modules > Module Manager на вкладке Alerts. Существующие заказы не затрагиваются.

Когда лицензия истекает, модуль продолжает работать, но для обновлений и поддержки нужно продление. Статус автоматически проверяется снова во время вашей работы в бэк-офисе: раз в день в первые 14 дней после ввода ключа, затем раз в неделю. Задание cron не требуется. Удаление или сброс модуля всегда удаляет лицензионный ключ и статус лицензии.

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

Loggi не появляется при оформлении заказа: проверьте, что лицензия активна и Enable Loggi включено. В Shipping > Carriers проверьте, что перевозчик охватывает зону страны покупателя и группу покупателя (или что включено Ignore shipping zones и страна разрешена). Проверьте предупреждения вверху страницы модуля, ограничения по весу и Minimum order amount. Если покупатель ещё не ввёл полный CEP или Loggi не возвращает цену, перевозчику нужна фиксированная цена: строка для страны, строка * или Price for countries not in the table. Товары также можно ограничить определёнными перевозчиками на странице товара.

Показываются только фиксированные цены: посмотрите поле Log на странице модуля. Ошибки всегда записываются. Включите Debug log, чтобы видеть каждый шаг, и перезагрузите оформление заказа. Типичные причины: нет e-mail API, ключа или Shop ID, нет адреса забора, нет BRL exchange rate для валюты магазина, отличной от BRL, ещё нет полного 8-значного CEP, товар больше 55 см или тяжелее 20 кг, или адрес вне зоны обслуживания Loggi.

HTTP 401 или 403 в журнале: Loggi отклонил e-mail или ключ API. Проверьте их в Loggi и убедитесь, что Staging соответствует учётным данным: ключи тестовой и рабочей сред различаются.

Мой магазин продаёт в евро или долларах: Loggi отвечает в BRL. Введите BRL exchange rate (сколько стоит 1 BRL в основной валюте вашего магазина). Фиксированные цены всегда указываются в основной валюте магазина.

Цены не точные: заполните вес и габариты товаров. Без них товары считаются как 1 см по каждой стороне, а каждая посылка — как минимум 100 г.

Per item не умножает цену Loggi: так и задумано. Актуальная цена Loggi покрывает всю корзину. Per item применяется только к фиксированным ценам.

Цены выглядят устаревшими после изменения: нажмите Save на странице модуля. Это очистит кэш цен Loggi.

Страница сообщает, что перевозчик Loggi не найден: перевозчик был удалён в Shipping > Carriers. Сбросьте модуль в Modules > Module Manager, чтобы создать его заново.

Удаление

Откройте Modules > Module Manager, откройте меню рядом с VibeFox Loggi и выберите Uninstall. Лицензионный ключ и статус лицензии всегда удаляются. Кэш цен Loggi всегда удаляется. Если Remove data on uninstall включено, перевозчик удаляется (заказы сохраняют историю), а настройки и журнал стираются. Если выключено, перевозчик только отключается, и все настройки сохраняются. При повторной установке модуля сохранённый перевозчик возвращает статус, который был у него до удаления.

Loggi — товарный знак его владельца. Этот модуль не аффилирован с Loggi и не одобрен Loggi.