Интеграция

Настройка модуля для X-Cart

Версия 1 от 22.10.2019 — История изменений

Для начала работы с модулем необходимо установить модуль из Маркетплейс X-Cart и создать учетную запись в кабинете Чекаута Shiptor.

Автоматически создать учетную запись Чекаута можно в личном кабинете Shiptor или пройдя процедуру регистрации. 

Настройка в кабинете Чекаута для X-Cart 

Заполните вкладку Настройки - Общие согласно инструкции.
    
При регистрации учетной записи на вкладке Настройки > Магазины будет автоматически создана запись в виде магазина для работы с Вашим сайтом.

Модуль для X-Cart будет работать только с магазином выбранным «по умолчанию». 
Нажмите на кнопку «изменить» в настройках магазина «по умолчанию» и заполните : 

•    Тип интеграции — выберите X-Cart
•    Доменное имя — укажите доменное имя Вашего сайта
•    Телефон — укажите контактный номер телефона 
•    Email — укажите email если желаете получать оповещения о событиях с заказами. Опция оповещений включается на вкладке Настройки > Магазины > По умолчанию > Методы доставки > Извещения 
•    Название — укажите название , которое будет отображаться в Кабинете Чекаута для Вашего магазина.

Другие поля на этой вкладке можете проигнорировать. Дальнейшие настройки Кабинета Чекаута для работы с модулем X-Cart будут описаны в соответствующих разделах данной инструкции.

Настройка платформы (магазина)

Для корректной работы модуля необходимо произвести предварительные настройки магазина:

Перейдите Интерфейс > Производительность
Установите: Использовать кэширование виджетов — Выключено 

Перейдите Настройки магазина > Витрина и Оформление заказов
Тип страницы оплаты — Одностраничный

Если в модуле используется автоматическая передача товаров и/или заказов необходимо включить планировщик: 

 

Поля адресной книги и адрес по умолчанию

Перейдите Настройки магазина > Витрина и Оформление заказов > Поля адресной книги
Включите поля обязательные для заполнения с флагом «обязательное»:

  • Имя (firstname)
  • Фамилия (lastname)
  • Страна (country_code)
  • Город (city) 
  • Телефон (phone)
  • Адрес (street) — Если используется составной адрес с отдельными полями для дома и квартиры, то данное поле переименовать в «улица»

При необходимости можете включить/выключить эти необязательные для модуля поля:

  • Область (state_id)
  • Индекс (zipcode)
  • Отчество (patronimic)
  • Дом (house) — устанавливается с модулем (включить флаг «обязательное» если включено)
  • Квартира (apartment) — устанавливается с модулем (включить флаг «обязательное» если включено)

Сохраните изменения. 

Чтобы задать адрес покупателя по умолчанию перейдите Настройки магазина > Витрина и Оформление заказов > Адрес покупателя по умолчанию

Задайте начальные данные по адресу доставки для неавторизованного покупателя.

Обратите внимание, что поле «город» (city) используется в оформлении заказа для определения конечного пункта доставки. Умолчание из этой настройки будет использовано для поиска совпадения в справочнике Shiptor по введенной строке. Поэтому при указании в данном поле в качестве умолчания неуникального населенного пункта модуль не может гарантировать точное определение его местоположения.

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

Для каждого товара должен быть задан уникальный для всего магазина артикул. Чтобы задать артикул товара зайдите Каталог >Товары >Товар >Общее

Рекомендуем максимально заполнить указанные данные по всем товарам в магазине для более точного расчета стоимости доставки. Для этого зайдите Каталог >Товары >Товар >Общее >Доставка

Укажите: 

  • Вес — укажите вес в кг за одну единицу товара. При пустом значении или 0 будутприменяться настройки по умолчанию, заданные в кабинете Чекаута (пример)
  • Требуется доставка — переключатель должен быть в положении «Да»
  • Отправка отдельной посылкой — активно.
  • ДxШxВ — укажите измерения в сантиметрах для 1 шт данного товара. При выключенной опции или 0 значении будут применяться настройки по умолчанию, заданные в Кабинете Чекаута (пример)
  • Макс. кол-во в посылке — всегда должно быть равно 1

 

 

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

Основные настройки модуля.

После успешной установки модуля, регистрации в кабинете Чекаута Shiptor и базовой настройки магазина необходимо настроить модуль.

Откройте Настройки магазина > Служба доставки Shiptor > Основное
Для обмена данными с Shiptor модулю необходима авторизация с помощью двух ключей API. Ключ API Shiptor используется для получения общих данных по доставке, а API Ключ для виджетов — для открытия карты самовывоза и редактора в админпанели.

API Ключи можно скопировать из настроек кабинета Чекаута в разделе Настройки > Общие:  

В открывшейся вкладке введите ключ API Shiptor :

