...
Описание алгоритма работы виджета. Формат передаваемых и
получаемых параметров виджета.
На Вашем сайте или приложении в нужном Вам месте устанавливается дополнительная «кнопка», например, «Доставка Boxberry», при выборе которой Ваш пользователь попадает на специально разработанный интерфейс по выбору удобной для него точки доставки. Выбор может осуществляться по карте города или по выпадающему списку городов, а также по списку станций метро. Пример размещения можно увидеть по ссылке: http://points.boxberry.ru/demo/ Информация о выбранном пункте выдачи возвращается в виде объекта result с параметрами:
| Параметр | Значение |
|---|---|
| Id | Код ПВЗ в базе Boxberry |
| Name | Название ПВЗ |
| Address | Адрес ПВЗ |
| Workschedule | График работы ПВЗ |
| Phone | Телефон ПВЗ |
| Period | Период доставки до ПВЗ (параметр доступен только при передаче ключа интеграции) |
| Price | Стоимость доставки до ПВЗ (параметр доступен только при передаче ключа интеграции) |
| Prepaid | Признак работы отделения только по предоплате (возможные значения 1|0, где «1» - отделение работает только с предоплаченными посылками, «0» - отделение работает с любым типом посылок). Необходимо для дополнительного информирования клиента на вашем сайте, в случае, если это необходимо. |
При инициализации виджета возможны следующие входные параметры:
| Параметр | Назначение | Примечание |
|---|---|---|
| callback_function | callback-функция, которая будет принимать объект с выбранным ПВЗ | Обязательный параметр |
| api_token (в шифрованом формате) | Ключ интеграции виджета. Необходим для использования функций калькулятора доставки, а также использования фильтрации отображения ПВЗ на карте. | Можно получить в Личном Кабинете в разделе «Настройка виджетов» |
| custom_city | Город инициализации карты (например, Москва) | Передается название города строкой |
| target_start | Код пункта приема посылок | Используется для калькулятора доставки |
| ordersum | Объявленная стоимость посылки | Используется для калькулятора доставки |
| weight | Вес посылки в граммах, обязательно должен быть > 0 | Обязательный параметр. Используется для калькулятора доставки |
| paysum | Сумма к оплате покупателем (оплата при получении) | Используется для калькулятора доставки |
| height | Высота коробки | Используется для калькулятора доставки |
| width | Ширина коробки | Используется для калькулятора доставки |
| depth | Глубина коробки | Используется для калькулятора доставки |
Последовательность аргументов инициализации виджета:
boxberry.open(‘callback_function’,‘api_token’,‘custom_city’,’target_start’,’ordersum’,’weight’,’paysum’,’height’,’width’,’depth’);
...
- Необходимо подключить следующий скрипт: http://points.boxberry.de/js/boxberry.js Для сайтов, работающих по https протоколу, необходимо подключить следующий скрипт: https://points.boxberry.de/js/boxberry.js
- Затем в нужном месте на сайте магазина Вам необходимо поставить ссылку: Выбрать ПВЗ, по событию «onclick» которой должна вызываться функция «boxberry.open» из подключенного ранее файла. В эту функцию обязательно должен передаться параметр «callback_function», который и будет принимать массив с выбранным ПВЗ.
- «callback_function» - это название javascript – функции, которая должна быть прописана на странице оформления заказа. Её имя может быть любым, главное, чтобы она была передана в качестве параметра в «boxberry.open».
- При нажатии на кнопку "Выбрать отделение" на сайте вызывается функция «callback_function», куда в качестве параметра передается объект с ключами, описанными в таблице 2. Формат данных в возвращенном объекте — строки.
- Для работы в режиме ИнфоВиджета – без кнопки «Выбрать отделение», необходимо вызывать виджет без передачи в функцию boxberry.open каких-либо параметров. То есть строка инициализации виджета будет выглядеть примерно так: Выбрать пункт выдачи на карте
- Если Вы хотите задать высоту отступа окна виджета относительно верхней части экрана самостоятельно, то используйте метод boxberry.displaySettings(). Например, boxberry.displaySettings({top:10}), где 10 - размер в пикселях.
- Для фильтрации отображения ПВЗ с ограничением по максимальному весу существует возможность передавать вес массивом в граммах. Если вес передан числом, то фильтрации ПВЗ не происходит.
...