VibeFox ShipStation for WooCommerce — Помощь

Требования

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

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

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

Учётная запись ShipStation: подключите перевозчиков в ShipStation (Settings > Shipping > Carriers), затем скопируйте API Key и API Secret из раздела ShipStation > Settings > Account > API Settings. Доступ к API зависит от вашего тарифного плана ShipStation. Если страница недоступна, ваш план не включает доступ к API. Плагин использует ShipStation API V1 (API Key и API Secret). Учётные записи ShipStation API V2 с одним API-ключом не поддерживаются. Без ключей используются только резервные цены.

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

Установка

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

2. Нажмите Activate.

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

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

5. Вставьте API Key и API Secret, укажите почтовый индекс отправления и сохраните. Страница покажет коды перевозчиков вашей учётной записи. Введите нужные в Carrier codes и сохраните ещё раз.

6. Если валюта вашего магазина отличается от валюты учётной записи ShipStation, задайте Exchange rate.

7. По желанию заполните резервные цены.

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

Настройка

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

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

Каждый раз при сохранении настроек очищается кэш тарифов ShipStation и проверяются API Key и API Secret. Затем страница показывает перевозчиков, подключённых к вашей учётной записи, с их кодами, например "stamps_com (Stamps.com), ups_walleted (UPS by ShipStation)". Предупреждения над настройками сообщают, когда тарифы в реальном времени не могут работать: нет ключей, нет кода перевозчика, нет почтового индекса отправления, нет курса обмена, не прошла проверка подключения или коды перевозчиков не подключены к вашей учётной записи.

Общие

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

Name: название способа доставки, которое видит покупатель при оформлении. Зона может заменить его своим Title. По умолчанию: ShipStation Shipping.

Учётная запись ShipStation

API Key: API Key из раздела ShipStation > Settings > Account > API Settings.

API Secret: API Secret с той же страницы.

Carrier codes: один или несколько кодов перевозчиков ShipStation через запятую, например stamps_com, ups_walleted. Используется до 5 кодов, с одним запросом к API на каждого перевозчика. Показывается самый дешёвый тариф этих перевозчиков. Коды берите из списка, который появится после сохранения.

Allowed services: необязательно, коды служб ShipStation через запятую, например usps_priority_mail, ups_ground. Оставьте поле пустым, чтобы показывать самую дешёвую службу перевозчиков, указанных выше.

Package code: "package" (по умолчанию) рассчитывает тариф для вашей собственной коробки и исключает конверты перевозчика и коробки с фиксированным тарифом. Оставьте поле пустым, чтобы рассчитывать тарифы для всех типов упаковки, которые предлагает перевозчик.

Отправление из

Ship-from postal code: обязателен для тарифов в реальном времени. ShipStation рассчитывает тарифы только по почтовому индексу, и он должен находиться в стране вашей учётной записи ShipStation. Оставьте поле пустым, чтобы использовать почтовый индекс магазина из WooCommerce > Settings > General.

Тарифы

Parcels: как корзина отправляется в ShipStation.

ShipStation account currency: валюта, в которой ShipStation возвращает тарифы: USD, CAD, GBP, AUD, NZD или EUR. По умолчанию: USD (американские учётные записи).

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

Tax status: Taxable позволяет WooCommerce начислять налог на доставку по вашим налоговым правилам, None не начисляет. Тарифы ShipStation не включают налог с продаж.

Резервные цены (используются, когда нет тарифа в реальном времени: нет API-ключей, ShipStation недоступен или перевозчики не дали тарифов для адреса; цены в валюте вашего магазина; оставьте таблицу и Other countries пустыми, чтобы в этом случае скрыть способ)

Prices by country: таблица с базовой ценой для каждой страны и колонками размеров по весу посылки: XS ≤1 kg, S ≤2 kg, M ≤3 kg, L ≤5 kg и XL >5 kg. Нажмите + Add country, чтобы добавить строку, и на крестик, чтобы удалить её. Пустой размер использует базовую цену. Базовая цена 0 означает бесплатную доставку. Строка * Default (all other countries) применяется к странам без собственной строки.

Other countries: цена, если в таблице нет цены для страны. Оставьте поле пустым, чтобы в этом случае скрыть способ.

Условия

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

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

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

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

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

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

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

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

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

Debug log: записывает запросы к ShipStation в WooCommerce > Status > Logs, источник vfd-shipstation. Ошибки API записываются всегда, даже когда эта опция выключена. API Key, API Secret и адреса покупателей никогда не записываются в журнал. Почтовый индекс маскируется.

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

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

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

Затем плагин отправляет в ShipStation почтовый индекс отправления, страну назначения, регион, город и почтовый индекс назначения, вес посылки и размер коробки. Запрос не отправляется, пока покупатель не введёт почтовый индекс. Страны без почтовых индексов получают резервные цены. Веса и размеры пересчитываются из единиц вашего магазина. Товары укладываются в одну коробку. Если у товара нет размеров, посылка рассчитывается только по весу.

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

Каждый ответ кэшируется на 1 час. Если ShipStation отвечает без пригодного тарифа, ответ запоминается на 10 минут. Если ShipStation отклоняет ключи или недоступен, запросы приостанавливаются на 5 минут. После лимита запросов пауза соответствует времени сброса, которое указал ShipStation. Таймаут запроса — 12 секунд. Деактивация плагина очищает кэш тарифов.

Если тарифа в реальном времени нет, цена берётся из таблицы резервных цен, а затем из поля Other countries. Если ничего из этого не применимо, способ скрывается. Покупатель никогда не видит текстов ошибок ShipStation. Подробности записываются в журнал WooCommerce.

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

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

Заказы

Строка доставки заказа сохраняет выбранную Service, например "USPS Ground Advantage - Package". Вы видите её на экране заказа в админке и можете создать соответствующую этикетку в ShipStation.

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

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

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

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

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

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

ShipStation не появляется при оформлении заказа: проверьте, что лицензия активна, что Enable/Disable включено и способ добавлен в зону страны покупателя (или что включено Ignore shipping zones и страна разрешена). Проверьте ограничения по весу, Minimum subtotal и Disabled shipping classes. Без тарифа в реальном времени проверьте, что для страны, * Default или Other countries задана цена.

При оформлении заказа показывается резервная цена вместо тарифа ShipStation: проверьте предупреждения вверху страницы настроек (ключи, код перевозчика, почтовый индекс отправления, курс обмена). Включите Debug log и откройте WooCommerce > Status > Logs, источник vfd-shipstation. Нужен почтовый индекс покупателя. Запрос не отправляется, пока он не введён.

Какой код перевозчика ввести: сохраните настройки с ключом и секретом. Страница покажет коды перевозчиков вашей учётной записи. Используйте один или несколько из них.

Тариф отличается от ShipStation: посылка формируется из весов и размеров товаров, со всеми товарами в одной коробке. Товары без размеров рассчитываются только по весу. Тарифы кэшируются на 1 час. Сохраните настройки, чтобы очистить кэш.

Для разработчиков: фильтры vfd_shst_rate_request, vfd_shst_selected_rate и vfd_shst_api_url изменяют запрос тарифа для каждого перевозчика, выбранный тариф и базовый URL API.

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

Удаление

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

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