При первичной установке модуля нажмите кнопку «Активировать модуль», при повторной настройке — «Сохранить». При отсутствии или не верном API ключе другие настройки модуля будут не доступны. 

Теперь необходимо ввести API Ключ для виджетов и снова сохранить настройки: 

Показывать сроки доставки — включите для отображения сроков доставки для покупателя на странице оформления заказ. Увеличить отображаемые сроки можно в кабинете Чекаута

Обратите внимание, что параметры заказа (вес и габариты) для получения цен доставки рассчитываются на основании данных в карточке товара и настройки в Кабинете Чекаута:

  • выбрана опция «для посылки» — Вес и габариты заказа ВНЕ зависимости от его состава и данных в карточке товара всегда будут равны умолчаниям в настройке Кабинета Чекаута.
  • выбрана опция «для товара» — Вес и габариты заказа будут рассчитываться в зависимости от кол-ва товаров в посылке на основании данных в карточках товаров и модификаторов их вариантов (если у товара есть опции). Если в карточке товара не заданы вес или какой либо измерение, то для каждой такой единицы товара в расчете будут использованы умолчания из настройки Кабинета Чекаута.

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

Перейдите Настройки магазина > Служба доставки Shiptor > Наложенный платеж и страховка

Если Ваш магазин предоставляет возможность сделать заказ с оплатой при получении (наложенный платеж), то укажите какие способы оплаты считать наложенным платежом. Обратите внимание, что стоимость доставки и доступность методов доставки зависит от способа оплаты и модуль автоматически производит перерасчет цен при его изменении в момент оформления заказа.

Если Ваш магазин разрешает заказы только с онлайн оплатой, то пропустите настройку этой вкладки.

Выберите:

  • Наложенные методы оплаты наличными — выберите из имеющихся в магазине или создайте новый способ оплаты, подразумевающий наложенный платеж наличными средствами.
  • Наложенные методы оплаты картами — выберите из имеющихся в магазине или создайте новый способ оплаты, подразумевающий наложенный платеж через терминал для банковских карт.

После указания типов наложенного платежа сохраните настройки. 

Работа с заказами

Для настройки и передачи заказов в кабинет Чекаута перейдите Настройки магазина > Служба доставки Shiptor > Передача заказов

На этой вкладке Вы можете получить информацию по сформированным покупателями заказам и передать их для дальнейшей обработки в Кабинет Чекаута, а также настроить необходимые условия для передачи.

В таблице заказов отображаются все успешно оформленные в магазине заказы вне зависимости от способа доставки или. Для дальнейшей обработки Вы можете передать в Кабинет Чекаута только заказы оформленные на способ доставки от модуля и соответствующие настроенным условиям для передачи. После успешной передачи заказа в Кабинет Чекаута он больше не будет отображаться в таблице.

Заказ выгружается с товарами и их ценой продажи, услугой доставки и ее ценой в момент оформления, ФИО покупателя, адресом покупателя, email и телефоном.

Доступные поля таблицы:

  • Заказ № - номер заказа в магазине
  • Дата ↑ - дата создания заказа в магазине
  • Статус оплаты     - статус оплаты, актуален для заказов со способом онлайн оплаты на сайте
  • Сумма     - сумма по товарам в заказе
  • Покупатель -    ФИО кокупателя
  • Статус доставки — выбранный способ доставки и установленный в магазине по данному заказу статус доставки. При необходимости Вы можете отредактировать способ доставки — нажмите на кнопку «изменить».     
  • Адрес получателя -    адрес доставки. При необходимости Вы можете отредактировать адрес доставки до передачи в Кабинет Чекаута — нажмите кнопу «Изменить». Обратите внимание, что в случае изменения города доставки набор доступных методов и их стоимость будут отличаться, поэтому желательно произвести перерасчет через кнопку «Изменить» в поле «статус доставки».
  • Ошибка передачи — ошибки препятствующие передаче заказа

Кнопки управления:

Передача заказов в Shiptor в автоматическом режиме:

Если Вам требуется дополнительная обработка заказов в магазине, то Вы можете настроить условия при выполнении которых будет возможна передача заказа в Кабинет Чекаута. Если Вы будете обрабатывать заказы только в Кабинете Чекаута, то пропустите эту настройку.

Передавать заказ с безналичной оплатой в Shiptor только при одновременном выполнении условий:

  • Заказ должен быть оплачен — статус оплаты должен быть «Оплачен»
  • Статус заказа должен быть один из следующих — выберите статус доставки разрешающий передачу в Кабинет Чекаута


Передавать заказ с оплатой наложенным платежом в Shiptor только при условии:

  • Статус заказа должен быть один из следующих — выберите статус доставки разрешающий передачу в Кабинет Чекаута

