VibeFox Aramex for WooCommerce — Помощь

Требования

WordPress: 5.8 или новее.

WooCommerce: 5.0 или новее, установлен и активен. Плагин не активируется без него.

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

Учётная запись Aramex (только для тарифов в реальном времени): тарифы в реальном времени используют Rate Calculator API компании Aramex. Aramex предоставляет доступ к API владельцам своих учётных записей. Спросите вашего аккаунт-менеджера Aramex или см. Aramex Developers Solution Center на сайте Aramex. Нужны шесть значений: имя пользователя API (обычно адрес e-mail), пароль, номер учётной записи, PIN учётной записи, код офиса учётной записи (entity, например DXB) и код страны учётной записи (например, AE). Если вы используете только фиксированные цены для каждой страны, учётная запись Aramex не нужна.

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

Установка

1. В WordPress перейдите в Plugins > Add New > Upload Plugin, выберите ZIP-файл плагина и нажмите Install Now. Также можно загрузить папку vfd_aramex в /wp-content/plugins/ по FTP.

2. Нажмите Activate.

3. Откройте настройки: WooCommerce > Settings > Shipping > VibeFox Aramex или нажмите Settings под названием плагина на странице Plugins.

4. Введите ваш лицензионный ключ VibeFox в блоке лицензии вверху страницы и нажмите Activate.

5. Выберите, как рассчитывается стоимость доставки, и заполните соответствующие разделы (см. раздел «Настройка»).

6. Добавьте VibeFox Aramex в зону доставки в WooCommerce > Settings > Shipping > Shipping zones или включите Ignore shipping zones и выберите страны.

Настройка

Все настройки находятся на одной странице: WooCommerce > Settings > Shipping > VibeFox Aramex. Они действуют во всех зонах доставки. Когда вы добавляете способ в зону, в окне зоны есть только одно поле:

Title (zone): название, которое видит покупатель для этой зоны. Оставьте пустым, чтобы использовать общее Method title.

Каждый раз при сохранении настроек кэшированные тарифы Aramex сбрасываются.

Общие

Enable/Disable: включает или выключает способ во всех зонах сразу.

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

Shipping cost: как рассчитывается стоимость.

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

Учётная запись Aramex API (нужна только для тарифов в реальном времени; все шесть полей обязательны)

Username: имя пользователя Aramex API, обычно адрес e-mail.

Password: пароль Aramex API.

Account number: номер вашей клиентской учётной записи Aramex.

Account PIN: PIN вашей учётной записи Aramex.

Account entity: код офиса (подразделения) вашей учётной записи Aramex, например DXB, AMM или RUH.

Account country code: двухбуквенный код страны вашей учётной записи Aramex, например AE.

Служба Aramex (используется для тарифов в реальном времени)

Если адрес доставки находится в стране отправления, отправление рассчитывается как Domestic. Все остальные отправления рассчитываются как International express.

International service: продукт Aramex для отправлений за границу: PPX Priority Parcel Express (по умолчанию), PDX Priority Document Express, PLX Priority Letter Express, DPX Value Express Parcels, EPX Economy Parcel Express, EDX Economy Document Express, GPX Ground Parcel Express или GDX Ground Document Express.

Domestic service: продукт Aramex для отправлений внутри страны отправления: ONP Overnight Parcel (по умолчанию), OND Overnight Document, SMP Same Day Parcel, SMD Same Day Document, SDD Same Day Delivery, EMD Early Morning Delivery, PEC Economy Delivery, PEX Road Express или HVY Heavy (20 кг и больше).

Payment type: кто оплачивает отправление Aramex: Prepaid (платит отправитель), Collect (платит получатель) или Third party (третья сторона). Обычно Prepaid.

API weight unit: единица измерения, которая передаётся в Aramex: KG или LB. Веса товаров пересчитываются из единицы веса вашего магазина. Оплачиваемый вес — это большее из фактического веса и объёмного веса (длина × ширина × высота в см / 5000). Минимум — 0,5 кг, что также покрывает товары без веса.

Currency conversion rate: У Aramex запрашивается котировка в валюте вашего магазина. Если Aramex всё равно отвечает в другой валюте, тариф умножается на это число (1 единица валюты Aramex = X единиц валюты вашего магазина). Оставьте поле пустым, чтобы отклонять такие котировки, — тогда покупатель никогда не будет оплачивать доставку в неверной валюте. Точка и запятая принимаются как десятичный разделитель.

Отправка из (адрес отправления) (используется для тарифов в реальном времени)

Origin country: страна, из которой вы отправляете. По умолчанию это страна вашего магазина.

Origin city: город, из которого вы отправляете. Aramex требует его указать.

Origin state / emirate: необязательно.

Origin postcode: необязательно.

Если страна отправления совпадает со страной вашего магазина, пустые поля заполняются из адреса магазина в WooCommerce > Settings > General.

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

Price per country: таблица двухбуквенных кодов стран и цен в валюте вашего магазина. Нажмите Add row, чтобы добавить страну, и крестик, чтобы удалить её. Используйте * как код страны для всех остальных стран. Страны без цены (если нет строки с *) не получают фиксированного тарифа, поэтому способ для них скрывается.

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

Условия

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

Maximum weight (kg): скрывать способ, если корзина весит больше. По умолчанию: 100. 0 означает без ограничения.

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

Excluded shipping classes: скрывать способ, если в корзине есть товар из любого из этих классов доставки WooCommerce.

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

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

