Сравнение версий

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.
Примечание

Модуль совместим с модулем Главный модуль Битрикса 22 и новее.

Требования к серверу (хостингу) для корректной работы модуля: PHP не ниже версии 8.1.

Предупреждение

При использовании другой версии модуля Главный модуль Битрикса, а также несовместимых версий PHP, корректная работа модуля не гарантируется!

Оглавление

Оглавление

Установка из Маркетплейса

  1. Перейти по ссылке
  2. Нажать кнопку Установить, ввести адрес сайта, нажать Установить
    Раскрыть
    titleпоказать скриншот

    Image Added

  3. В админке сайта нажать Загрузить, принять лицензионное соглашение, нажать Установить, модуль установлен. 
    Раскрыть
    titleПоказать скриншоты

    Image AddedImage Added

Установка из архива

  1. Авторизоваться на Вашем сайте с доступом администратора.
  2. Проверить кодировку вашей установки Bitrix, нажать на клавиатуре Ctrl + U
  3. В открывшейся вкладке вы увидите кодировку, она может быть windows-1251, либо UTF-8
    Раскрыть
    titleПоказать скриншот

     

  4. Скачать модуль для кодировки windows-1251 | Скачать модуль для кодировки UTF-8
  5. В админке магазина перейти в Контент/Файлы и папки в поле Путь указать /bitrix/modules, нажать ОК 
    Раскрыть
    titleПоказать скриншот

  6. Нажать Загрузить файл, затем Добавить файл - выбрать скачанный ранее архив, нажать Сохранить
    Раскрыть
    titleПоказать скриншоты

  7. В меню напротив файла нажать кнопку Действия, нажать Распаковать, еще раз нажать Распаковать
    Раскрыть
    titleПоказать скриншот

  8. В меню админки перейти в Marketplace/Установленные решения, нажать на меню действий загруженного модуля, нажать Установить. Модуль установлен.
    Раскрыть
    titleПоказать скриншот

...

Настройки службы доставки

ВкладкаНаименование настройкиОписание настройки

Основные

API токенЗдесь указывается API токен из ЛК Boxberry для работы модуля, указанный токен проверяется по клику вне поля, при наличии ошибки отображается её текст из ЛК Boxberry, деактивируются кнопки Сохранить/Применить.
Тестовый режимПри активации служба доставки будет использовать для работы тестовый токен. Опция будет полезна для проверки работы службы доставки или при отсутствии API токена. При включении тестового режима указание API токена не требуется.

Заказы

Помечать заказ оплаченным при успешной выдачеЕсли статус заказа в api Boxberry сменяется на Успешно выдан в битриксе заказу проставляется отметка Оплачен, удобно использовать для заказов с наложкой.
Тип выдачи заказа по умолчаниюПри создании заказа по api модуль будет передавать выбранный тип выдачи, по умолчанию используется тот, что выбран в ЛК Boxberry в разделе Услуги. В каждом заказе можно поменять тип выдачи через форму редактирования.
Пункт приема заказа по умолчаниюПункт приема, в который сдаются заказы для отправки. Используется в расчете стоимости доставки и в создании заказа. В каждом заказе можно поменять пункт приема через форму редактирования.
Префикс к номеру заказаВведенное значение будет добавляться к номеру заказа при создании заказа.

Вес, габариты, места

(В этой группе настроек размещены настройки габаритов и веса, которые применяются если в свойстве товара эти значения не указаны либо равны 0)

Применить вес и габариты по умолчанию кЕсли выбрано к заказу, вес и габариты заказа, указанные в опциях выше всегда будут постоянными, независимо от количества товара в заказе. Создается только 1 место. Если выбрано к 1 товару вес и габариты по умолчанию будут применяться на каждый товар в заказе (если вес/габарит товара не заполнен или 0), будут создаваться места с авторазбивкой по лимитам веса/габаритов.

Индексы

(Этот раздел будет со временем дополнятся другими опциями)

Проверять почтовый индекс для расчета курьерской доставкиИндекс переданный битриксом будет передаваться в api запрос калькуляции стоимости доставки для расчета более точной цены, деактивировано по умолчанию т.к. далеко не все индексы Битрикса совпадают с существующими индексами службы доставки Boxberry, рекомендуется активировать только при наличии ошибок в расчете стоимости курьерки.

Наложенный платеж


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

Соответствие свойств заказа


В этой группе настроек нужно указать соответствие полей заказа в Boxberry символьным кодам свойств в Битриксе. Символьный код свойства в Битриксе можно найти в разделе Магазин/Свойства заказа/Список свойств. Если у вас есть несколько плательщиков для них нужно задать одинаковый код свойства и указать его в настройке. Два последних поля Контактное лицо и Название компании предназначены для юр лиц.

