VibeFox Australia Post for PrestaShop — Помощь

Требования

PrestaShop: 8.0–9.x.

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

Ключ PAC API Australia Post (только для тарифов в реальном времени): тарифы в реальном времени получаются через API Postage Assessment Calculator (PAC) Australia Post. Ключ бесплатный: зарегистрируйтесь и получите ключ PAC API на Developer Centre Australia Post (developers.auspost.com.au). На странице модуля есть ссылка на страницу регистрации. Также понадобится 4-значный австралийский почтовый индекс, из которого вы отправляете посылки. Если вы используете только фиксированные цены для каждой страны, ключ API не нужен.

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

Установка

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

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

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

4. Выберите Rate source. Для тарифов в реальном времени введите ключ PAC API, почтовый индекс отправки и, если основная валюта вашего магазина не AUD, курс пересчёта в AUD (см. раздел «Конфигурация»). Нажмите Save.

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

Конфигурация

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

Если выбран источник тарифов в реальном времени, но не заполнены ключ API, почтовый индекс отправки из 4 цифр или курс пересчёта в AUD, после сохранения появляется предупреждение. Оно также сообщает, что происходит до исправления: перевозчик скрыт при оформлении заказа или в режиме запасного варианта используются фиксированные цены для стран.

Числовые поля принимают точку или запятую в качестве десятичного разделителя. Значение, которое не является числом или отрицательно, не сохраняется: предупреждение называет поле, а предыдущее значение остаётся. Страница также предупреждает, если единица измерения веса или размеров магазина (International > Localization) неизвестна модулю. В этом случае вес товаров считается в кг, а размеры — в см.

Общие

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

Method title: название перевозчика, которое видит покупатель при оформлении заказа. Оно же является названием перевозчика в Shipping > Carriers: если переименовать перевозчика там, это поле обновится. По умолчанию: Australia Post. Не более 64 символов: более длинное название отклоняется, и ничего не сохраняется. Если поле пустое или содержит символы, которые PrestaShop не допускает в названии перевозчика, появляется предупреждение и используется Australia Post.

Tax status: как налог применяется к стоимости доставки.

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

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

Australia Post API (live rates) (для фиксированных цен не нужно)

PAC API key: ваш бесплатный ключ PAC API Australia Post. Он передаётся в Australia Post в заголовке AUTH-KEY. После сохранения поле остаётся пустым и показывает Saved — leave empty to keep it. Вводите новое значение, только если хотите его изменить.

Remove the saved API key: включите и сохраните, чтобы удалить сохранённый ключ. После этого тарифы в реальном времени перестанут работать.

Ship-from postcode: 4-значный австралийский почтовый индекс, из которого отправляются посылки, например 2000.

Domestic service: используется для доставки внутри Австралии (до 22 кг, 105 см по каждой стороне): Parcel Post (по умолчанию) или Express Post.

International service: используется для доставки за пределы Австралии (до 20 кг): International Standard (по умолчанию), International Express или International Courier.

Remove GST: делит внутренние цены API на 1,1. Внутренние цены Australia Post включают 10% GST. Включите эту опцию, когда PrestaShop сам добавляет налог к доставке (Tax status = Taxable с налоговым правилом у перевозчика), чтобы GST не начислялся дважды. Международная почтовая доставка освобождена от GST и никогда не изменяется.

AUD → (your currency) rate: в надписи показана основная валюта вашего магазина. Цены Australia Post указаны в AUD. Если основная валюта не AUD, введите, сколько единиц вашей валюты стоит один AUD, например 0.61. Курс должен быть больше 0. Без курса тарифы в реальном времени не используются. Если основная валюта — AUD, страница сообщит, что пересчёт не нужен: оставьте поле пустым. Точка и запятая принимаются как десятичный разделитель.

Посылка для тарифов в реальном времени

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

Default product weight (kg): используется для каждого товара без веса, в запросе к Australia Post и в проверке Min cart weight (kg) / Max cart weight (kg). По умолчанию: 1.

Default parcel length (cm): используется, когда ни у одного товара в корзине нет габаритов. По умолчанию: 22.

Default parcel width (cm): используется, когда ни у одного товара в корзине нет габаритов. По умолчанию: 16.

Default parcel height (cm): используется, когда ни у одного товара в корзине нет габаритов. По умолчанию: 8.

Если у товаров есть габариты, посылка получает наибольшие длину и ширину среди них, а высота увеличивается, пока посылка не вместит объём всех товаров.

Фиксированные цены (используются с фиксированными ценами и как запасной вариант для тарифов в реальном времени)

Country prices: таблица двухбуквенных кодов стран (AU, NZ, US и т. д.) и цен в основной валюте магазина без налогов. Нажмите Add row, чтобы добавить страну, и ссылку ×, чтобы удалить строку. Используйте * для всех остальных стран. Для страны без цены (и без строки *) фиксированного тарифа нет, поэтому перевозчик для неё скрывается. Строки с некорректным кодом страны или без цены удаляются при сохранении. Таблица пуста, пока вы не добавите цены.

Fixed price per: Order взимает цену один раз. Item (price × quantity) умножает её на количество товаров в корзине. Это относится только к фиксированным ценам. Тарифы в реальном времени всегда рассчитываются для всей посылки.

Условия

Min cart weight (kg): скрывает перевозчика, если вес корзины ниже этого значения. 0 означает отсутствие ограничения.

