VibeFox Aramex for PrestaShop — Допомога

Вимоги

PrestaShop: 8.0 – 9.x.

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

Обліковий запис Aramex (лише для актуальних тарифів): актуальні тарифи використовують API Aramex Rate Calculator. Aramex надає доступ до API власникам облікових записів. Запитайте свого менеджера Aramex або перегляньте Aramex Developers Solution Center на сайті Aramex. Потрібно шість значень: ім'я користувача API (зазвичай адреса електронної пошти), пароль, номер облікового запису, PIN облікового запису, код підрозділу (entity, наприклад DXB) і код країни облікового запису (наприклад, AE). Якщо ви використовуєте лише фіксовані ціни для кожної країни, обліковий запис Aramex не потрібен.

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

Встановлення

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

2. Після завершення завантаження натисніть Configure або пізніше знайдіть VibeFox Aramex у списку модулів і натисніть Configure.

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

4. Оберіть, як розраховується вартість доставки, заповніть відповідні розділи (див. Налаштування) і натисніть Save.

Під час встановлення модуль створює перевізника Aramex з текстом терміну доставки Courier delivery. Перевізника призначено всім зонам і всім групам клієнтів. Зони, групи клієнтів, термін доставки, логотип і обмеження розміру можна змінити в Shipping > Carriers. Не встановлюйте там ціни: ціна завжди береться з модуля.

Налаштування

Усі налаштування розташовані на сторінці модуля: Modules > Module Manager > VibeFox Aramex > Configure. Кожен розділ має власну кнопку Save, яка зберігає всю сторінку. Кожне збереження також очищає кеш тарифів Aramex.

Загальні

Enable Aramex: вмикає або вимикає перевізника. Це той самий перемикач, що й статус перевізника в Shipping > Carriers.

Method title: назва перевізника, яка показується в кошику та під час оформлення замовлення. За замовчуванням: Aramex. Обов'язкове поле.

Shipping cost: як розраховується ціна.

Причина відсутності актуального тарифу записується в журнал налагодження. Покупцеві вона ніколи не показується.