Если вы используете составные свойства ФИО или Адрес выберите соответствующую раздельную настройку и укажите существующие коды свойств.

Оформление заказа

Не разрешать оформление заказа без выбора ПВЗ

При активации не позволяет покупателю оформить заказ на самовывоз, если пункт выдачи не выбран. Код ПВЗ обязательно требуется при создании заказа в ЛК поэтому опция активна по умолчанию.

Блокировать от изменений поле адреса ПВЗ при выборе самовывоза

Если активно, блокирует от изменений поле с адресом, т.к. иногда покупатели стирают адрес выбранного ПВЗ и пишут свой адрес. Активно по умолчанию.

Добавить кнопку виджета по умолчанию

Следующие 5 настроек предназначены для размещения кнопки открытия виджета с выбором ПВЗ на странице оформления заказа. Активна может быть только 1 из 5-ти опций одновременно. Если у вас есть проблемы с опцией по умолчанию, пробуйте переключать другие опции, возможно проблема решится. Эти опции добавлены как возможное решение проблемы без необходимости править код. Если не включить ни одну из опций кнопка открытия виджета не будет отображаться.





Добавить кнопку виджета к описанию службы доставки
Добавить кнопку виджета после описания службы доставки
Добавить кнопку виджета к сроку доставки
Добавить кнопку виджета к элементу (Укажите id элемента)

Профили

 

В данном разделе можно добавить необходимые профили службы доставки.

Ограничения

 

В данном разделе можно добавить необходимые, встроенные в битрикс, ограничения для службы доставки, 

Кнопка "Обновить данные"

Кнопка Обновить данные открывает выпадающий список с вариантами обновления. Выбираете какие данные нужно обновить, жмете на них, выполняется api запрос в ЛК Boxberry, затем данные обновляются в таблицах в БД битрикса. Если api запрос вернет ошибку, её текст отобразится в окошке обновления.

Примечание

Все данные обновляются автоматически через агент фоновым заданием ежедневно. Города обновляются раз в сутки, пункты приема раз в 6 часов. 

Этот вариант обновления "вручную" добавлен на случай возникновения непредвиденных ошибок, не нужно выполнять обновление без необходимости.

Раскрыть
titleПоказать скриншот

Image Modified

Image Modified

Image Modified

Кнопка "Очистить кеш"

Модуль хранит кеш селективно, что позволяет очищать не весь кеш битрикса целиком, а только определенные данные самого модуля.

Кеш api запросов хранится в папке /bitrix/cache/bb_api/ + название api метода, кеш найденных местоположений хранится в папке /bitrix/cache/bb_locations.

Примечание
Если в настройках интеграции в ЛК  изменяете настройки со вкладки Скрывать ПВ или Расчеты нужно очистить кеш Настройки виджета и Калькулятор.

В других случаях очистку кеша производите на свое усмотрение. 

Раскрыть
titleПоказать скриншот

Image Modified

Настройки профиля доставки

...

ВкладкаНаименование настройкиОписание настройки

Общие настройки

Укажите код свойства артикула товараПо умолчанию указан код свойства ARTNUMBER. Настройка позволяет передавать артикулы у вложений в заказе, если указанный код свойства не будет найден передается Id товара.

Якорь
add_bb_button_to_all_orders_descr
add_bb_button_to_all_orders_descr
Отображать кнопку создания заказа в Boxberry для всех заказов в админке

Если активно, в просмотре любого заказа будет отображаться кнопка Доставка Boxberry, кнопка отображает удобную форму для создания и редактирования данных в отправке, если не активно отображается только в заказах со службой доставки Boxberry.
Выберите статус заказа для выгрузкиПри наступлении указанного статуса заказы будут выгружаться в ЛК Boxberry.
Добавлять трек номер в поле "Идентификатор отправления" при создании заказа в ЛКДобавляет треки в идентификатор отправления после выгрузки заказа в ЛК. По умолчанию активно.

Настройки статусов

Включить синхронизацию статусов

Активирует агента (фоновое задание) для синхронизации статусов Boxberry со статусами в Битриксе, что позволяет автоматически двигать заказы по статусам. 


Далее следует соответствие статусов, статусы свои у каждого магазина. Необязательно выбирать соответствие каждому, те что не нужны можно не настраивать, они не будут обрабатываться.
Количество заказов, обрабатываемых за 1 запускЕсли заказов слишком много и агент не забирает на обработку все нужные заказы с настройкой по умолчанию, количество можно увеличить.
Интервал запуска агентаЗдесь можно изменить интервал запуска.
Количество дней с последнего обновления заказа, на которые запрашиваются статусыПозволяет исключить из обработки заказы, статус которых не менялся указанное количество дней.
Помечать заказ оплаченным при успешной выдачеЕсли активно, то при смене статуса заказа на "Успешно выдан", статус оплаты заказа будет изменён на "Оплачен".