Max cart weight (kg): скрывает перевозчика, если вес корзины выше этого значения. По умолчанию: 22. 0 означает отсутствие ограничения, пустое поле означает 22 кг. Ограничения посылок Australia Post: 22 кг внутри страны, 20 кг международные. Если Min cart weight (kg) больше максимума, перевозчик никогда не будет показан: появляется предупреждение, и оба веса сохраняют прежние значения.

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

Free shipping: включает бесплатную доставку от суммы, указанной ниже.

Free shipping from: сумма товаров (после скидок, без налогов), начиная с которой доставка бесплатна. В этом случае запрос к API не выполняется. Используется, только если включена опция Free shipping.

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

Обычно перевозчик предлагается в зонах, которые для него выбраны в Shipping > Carriers.

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

Countries: страны назначения для этого режима. Оставьте поле пустым, чтобы разрешить все активные страны. Удерживайте Ctrl (Cmd на Mac) и нажимайте, чтобы выбрать несколько стран. Используется только вместе с Ignore shipping zones.

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

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

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

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

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

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

В режиме фиксированных цен цена берётся из таблицы. В режимах тарифов в реальном времени модуль передаёт в Australia Post вес посылки и, для доставки внутри Австралии, почтовые индексы отправки и доставки и размеры посылки; для международной доставки — страну назначения. Внутренний тариф в реальном времени запрашивается, только если в адресе доставки указан 4-значный почтовый индекс. Запрос не отправляется, если посылка превышает ограничения Australia Post (22 кг или 105 см внутри страны, 20 кг международная). Цена в AUD пересчитывается по вашему курсу, а GST удаляется из внутренних цен, если включена опция Remove GST. Цена рассчитывается в основной валюте магазина и затем показывается в валюте корзины покупателя.

Каждый успешный ответ кешируется на 1 час, поэтому та же корзина не вызывает новый запрос. Неудачный запрос кешируется на 10 минут, чтобы оформление заказа не ждало Australia Post при каждом обновлении. Тайм-аут API составляет 10 секунд. Ошибки API никогда не показываются покупателю: перевозчик скрывается или в режиме запасного варианта используется фиксированная цена. Причина записывается в журнал.

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

Модуль только рассчитывает тарифы. Он не создаёт этикетки доставки, отправления и манифесты eParcel или MyPost Business, не отслеживает посылки и не позволяет покупателям выбирать постаматы или почтовые отделения. Корзина всегда рассчитывается как одна посылка. Письма, сумки и договорные тарифы (eParcel) не включены.

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

Модуль работает с лицензионным ключом VibeFox с vibefox.net. Блок лицензии License — VibeFox Australia Post — первый блок на странице Modules > Module Manager > VibeFox Australia Post > Configure, над настройками. Вставьте ключ в поле License key и нажмите Activate. После этого блок показывает ключ в замаскированном виде, статус (например, дату, до которой лицензия действительна, и ваш домен), а также кнопки Check now для повторной проверки статуса, Change key для ввода другого ключа и Remove key для удаления ключа из этого магазина. Ниже находятся строка Product: presta-shipping-australia-post и ссылка 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.

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

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

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

Australia Post не появляется при оформлении заказа: проверьте, что лицензия активна и включена опция Enable Australia Post (перевозчик активен в Shipping > Carriers). В Shipping > Carriers проверьте, что перевозчик охватывает зону страны покупателя и группу покупателя (или что включена опция Ignore shipping zones, а страна разрешена в Countries). Проверьте ограничения по весу корзины и Minimum order amount. В режиме фиксированных цен проверьте, что для страны или для * задана цена. Товары также могут быть ограничены определёнными перевозчиками на странице товара.

Тарифы в реальном времени не появляются: включите Debug log, обновите страницу оформления заказа и посмотрите поле Log на странице модуля. Там указана причина: нет ключа API или почтового индекса отправки, ещё не введён 4-значный почтовый индекс доставки, посылка превышает ограничения, нет курса пересчёта в AUD или отображается сообщение об ошибке Australia Post. При варианте Live rates, fixed price if the API gives no rate покупатели по-прежнему видят фиксированную цену, пока вы исправляете проблему.

Магазин работает не в AUD: введите курс пересчёта (сколько единиц вашей основной валюты стоит один AUD) в поле AUD → (your currency) rate. Фиксированные цены всегда указываются в основной валюте магазина.

GST на доставку начисляется дважды: внутренние цены Australia Post включают 10% GST. Если Tax status = Taxable и у перевозчика есть налоговое правило, включите Remove GST или установите Tax status в значение None.

Налог не добавляется к доставке: при Tax status = Taxable налог берётся из налогового правила перевозчика. Выберите его в Shipping > Carriers. Пока у перевозчика нет налогового правила, на странице модуля отображается предупреждение.

Цена слишком высокая или слишком низкая: проверьте вес и габариты товаров и значения по умолчанию в разделе Посылка для тарифов в реальном времени. При Item (price × quantity) фиксированные цены умножаются на количество товаров.

Тарифы устарели после изменения: нажмите Save на странице модуля. Это очистит кеш тарифов Australia Post.

На странице сообщается, что перевозчик Australia Post удалён: перевозчик был удалён в Shipping > Carriers. Нажмите Save на странице модуля, чтобы создать его заново, или сбросьте модуль в Modules > Module Manager.

Удаление

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

Australia Post является товарным знаком своего владельца. Этот модуль не связан с Australia Post и не одобрен ею.