VibeFox FedEx for WooCommerce — Помощь

Требования

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

WooCommerce: 7.0 или новее, установлен и активен. Без него плагин не активируется.

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

Учётная запись FedEx и ключи API (только для актуальных тарифов): в FedEx Developer Portal (developer.fedex.com) создайте проект с Rate API, привяжите свою учётную запись доставки FedEx и скопируйте API Key и Secret Key. Также понадобится 9-значный номер учётной записи FedEx. Тестовые ключи работают только при включённом Sandbox, ключи production — только при выключенном. Плагин использует REST API FedEx с OAuth 2.0; meter number и пароль веб-служб не нужны. Если вы используете только фиксированные цены, ключи FedEx не нужны.

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

Установка

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

2. Нажмите Activate.

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

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

5. Введите API Key, Secret Key, 9-значный номер учётной записи FedEx и адрес Ship from (почтовый индекс и, для США и Канады, двухбуквенный код штата). Выключите Sandbox, если используете ключи production.

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

7. При необходимости введите фиксированные цены как резерв.

Настройка

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

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

В верхней части страницы плагин выводит предупреждения: заполнена только часть из трёх учётных данных API, не указаны ключи API или фиксированные цены (тогда способ никогда не показывается), не указан почтовый индекс отправления, для США или Канады не указан код штата отправления, либо валюта магазина отличается от валюты учётной записи FedEx без курса обмена. При каждом сохранении настроек очищаются кэшированный токен FedEx и тарифы. Числовые поля принимают десятичную точку или запятую. Некорректное число не сохраняется, и об этом сообщается.

General

Enable/Disable: включает или выключает доставку FedEx во всех зонах сразу. По умолчанию: включено.

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

Tax status: Taxable позволяет WooCommerce добавить налог к стоимости доставки, поэтому используется сумма FedEx без налогов. None использует чистую сумму FedEx как есть. По умолчанию: Taxable.

API FedEx (актуальные тарифы)

Без ключей используются фиксированные цены. В разделе есть ссылка Clear cached FedEx token and rates.

Sandbox: использует песочницу FedEx с тестовыми ключами. Выключите, чтобы получать реальные тарифы с ключами production. По умолчанию: включено.

API Key: API Key (client_id) вашего проекта в FedEx Developer Portal.

Secret Key: Secret Key (client_secret) того же проекта.

FedEx account number: 9-значная учётная запись доставки FedEx, привязанная к проекту.

Rates: Account rates (your negotiated FedEx prices) (по умолчанию) или List rates (FedEx published prices).

Residential delivery: рассчитывать адреса покупателей как жилые (FedEx Home Delivery, надбавка за доставку в жилой дом). Выключите, если вы отправляете в основном организациям. По умолчанию: включено.

Box size: необязательные размеры коробки в единицах измерения размеров вашего магазина, например 30x20x15. Тогда FedEx применяет объёмный вес. Оставьте поле пустым, чтобы рассчитывать только по весу.

FedEx account currency: валюта вашей учётной записи FedEx, например USD для американских учётных записей или CAD для Канады. По умолчанию: USD. Вместе с этим FedEx всегда просят рассчитать стоимость и в валюте магазина.

Exchange rate: нужен, только если FedEx возвращает тарифы лишь в валюте учётной записи, а валюта магазина другая: цена 1 единицы валюты учётной записи в валюте магазина, например 0.92. Без него такие тарифы не используются.

Отправка из

Адрес, с которого FedEx забирает посылки или куда вы их передаёте. Используется для актуальных тарифов.

Country: страна, из которой вы отправляете. По умолчанию: United States.

State / province code: двухбуквенный код, обязателен для США и Канады, например TN, CA или ON.

City: город отправления.

ZIP / postal code: почтовый индекс отправления. FedEx без него не может рассчитать тарифы.

Фиксированные цены

Используются, когда ключи API не введены, а также как резерв, если FedEx не возвращает тариф (API недоступен, неверные ключи, нет подходящей службы). Оставьте оба поля пустыми, чтобы в этом случае скрыть способ.