Выбор статуса заказа в вашей системе после передачи заказа в Shiptor:

  • Статус после успешной передачи заказа в Shiptor — выберите статус, который будет присваиваться заказу после успешной передачи в Кабинет Чекаута
  • Статус после неудачной передачи заказа в Shiptor — выберите статус, который будет присваиваться заказу в случае ошибки при передаче в Кабинет Чекаута


Высылать информацию об ошибках при передаче заказа на email:

  • Адрес электронной почты — укажите адрес электронной почты для сообщений об ошибках, препятствующих передаче заказа в Кабинет Чекаута. Оставьте пустым если Вам не требуется такое отслеживание.

Работа с номенклатурой

Для настройки условий и режима передачи данных по товарам перейдите: Настройки магазина > Служба доставки Shiptor > Передача номенклатуры.

Чтобы в Кабинете Чекаута можно было полноценно редактировать заказы, добавляя в них новые товары ,необходимо своевременно передавать и обновлять данные по номенклатуре товаров из вашего магазина в Shiptor. Передается информация по всему ассортименту товаров в магазине, при этом в Личном Кабинете Shiptor будут созданы новые, ранее не переданные, товары и обновлены имеющиеся. 

При выгрузке данных по товарам создается/редактируется товар в Личном Кабинете Shiptor с данными: Артикул Магазина (Артикул Х-Cart), Артикул Товара (Артикул Х-Cart) , Наименование(Название Х-Cart) , Ссылка на страницу с описанием товара в магазине, Розничная Цена (Цена Х-Cart), Оптовая Цена (Рыночная цена Х-Cart), Вес (Вес Х-Cart ) и Размеры (ДШВ из Отправка отдельной посылкой Х-Cart ).

Полем, по которому в дальнейшем опознаются товары в Shiptor является Артикул Магазина, как указано на скриншоте ниже. При изменении Артикула товара на стороне стороне X-Cart необходимо будет вручную отредактировать номенклатуру в ЛК Shiptor для восстановления потерянной связи.

При выгрузке данных по товарам с опциями (не больше 5) будет сформирован составной идентификатор и наименование как указано на скриншоте. При изменении значения опции на стороне X-Cart необходимо будет вручную отредактировать номенклатуру в ЛК Shiptor для восстановления потерянной связи, т.к. опция является составной частью идентификатора товара.

В Вашем магазине: 

В номенклатуре Shiptor:

Кнопки управления модулем:

  • Передать номенклатуру — нажмите для выгрузки данных по товарам в Shiptor. Обязательно при первой установке, а также при обновлении если выключена автоматическая выгрузка.

Настройка передачи номенклатуры в Shiptor:

  • Передавать изменения в номенклатуре из магазина в Shiptor автоматически — укажите временной интервал для периодической выгрузки новых данных по товарам в магазине. Если автоматическое обновление или планировщик задач выключены, то после каждого изменения товаров используйте кнопку «передать номенклатуру»


Высылать информацию об ошибках при передаче номенклатуры на email:

  • Адрес электронной почты— укажите адрес электронной почты для сообщений об ошибках, препятствующих передаче заказа в Кабинет Чекаута. Оставьте пустым если Вам не требуется такое отслеживание.

Сохраните настройки. 

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

Включение новых профилей доставки, настройка и просмотр производятся централизованно в личном кабинете Чекаута Shiptor в разделе «методы доставки». Вы можете включить необходимые методы и задать сортировку: 

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

Оповещения

Вы можете использовать механизм email рассылки для Вас и покупателей о принятии заказа и передаче его в доставку от системы обработки заказов Чекаут Shiptor.

Подробная инструкция по работе с оповещениями описана в документации Кабинета Чекаута Shiptor.

Работа с логами

Для настройки отслеживания процессов обмена данными в модуле перейдите: Настройки магазина > Служба доставки Shiptor >Лог файлы

Если ошибок в работе модуля не наблюдается и не требуется отладка модуля, то пропустите настройку этой вкладки.
Лог-файлы позволяют получить детальную информацию о том, как работает интеграция с Shiptor.
Например:

  • какие данные габаритов, веса, опций наложенного платежа и страховки отправляются на расчет в Shiptor
  • какой ответ приходит от API Shiptor
  • какие параметры передаются в Shiptor при создании посылки и т.д.

Для лучшего понимания лог-файлов и переменных в них воспользуйтесь документацией Shiptor по API с примерами для разработчиков. 
Для работы с логами укажите:

  • Вести полный лог запросов/ответов Shiptor — включите если требуется фиксировать все процессы обмена данными. При отключении все ранее созданные лог-файлы будут удалены. Не рекомендуем включать на длительное время во избежание чрезмерного увеличения фала в объеме, который займет пространство на хостинге.

Кнопки управления лог-файлом:

  • Скачать — загрузить на компьютер фал лога в формате txt.
  • Анализировать лог — открыть лог в анализаторе для удобного чтения.
  • Удалить — удалить выбранный лог-файл.

История изменений