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

Настройка модуля #

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

img

Основные настройки #

img Необходимо получить API-токен в ЛК ApiShip, на главной странице.

img

img

Название модуля доставки - необязательное поле для названия модуля.

customCode для калькулятора тарифов - возможность задать код, с помощью которого, будет идентифицироваться этот ИМ в редакторе тарифов.

Добавить в доставку комиссию ТК - будет ли учтена комиссия за наложенный платеж и страховку в стоимость доставки.

Все ПВЗ на одной карте - возможность отображать ПВЗ на одной карте.

Шаблоны #

img

Заголовок пунктов модуля доставки - настраиваемый шаблон, который определяет, как будет выводиться информации о ПВЗ. Добавлена возможность отображать иконку (логотип) и ссылку. Для этого в шаблон описания написать %logo и %link соответственно и выбрать Скрыть выбор ПВЗ. По умолчанию используется старый вывод.

Заголовок курьера модуля доставки - настраиваемый шаблон, который определяет, как будет выводиться информации тарифов до двери (курьерские). Добавлена возможность отображать иконку (логотип) и ссылку. Для этого в шаблон описания написать %logo и %link соответственно. По умолчанию используется старый вывод.

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

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

Адрес отправления #

img Адрес склада, откуда будут отправляться посылки. Данная информация необходима для расчётов стоимости доставки и создания заказов.

Контактные данные #

img Данная информация необходима для создания заказа.

Параметры товаров по умолчанию #

img

Параметры товаров по умолчанию используются в том случае, если какая-то из величин (вес, габариты) товара отсутствует или равна нулю в итоговых расчетах.

Параметры грузоместа (используются, если заполнены) #

img

Параметры грузоместа (постоянные параметры) используются в том случае, если необходимо сделать так, чтобы вес и габариты были постоянными. Для этого потребуется заполнить эти данные.

Дополнительные параметры #

img

Артикул для выгрузки - позволяет выбрать, что будет выгружаться как артикул.

Налоговый класс - это работа с налогами. Можно добавлять налоги, в зависимости от условий.

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

Префикс номера заказа - добавляет к клиентскому номеру заказа префикс, который можно указать. Можно использовать для разделения магазинов по номерам.

Показывать заглушку в корзине при ошибке - позволяет отображать заглушку, вместо ошибки сервиса.

Использовать фиксированную стоимость страховки товара - для товаров будет указана заданная стоимость страховки.

Добавить к дате отгрузки - выбранное количество дней будет добавлено к отгрузке заказа.

Статусы заказа (Массовый экспорт заказов) #

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

img

Статус заказа после одиночного экспорта - статус после оформления заказа. Выберите свой статус. Система → Локализация → Статусы заказов.

Статус заказа после отмены одиночного экспорта - статус после отмены оформленного заказа. Выберите свой статус. Система → Локализация → Статусы заказов.

Статус заказа для группового экспорта - статус для оформления группового экспорта. Выберите свой статус. Система → Локализация → Статусы заказов.

Статус заказа после группового экспорта - статус после группового экспорта. Выберите свой статус. Система → Локализация → Статусы заказов.

Статус заказа после ошибки группового экспорта - статус после ошибки группового экспорта. Выберите свой статус. Система → Локализация → Статусы заказов.

img

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

Url для группового экспорта заказов - адрес, по которому нужно запустить крон для группового экспорта заказов.

Url для получения статусов заказов - адрес, по которому нужно запустить крон для обновления статусов экспортированных в apiship заказов

Ключ Яндекс API - ключ типа “JavaScript API и HTTP Геокодер” — нужен для отображения поля поиска адреса на карте. img Ключ можно получить по ссылке: https://developer.tech.yandex.ru/services
Инструкция получения API-ключа: https://yandex.ru/dev/jsapi-v2-1/doc/ru/#get-api-key

Порядок сортировки - рекомендуем указать 1.

Режим работы:

  1. Нормальный - обычный.
  2. Отладка - нормальный с отладочной информацией.
Статус - Включено. Для активации модуля.

Параметры отгрузки в службы доставки #

img

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

Чтобы определить склад, например для СДЭК, воспользуйтесь справочником ПВЗ, который находится в личном кабинете Apiship, скопируйте код ПВЗ и введите его в поле “Привоз на склад СДЭК”.

В справочнике ПВЗ можно воспользоваться различными полями для фильтрации и поиска нужного ПВЗ. Также имеется два вида отображения и поиска ПВЗ: списком и на карте.

Выбор ПВЗ в списке #

img

В имеющимся списке, необходимо найти подходящий ПВЗ и скопировать его код для дальнейшего опеределения склада.

Выбор ПВЗ на карте #

img

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

img

Параметры сопоставления статусов #

img

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

Соответствия статусов между СД и ApiShip можно увидеть на странице: соответствие статусов.

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

Статусы оплаченных заказов - статусы для оплаченных заказов. Используется для настройки передачи наложенного платежа Заказы, которые находятся в выбранных статусах при выгрузке в службу доставки будут переданы как оплаченные и служба доставки не будет брать деньги с получателя.

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

img

Сохранение настроек #

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

img