Country prices: цена в валюте вашего магазина для страны назначения, по одной строке в формате CC=ЦЕНА, например US=12.99 или CA=19,99. Используйте * для любой другой страны, например *=29.99. Строки в другом формате пропускаются, и об этом сообщается при сохранении.

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

Fixed price is: Per order взимает цену один раз. Per item (price x number of items) умножает её на количество товаров. Это относится только к фиксированным ценам. Актуальные тарифы FedEx всегда рассчитываются по общему весу корзины.

Условия

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

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

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

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

Default product weight (kg): вес, который используется для товаров без веса, для тарифов FedEx и для ограничений по весу выше. По умолчанию: 0.5.

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

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

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

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

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

Debug log: записывает запросы к API и расчёт тарифов в WooCommerce > Status > Logs, источник vfd-fedex. Ошибки API записываются всегда. Ключи, токены и адреса покупателей никогда не записываются.

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

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

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

В остальных случаях плагин получает токен OAuth и отправляет в Rate API FedEx адрес отправления, адрес доставки, вес корзины (в кг, а для магазинов, использующих фунты или унции, в фунтах), размер коробки, если он задан, и валюту вашего магазина как предпочтительную. Для стран, где используются почтовые индексы, запрос отправляется только после того, как покупатель введёт индекс. Для международных отправлений передаётся таможенная стоимость корзины. Коды штатов отправляются только для США и Канады.

FedEx возвращает доступные службы. Для каждой службы плагин берёт тариф по учётной записи или публичный тариф, который вы выбрали, предпочитает тариф в валюте вашего магазина, пересчитывает тариф в валюте учётной записи FedEx по вашему курсу и отбрасывает тарифы, которые не может пересчитать. Самая дешёвая служба показывается под названием вашего способа, а её название сохраняется со строкой доставки в заказе.

Токен кэшируется отдельно для каждой среды и ключа и запрашивается заново автоматически, если FedEx его отклоняет. Тарифы кэшируются на 1 час. Неудачный запрос тарифа запоминается на 10 минут, неудачный запрос токена — на 5 минут, чтобы сбой сервиса не замедлял каждое обновление оформления заказа. Таймаут API составляет 15 секунд. Если FedEx не отвечает, покупатель не видит никакой ошибки: используется фиксированная цена или способ скрывается.

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

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

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

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

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

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

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

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

FedEx не появляется при оформлении заказа: проверьте, что лицензия активна, что Enable/Disable включено и способ добавлен в зону страны покупателя (или что Ignore shipping zones включено и страна разрешена). Проверьте предупреждения вверху страницы настроек, ограничения по весу, Minimum subtotal и Excluded shipping classes. Без актуального тарифа способу нужна цена для страны, строка * или Fallback cost.

Актуальные тарифы не появляются: включите Debug log, обновите оформление заказа и откройте WooCommerce > Status > Logs, источник vfd-fedex. Там записываются неверные ключи, неправильная среда (тестовые ключи при выключенном Sandbox или ключи production при включённом) и коды ошибок FedEx.

Мой магазин не в USD: FedEx просят рассчитать тариф в валюте магазина. Если ваша учётная запись возвращает только свою валюту, укажите FedEx account currency и Exchange rate. Без курса обмена такие тарифы игнорируются, и используется фиксированная цена, поэтому сумма в USD никогда не показывается в евро.

Умножает ли «per item» тариф FedEx? Нет. Per item применяется только к фиксированным ценам.

Тарифы выглядят устаревшими после изменения: после смены ключей кэш очищается автоматически. Также можно нажать Clear cached FedEx token and rates.

Нужно предлагать только некоторые службы: разработчики могут ограничить службы с помощью фильтра vfd_fdx_allowed_services.

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

Удаление

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

FedEx — товарный знак его правообладателя. Этот плагин не связан с FedEx и не одобрен компанией FedEx.