Swagger API Личный кабинет Центр поддержки

Модуль RetailCRM #

Список возможностей #

  • Регистрация заказа в службе доставки.
  • Редактирование заказа.
  • Отмена заказа.
  • Расчет стоимости доставки.
  • Печать документов.
  • Два режима работы модуля (подробнее)

Установка #

Для подключения модуля ApiShip необходимо создать Ключ API в RetailCRM.

У Ключа API должны быть права на:

  1. Получение списка типов доставки (/api/reference/delivery-types).
  2. Добавление\редактирование типа доставки (/api/reference/delivery-types/{code}/edit).
  3. Обновление статусов заказа (/api/delivery/generic/{code}/tracking).
  4. Получение настроек модуля (/api/integration-modules/{code}).
  5. Добавление\редактирование модуля (/api/integration-modules/{code}/edit).
  6. Получение списка типов оплаты (/api/reference/payment-types).
  7. Получение списка статусов доставки (/api/reference/statuses).
  8. Получение списка складов (/api/reference/stores).

После создания Ключа API необходимо зарегистрироваться в личном кабинете ApiShip.

Далее нужно в маркетплейсе RetailCRM выбрать модуль доставки ApiShip и нажать “Подключить”.

В Личном кабинете нужно будет заполнить настройки модуля, выбрать режим интеграции и нажать “Подключить” (вас перенаправит назад в RetailCRM).

img

Подключение дополнительных модулей (аккаунтов) #

В ApiShip также поддерживается мультиаккаунтинг. Если у Вас есть несколько аккаунтов в RetailCRM, для каждой можно создать модуль.

img

Список интеграций #

У созданного модуля есть список созданных интеграций в RetailCRM.

img

Настройка интеграции #

Каждую интеграцию можно редактировать и выключать.

img

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

Редактирование интеграции.

img

Поля:

  • Описание интеграции - описание интеграции, которое выводится в списке интеграций модуля и на странице модуля RetailCRM.
  • Название поля этикетки - название поля, которое выводится в RetailCRM в разделе Заказ\Управление\Печать\{название_поля} при печати документов заказа.
  • Название поля накладной - название поля, которое выводится в RetailCRM в разделе Заказ\Управление\Печать\{название_поля} при печати документов заказа.
  • Плательщик за доставку по умолчанию - отправитель или получатель.
  • Нулевая объявленная стоимость по умолчанию - при активном значение, объявленная стоимость заказа не передается в СД.
  • Учитывать при калькуляции комиссию за налож. платеж и страховку
  • По умолчанию не отправлять данные в СД - при активном значение, по нажатию кнопки “Сохранить” в заказе, данные не передаются в СД.

Только для прямого режима интеграции!
Есть 2 дополнительных поля:

  • Название интеграции - название интеграции, которое выводится в списке интеграций модуля и на странице модуля RetailCRM.
  • URL логотипа - URL адрес изображение, которое отображается вместо базового логотипа ApiShip.

Режим интеграции #

Модуль поддерживает 2 режима интеграции:

  1. Режим “Агрегатор” - в RetailCRM устанавливается один модуль, работающий со всеми подключенными службами доставки.
  2. Режим “Прямой” - в RetailCRM устанавливается отдельный модуль на каждое существующее подключение к службам доставки. Например, если в аккаунте создано 2 подключения к СДЭК и 1 к DPD, то в RetailCRM установится 3 модуля.

Обновить список интеграций #

Только для прямого режима интеграции!
Если в аккаунте было создано новое подключение к СД и на его основе нужно создать интеграцию в RetailCRM. Нужно зайти в настройки модуля и нажать кнопку “Обновить”.

Дополнительные настройки интеграции #

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

В настройках модуля во вкладке “Настройки интеграции по умолчанию” можно определить глобальные настройки, которые будут использоваться в новых созданных интеграциях. Например, включен прямой режим модуля и он имеет 5 интеграций, то эти интеграции будут использовать настройки по умолчанию и не надо будет для каждой настраивать одно и то же.

img

Для каждой интеграции можно переопределить настройки по умолчанию. Например, включен прямой режим модуля и он имеет 5 интеграций и в какой-то одной нужно отключить тип оплаты наличными.
В настройках интеграции во вкладке “Расширенные настройки” нужно убрать галку “Использовать настройки по умолчанию” и настроить интеграцию по необходимым требованиям.

img

Настройка доставки #

По умолчанию модули считают тарифы “Дверь-{Терминал,Дверь}”.

В форме создания заказа в RetailCRM можно указать терминал отгрузки. Тогда будут рассчитаны тарифы “Терминал-{Терминал,Дверь}”.

img

В расширенных настройках интеграции можно указать терминал отгрузки по умолчанию.Тогда всегда будут рассчитываться тарифы “Терминал-{Терминал,Дверь}”.

img