Обліковий запис API Aramex (потрібен лише для актуальних тарифів; усі шість полів обов'язкові)

Username: ваше ім'я користувача API Aramex, зазвичай адреса електронної пошти.

Password: ваш пароль API Aramex. Після збереження поле залишається порожнім і показує Saved — leave empty to keep it. Вводьте нове значення, лише якщо хочете його змінити.

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: необов'язково.

Якщо країна відправлення збігається з країною магазину, порожні поля заповнюються з адреси магазину в Shop Parameters > Contact > Stores.

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

Price per country: таблиця двобуквених кодів країн і цін у валюті за замовчуванням вашого магазину, без податку. Натисніть Add row, щоб додати країну, та значок кошика, щоб її видалити. Використовуйте * як код країни для всіх інших країн. Країни без ціни (якщо немає рядка з *) не отримують фіксованого тарифу, тому перевізника для них приховано.

Fixed price applies: Per order стягує ціну один раз. Per item множить її на кількість товарів у кошику. Актуальні тарифи Aramex завжди розраховуються за відправлення.

Умови

Minimum weight: приховувати перевізника, якщо кошик важить менше, в кг. 0 означає без обмеження.

Maximum weight: приховувати перевізника, якщо кошик важить більше, в кг. За замовчуванням: 100. 0 означає без обмеження.

Minimum order amount: показувати перевізника лише тоді, коли проміжна сума кошика (після знижок, без податків) досягає цієї суми. Залиште порожнім, щоб показувати завжди.

Free shipping: вмикає безкоштовну доставку Aramex від суми, вказаної нижче.

Free shipping from: проміжна сума кошика (після знижок, без податків), від якої доставка безкоштовна. Використовується лише коли ввімкнено Free shipping.

Tax: податкове правило перевізника або No tax. Актуальні тарифи Aramex можуть уже включати ПДВ. У такому разі оберіть No tax, щоб не стягувати податок двічі.

Countries: пропонувати Aramex лише для цих країн призначення. Залиште порожнім, щоб дозволити всі країни зон перевізника.

Додатково

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

Log: показує розмір і останні записи журналу налагодження. Натисніть Clear log, щоб його очистити.

Remove data on uninstall: якщо ввімкнено, під час видалення модуля видаляються налаштування Aramex, перевізник, кеш тарифів і журнали. Якщо вимкнено, все зберігається для повторного встановлення.

Як це працює під час оформлення замовлення

На етапі доставки PrestaShop запитує в модуля ціну Aramex. Враховуються лише фізичні товари: віртуальні товари не додають ваги та не входять до суми замовлення. Модуль спочатку перевіряє умови: дозволені країни, вага кошика та мінімальна сума замовлення. Якщо діє безкоштовна доставка, ціна дорівнює 0 і запит до Aramex не надсилається.

У фіксованому режимі ціна береться з таблиці. У режимах актуальних тарифів модуль надсилає в Aramex адреси відправлення та доставки, тарифну вагу, службу та вашу валюту за замовчуванням і використовує повернуту суму. Актуальний тариф запитується, лише якщо в адресі доставки є місто або поштовий індекс. Ціна розраховується у вашій валюті за замовчуванням, а потім показується у валюті кошика покупця.

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

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

Якщо ви редагуєте перевізника в Shipping > Carriers після того, як за ним є замовлення, PrestaShop зберігає його як нову версію перевізника. Модуль автоматично використовує нову версію.

Модуль лише розраховує тарифи. Він не створює відправлень Aramex, не друкує етикетки, не замовляє забір кур'єром, не відстежує посилки і не дозволяє покупцеві обрати офіс Aramex. Посилка завжди надсилається в Aramex як одне місце.

Ліцензійний ключ

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

Без активного ключа перевізник Aramex не показується покупцям під час оформлення замовлення, і тарифи не розраховуються. Вітрина PrestaShop не знає, що ви увійшли в бекофіс, тож перевізника приховано і для вас: модуль можна налаштувати до купівлі ключа, але не можна перевірити під час оформлення замовлення. Нагадування з'являється в Modules > Module Manager на вкладці Alerts. Наявні замовлення не змінюються.

Коли ліцензія закінчується, модуль продовжує працювати, але для оновлень і підтримки потрібне продовження. Статус автоматично перевіряється знову, поки ви працюєте в бекофісі: раз на день протягом перших 14 днів після введення ключа, потім раз на тиждень. Cron-завдання не потрібне. Видалення або скидання модуля завжди видаляє ліцензійний ключ і статус ліцензії.

Усунення несправностей

Aramex не з'являється під час оформлення замовлення: перевірте, чи активна ліцензія і чи ввімкнено Enable Aramex. У Shipping > Carriers перевірте, чи перевізник охоплює зону країни покупця та його групу. Перевірте Countries, обмеження ваги та Minimum order amount. У фіксованому режимі перевірте, чи має країна або * ціну. Товари також можуть бути обмежені певними перевізниками на сторінці товару.

Актуальні тарифи не з'являються: увімкніть Debug log, оновіть сторінку оформлення замовлення та перегляньте поле Log на сторінці модуля. Там вказано причину: відсутні облікові дані API, код помилки Aramex, не вказано місто відправлення, не вказано місто або поштовий індекс доставки, спрацювало обмеження ваги чи суми, або котирування в іншій валюті. З Aramex live rates, fixed prices if the API fails покупці все одно отримують фіксовану ціну, поки ви виправляєте проблему.

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

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

Податок на доставку стягується двічі: суми Aramex можуть уже включати ПДВ. Встановіть Tax у значення No tax.

Тарифи застаріли після змін: натисніть Save на сторінці модуля. Це очистить кеш тарифів Aramex.

Сторінка повідомляє, що перевізника Aramex не знайдено: перевізника видалено в Shipping > Carriers. Скиньте модуль у Modules > Module Manager, щоб створити його знову.

Видалення

Перейдіть до Modules > Module Manager, відкрийте меню поруч із VibeFox Aramex і виберіть Uninstall. Ліцензійний ключ, статус ліцензії та кеш тарифів завжди видаляються. Якщо Remove data on uninstall ввімкнено, перевізника буде видалено (замовлення зберігають історію), а налаштування й журнал — видалено. Якщо вимкнено, перевізника лише деактивують, і всі налаштування зберігаються. Повторне встановлення модуля знову ввімкне збереженого перевізника.

Aramex є торговельною маркою відповідного власника. Цей модуль не пов'язаний з Aramex і не схвалений нею.