Документация

Массив данных населённого пункта (куда доставляем).

Содержит:

• $order.properties.eshoplogistic3_data.settlement.name - название населённого пункта
• $order.properties.eshoplogistic3_data.settlement.fias - ФИАС-код населённого пункта
• $order.properties.eshoplogistic3_data.settlement.name - регион

Массив данных выбранной ТК.

Содержит:

• $order.properties.eshoplogistic3_data.service.code - код службы доставки
• $order.properties.eshoplogistic3_data.service.name - название службы доставки

Массив данных по стоимости.

Содержит:

• $order.properties.eshoplogistic3_data.price.value - стоимость доставки
• $order.properties.eshoplogistic3_data.price.unit - единица измерения стоимости доставки

Массив данных по стоимости.

Содержит:

• $order.properties.eshoplogistic3_data.time.value - срок доставки
• $order.properties.eshoplogistic3_data.time.unit - единица измерения срока доставки
• $order.properties.eshoplogistic3_data.time.text - расширенное текстовое представление срока доставки (например, «в воскресенье (26 марта)»

Массив данных с комментариями (если заданы в настройках данной ТК в каюинете eShopLogistic).

Содержит:

• $order.properties.eshoplogistic3_data.comments.service - комментарий для данной ТК
• $order.properties.eshoplogistic3_data.comments.type - комментарий для данного типа доставки

Массив данных о выбранном тарифе ТК (если передаётся данной ТК).

Содержит:

• $order.properties.eshoplogistic3_data.tariff.code - код тарифа
• $order.properties.eshoplogistic3_data.tariff.name - наименование тарифа

Если доставка до ПВЗ/постамата.

Содержит полную информацию о выбранном ПВЗ/постамате. Обязательно присутствуют:

• $order.properties.eshoplogistic3_data.terminal.code - код
• $order.properties.eshoplogistic3_data.terminal.name - название
• $order.properties.eshoplogistic3_data.terminal.address - адрес
• $order.properties.eshoplogistic3_data.terminal.phones - телефоны
• $order.properties.eshoplogistic3_data.terminal.workTime - время работы
• $order.properties.eshoplogistic3_data.terminal.lon - долгота
• $order.properties.eshoplogistic3_data.terminal.lat - широта
• $order.properties.eshoplogistic3_data.terminal.is_postamat - флаг: является ли данный ПВЗ постаматом

Содержит общую информацию о заказе на доставку (если заказ выгружен в ЛК перевозчика):

• $order.properties.eshoplogistic3_data.order.id - идентификатор заказа в системе ТК (обязательно присутствует)
• $order.properties.eshoplogistic3_data.order.cost - фактическая стоимость доставки (на момент текущего статуса заказа, может отличаться от расчётной)
• $order.properties.eshoplogistic3_data.order.tracking - ссылка на отслеживание заказа (может отсутствовать)
• $order.properties.eshoplogistic3_data.order.print - ссылка на печать этикеток (может отсутствовать)

Содержит полную информацию о текущем статусе заказа на доставку (если заказ выгружен в ЛК перевозчика). Обязательно присутствуют:

• $order.properties.eshoplogistic3_data.order.state.status.code - код статуса в системе eShopLogistic
• $order.properties.eshoplogistic3_data.order.state.status.description - описание статуса в системе eShopLogistic
• $order.properties.eshoplogistic3_data.order.state.service_status.code - код статуса в системе ТК
• $order.properties.eshoplogistic3_data.order.state.service_status.description - описание статуса в системе ТК

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

• Добавьте к нужному API-ключу виджет c типом «По кнопке в сплывающем окне» . Домен сайта указывать без «http / https».
• Ключ виджета находится на вкладке «Подключение на сайте» настройки виджета .

Доступные варианты:

• 0 - запись всех запросов
• 1 - только запросы на расчёт стоимости доставки
• 2 - запросы на расчёт стоимости, без пунктов самовывоза (их может быть очень много)

Максимальный размер файла лога - 1Mb; при превышении автоматически очищается.

Создайте отдельный виджет и укажите здесь его ключ.

• Добавьте к нужному API-ключу виджет c типом «Специальный для корзины» . Домен сайта указывать без «http / https».
• Ключ виджета находится на вкладке «Подключение на сайте» настройки виджета .

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

Если используется стандартный чанк оформления заказа (входит в комплект - tpl.eshoplogistic3.cart), этот блок здесь: .

Указать идентификаторы методов оплаты MS2, через запятую. Например: 2,3,4

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

Указать секретные коды виджетов, которые используются для отправки заказа, через запятую.

Виджеты для карточки товара (типы «По кнопке в сплывающем окне» и «Встраиваемый в страницу») могут отправлять заказы с учётом выбранного пользователем варианта доставки (т.е. «заказ в 1 клик», но уже с доставкой).

Создайте нужные виджеты укажите здесь его секретные коды, это необходимо для регистрации заказов из виджета в MS2.

• Добавьте к нужному API-ключу виджет c типом «По кнопке в сплывающем окне» или «Встраиваемый в страницу» .
  Домен сайта указывать без «http / https».
• Секретный код виджета находится на вкладке «Подключение на сайте» настройки виджета .

Включить выгрузку заказов в кабинет службы оставки.

На вкладке «Доставка» при редактировании заказа появятся кнопки выгрузки заказа и печати этикеток (если выгрузка заказа доступна для данной службы доставки).

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

Включить автоматическую выгрузку заказов в кабинет службы оставки.

Будет произвидится попытка выгрузки заказа при переходе в статус, указанный в параметре «Статус заказа для начала автоматической выгрузки».

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

Укажите идентификатор статуса заказа при переходе на который будет выполнена попытка выгрузки заказа в кабинет службы оставки

Укажите идентификатор статуса заказа при успешной выгрузке в кабинет службы оставки

Укажите стандартный вес товаров в заказе; если не указан, будет взято стандартное значение веса товара

Укажите стандартные габариты товаров в заказе в формате «Д*Ш*В» в сантиметрах.
Например: 25*15*10

Если «Да», то указанные в параметрах «Вес товаров в заказе по умолчанию» и «Габариты товаров в заказе по умолчанию» значения веса и габаритов учитываются для каждой единицы товара.
Если «Нет» для всего заказа. При этом весь заказ будет сформирован из одного товара с именем, указанным в параметре «Название товара в заказе».

Если параметр «Применять дефолтные параметры к каждой единице товара» = "Нет", то вместо товаров в заказе будет указан 1 товар с данным названием.
Например: «Канцтовары».

Указать «Да», если транспортная компания забирает груз своими силами.

Идентификатор статуса оплаты minishop2 для варианта «Заказ уже оплачен»

Идентификатор статуса оплаты minishop2 для варианта «Наличными при получении»

Идентификатор статуса оплаты minishop2 для варианта «Картой при получении»

Варианты: «1» - интернет-магазин, «2» - обычная доставка.

Варианты: A4, A5, A6; по умолчанию A4.

Варианты: «0» - Посылка, «2» - Курьер Онлайн, «3» - Посылка Онлайн, «5» - Посылка 1й класс.

Варианты: «0» - упаковка магазина, «2» - упаковка Boxberry.

Пример:

switch ($modx->event->name) {
    case 'eShopLogistic2OnGetOffers':
        if(!empty($offers)) {
            foreach($offers as $offer) {
                // можно изменить при необходимости:
                // цену/количество/вес/габариты
                // ...
            }
        }
        $modx->event->output(['new_offers' => $offers]);
        break;
}

Например, добавим кастомный параметр для срабатывания правила.

# подключите класс eshoplogistic3, если добавляете код в отдельном плагине
# также в этом случе можно убрать конструкцию switch/case
# $eshoplogistic3 = $modx->getService('eshoplogistic3', 'eshoplogistic3', $modx->getOption('core_path') . 'components/eshoplogistic3/model/eshoplogistic3/', $scriptProperties ?? []);

switch ($modx->event->name) {
    case 'eshoplogistic3OnBeforeAPIQuery':
        if($method == 'widget/calculation' && isset($data)) {
            if(is_array($data)) {
                # флаг доставки из Москвы - на него в кабинете eShopLogistic настроено правило
                $params = ;
                $data['params'] = json_encode($params);
                $modx->event->output(['data' => $data]);
            }
        }
    break;
}

Например, изменим срок доставки, если в запросе есть товар с id=13:

# подключите класс eshoplogistic3, если добавляете код в отдельном плагине
# также в этом случе можно убрать конструкцию switch/case
#$eshoplogistic3 = $modx->getService('eshoplogistic3', 'eshoplogistic3', $modx->getOption('core_path') . 'components/eshoplogistic3/model/eshoplogistic3/', $scriptProperties ?? []);

switch ($modx->event->name) {
    case 'eshoplogistic3OnAfterAPIQuery':
        $product_id = 13;
        if($method == 'widget/calculation' && isset($query_data['offers'])) {
            if($response['http_status'] == 200) {
                if($offers = json_decode($query_data['offers'], 1)) {
                    if(is_array($offers)) {
                        if(isset($offers[$product_id])) {
                            foreach(['terminal', 'door'] as $mode) {
                                if(!empty($response['data'][$mode]['time']['value'])) {
                                    $response['data'][$mode]['time']['value'] += 10;
                                    $response['data'][$mode]['time']['unit'] = $eshoplogistic3->units($response['data'][$mode]['time']['value']);
                                    $response['data'][$mode]['time']['text'] = $eshoplogistic3->dateToText($response['data'][$mode]['time']['value'], $response['data'][$mode]['time']['unit']);
                                }
                            }
                        }
                    }
                }
            }
        }

        $modx->event->output(['response' => $response]);
    break;
}

Пример:

switch ($modx->event->name) {
    case 'eshoplogistic3BeforeUnloadOrder':
        $query_data['sender']['company'] = 'Название компании';
        $modx->event->output(['query_data' => $query_data]);
        break;
}

Пример:

switch ($modx->event->name) {
    case 'eshoplogistic3UnloadOrder':
        $modx->log(1, print_r($response, 1));
        // в зависимости от ответа можно что-то делать; например изменить статус заказа, отправить уведомление и т.п.
        break;
}

Пример:

switch ($modx->event->name) {
    case 'eshoplogistic3OnGetOrderStatus':
        //$modx->log(1, print_r($response, 1));
        // в зависимости от ответа можно что-то делать; например изменить статус заказа:
        if(isset($status['new'])) {
            if($status['new'] == 'taken') {
                $miniShop2 = $this->modx->getService('miniShop2');
                $miniShop2->changeOrderStatus($order->id, 5);
            }
        }
        break;
}

Документация по запросу получения заказа на доставку смотрите в официальной документации .