Отладка и логирование

Записывать ошибки модуля в журнал событийПозволяет записывать все ошибки в штатный Журнал событий Битрикса (Настройки/Инструменты/Диагностика/Журнал событий). По умолчанию отключено.
Выводить в консоль данные для отладкиВыводит отладочную информацию в консоль браузера. Работает в оформлении заказа, в службе доставки, создании заказа в админке.
Логировать запросы к апиЗаписывает все api запросы/ответы запросы в файл с расширением .log
Размер лог-файла API запросовЛимит размера файла для логов, в мегабайтах.
Пусть к лог-файлу API запросовПуть создания файла с логами, модуль создает только файл, убедитесь что указанная папка существует.

Доступ

 Стандартная для всех модулей настройка прав доступа.

Обновление модуля

 

Модуль предлагает встроенную систему обновлений. В этом случае дистрибутивы обновлений загружаются с сервера Boxberry bitrix.boxberry.ru

После загрузки архива выполняется штатный процесс обновления, как если бы модуль обновляли через Marketplace. Данная система, возможно, временная, пока модуль не добавлен в Marketplace Битрикса.

Нужно нажать на кнопку Проверить обновление, если оно доступно отобразится номер версии и кнопка Обновить модуль. Нажимаете на нее и модуль обновится. Весь процесс занимает несколько секунд.

Сервисы

 

Раздел предназначен для подключения сторонних сервисов для работы с модулем.

На данный момент доступна только активация использования доступно только указание своего токена для сервиса DaData и указание своего токена.   Это необязательно, но добавлено на случай исчерпания лимита по встроенному в модуль токену. В этом случае пользователь может зарегистрировать аккаунт в сервисе DaData  и добавить в настройку свой токен. Бесплатный лимит запросов в сервисе 10000 запросов в сутки. С учетом того, что модуль кеширует результат запроса на сутки и редких обращений к сервису, этого количества должно хватить более чем.

В дальнейшем данный раздел будет дополняться другими сервисами.

...

Примечание
Функционал редактирования будет доступен в заказах с любой службой доставки при активации этой опции  в настройках модуля. Иначе функционал доступен только в заказах со службой доставки Boxberry.
Подсказка
В тулбаре с действиями вверху добавляется кнопка Доставка Boxberry, по нажатию на которую открывается форма для редактирования данных заказа. Повторное нажатие скрывает форму.

Пример заказа, оформленного со службой доставки Boxberry:

...

Блок кода
languagephp
themeMidnight
linenumberstrue
Boxberry\Bitrix\Agents\Tracking::syncStatuses();

События модуля

onBeforeGetWeights - позволяет менять массив мест перед выгрузкой заказа в ЛК. Пример работы.

Метод обработчик получает объект \Bitrix\Main\Event содержащий два параметра:

  • orderId -  id заказа в Битриксе
  • boxes - массив мест в заказе, его можно изменять

Таблицы модуля 

Модуль создает 3 таблицы в БД при установке

...

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

Вы получите доступ как к опциям профиля доставки, так и к опциям службы доставки - родителя профиля.

...

Блок кода
languagephp
themeMidnight
linenumberstrue
\Bitrix\Main\Loader::includeModule('boxberry.delivery');

$bbCity = \Boxberry\Bitrix\CitiesFullTable::getBbCityByBitrixLocationCode('0000073738'); // 0000073738 - Москва, код города в Битриксе

echo '<pre>';
print_r($bbCity);
echo '</pre>';


Изменение мест в заказе
Якорь
onBeforeGetWeightsDescription
onBeforeGetWeightsDescription

Регистрируем обработчик события onBeforeGetWeights, затем, для примера, меняем вес у первого места

Блок кода
languagephp
themeMidnight
linenumberstrue
use Bitrix\Main\EventManager;

//Регистрация обработчика
$eventManager = EventManager::getInstance();
$eventManager->registerEventHandler(
    'boxberry.delivery',
    'onBeforeGetWeights',
    'boxberry.delivery',
    '\Boxberry\Bitrix\Entity\Order',
    'modifyPlaces'
);

// Метод-обработчик события в классе \Boxberry\Bitrix\Entity\Order

public static function modifyPlaces(Event $event): void
{
    $boxes = $event->getParameter('boxes');
    $boxes[0]['Weight'] = 1301;
    $event->setParameter('boxes', $boxes);
}


Запуск агентов

Запуск агента синхронизации статусов заказов

...