Tax status: Taxable добавляет налог WooCommerce к стоимости доставки, None — не добавляет. Тарифы Aramex в реальном времени могут уже включать НДС. В таком случае выберите None, чтобы налог не начислялся дважды.

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

Ignore shipping zones: предлагать Aramex для указанных ниже стран, даже если способ не добавлен ни в одну зону доставки.

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

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

Debug log: записывает расчёты тарифов и ошибки API в файл logs/vfd_armx_debug.log.php в папке плагина. Файл нельзя открыть через веб. Пароли, PIN, номер учётной записи и адреса покупателей маскируются. Выключите журнал, когда закончите.

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

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

Когда покупатель вводит адрес доставки, WooCommerce запрашивает у плагина тариф. Сначала плагин проверяет условия: страну доставки, вес корзины, минимальную сумму заказа и исключённые классы доставки. Если применяется бесплатная доставка, покупатель видит способ как Aramex (free), и запрос в Aramex не отправляется.

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

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

Способ работает в классическом оформлении заказа и в блоках «Корзина» и «Оформление заказа». Он совместим с High-Performance Order Storage (HPOS) WooCommerce.

Плагин только рассчитывает тарифы. Он не создаёт отправления Aramex, не печатает этикетки, не заказывает курьера, не отслеживает посылки и не позволяет покупателю выбрать офис Aramex. Посылка всегда отправляется в Aramex одним местом.

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

Плагин работает с лицензионным ключом VibeFox с vibefox.net. Блок лицензии находится вверху страницы WooCommerce > Settings > Shipping > VibeFox Aramex. Вставьте ключ в поле License key и нажмите Activate. В блоке показан статус, например дата окончания действия лицензии и ваш домен. Используйте Check now, чтобы проверить статус снова, Change key, чтобы ввести другой ключ, и Remove key, чтобы удалить его с этого сайта. Ссылка Manage licenses and domains in your account открывает ваш аккаунт на vibefox.net.

Один ключ работает на одном домене. Удаление ключа с сайта не освобождает слот домена. Освободите слот в вашем аккаунте на vibefox.net.

Без активного ключа Aramex не показывается покупателям при оформлении заказа. Менеджеры магазина, вошедшие в систему, по-прежнему видят его с пометкой (unlicensed — visible to admins only), чтобы вы могли настроить и протестировать плагин до покупки ключа. Напоминание появляется на странице Plugins и на страницах WooCommerce. Существующие заказы не затрагиваются.

Когда срок лицензии истекает, плагин продолжает работать, но для обновлений и поддержки нужно продление. Статус автоматически проверяется снова в фоновом режиме.

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

Aramex не появляется при оформлении заказа: проверьте, что лицензия активна, включён Enable/Disable, а способ добавлен в зону доставки страны покупателя (или включён Ignore shipping zones и страна разрешена). Проверьте ограничения по весу, Minimum order amount и Excluded shipping classes. В фиксированном режиме проверьте, что для страны или для * задана цена.

Тарифы в реальном времени не появляются: включите Debug log, обновите страницу оформления заказа и откройте logs/vfd_armx_debug.log.php в папке плагина. В нём указана причина: отсутствуют учётные данные API, код ошибки Aramex, не указан город отправления, ещё не указан город или почтовый индекс доставки, сработало ограничение по весу или сумме, либо котировка в другой валюте. С вариантом Aramex live rates, fixed prices if the API fails покупатели получают фиксированную цену, пока вы исправляете проблему.

Ошибка ERR75 в журнале: Aramex отклонил вход в систему. Проверьте имя пользователя, пароль, номер учётной записи, PIN, entity и код страны у вашего аккаунт-менеджера Aramex.

Котировка в другой валюте отклоняется: Aramex ответил в валюте, отличной от валюты вашего магазина. Введите Currency conversion rate или попросите Aramex давать котировку в вашей валюте.

Налог на доставку начисляется дважды: итоги Aramex могут уже включать НДС. Установите Tax status в None.

Тарифы выглядят устаревшими после изменения: сохраните страницу настроек. Это очистит кэшированные тарифы Aramex.

Тестовая среда Aramex (sandbox): плагин использует рабочий калькулятор тарифов Aramex Rate Calculator. Разработчики могут изменить адрес API с помощью фильтра vfd_armx_api_url. Фильтры vfd_armx_rate_request, vfd_armx_number_of_pieces и vfd_armx_volumetric_divisor меняют запрос, количество мест и делитель объёмного веса.

Блок лицензии показывает ошибку: следуйте сообщению в блоке. Например, если ключ уже используется на другом домене, освободите слот в вашем аккаунте на vibefox.net и нажмите Check now. Если адрес сайта изменился, нажмите Check now, чтобы активировать ключ для нового домена. Если сервер лицензий недоступен, плагин продолжает работать по последнему известному статусу.

Удаление

Деактивация плагина сохраняет все данные. Чтобы удалить плагин, деактивируйте его и удалите на странице Plugins. Лицензионный ключ и статус лицензии этого плагина удаляются всегда. Настройки, способы в зонах, кэшированные тарифы и журналы удаляются, только если была включена опция Remove data on uninstall. В противном случае они сохраняются для повторной установки. Существующие заказы сохраняют свои строки доставки.

Aramex — товарный знак соответствующего правообладателя. Этот плагин не связан с Aramex и не одобрен ею.