Виджет ПВЗ
Описание
Сервис Карго позволяет встраивать виджет точек выдачи в веб продукты, для предоставления клиентам.
Токен интеграции можно получить по ссылке - https://lk.cse.ru/integration
Виджет возвращает callback с информацией по выбранной точке выдачи.
init
Для инициализации необходимо вызвать метод init.
В качестве второго параметра передается следующий объект:
{token: 'токен интеграции', city: 'GUID города’, popup: true, el: "#wdgtcontainer"}
где:
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| token | string | Уникальный токен , полученный из личного кабинета после заключения договора | |
| city | string |
GUID города, список городов можно получить методом GetReferenceData: Geography. Параметр city является необязательным. Если city передан, то список ПВЗ ограничивается только выбранным городом, другие города будут недоступны для выбора. |
|
| popup | boolean |
Формат открытия виджета. Является обязательным и в зависимости от его значения, виджет будет открываться в модальном окне (popup: true) или в iframe (popup: false). |
|
| el | string | Обязательно при popup: true. Имеет значение "#wdgtcontainer" |
open
Для открытия виджета необходимо вызвать метод open. В качестве второго параметра
передается объект
{callback: function(e) {}, onclose: function() {},
filters:
{
isPartialBuyout: true,
height: 0,
isPartialPrePay: true,
isRecipient: true,
isTryOn: true,
orderPointCityGuid: "",
sum_dimension: 0,
wayOfPayment: 1,
weight: 0.1,
width: 0,
}onclose и filters являются необязательными.
Список параметров, передаваемых в filters:
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| payment_by_cash | boolean | Оплата наличными | |
| payment_by_card | boolean | Оплата банковской картой | |
| receiving_sending | boolean | Прием отправлений | |
| issuance_of_shipping | boolean | Выдача отправлений | |
| partial_buyout | boolean | Частичный выкуп | |
| try_on | boolean | Примерка (проверка качества) | |
| partial_pre_pay | boolean | Частичная предоплата | |
| orderPointCityGuid: | string | GUID города в котором находится точка выдачи | |
| sum_dimension | int | Сумма габаритных измерений отправления | |
| wayOfPaymen | int | Способ оплаты | |
| weight | float | Вес отправления | |
| width | float | Ширина отправления | |
| height | float | Высота отправления | |
| depth | float | Глубина отправления |
Возвращаемые параметры callback
При выборе конкретной точки, виджет возвращает данные о выбранной точки выдачи через callback
Перечень возвращаемых параметров точки
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| guid | string | GUID точки выдачи в системе Карго | |
| name | string | Наименование точки выдачи в системе Карго | |
| address | string | Адрес точки выдачи в системе Карго. Включает в себя индекс, город, и адрес точки выдачи | |
| index | string | Индекс точки выдачи | |
| phones | array | Массив контактных телефонов точки выдачи | |
| emails | array | Массив контактных email точки выдачи | |
| schedule | array | Массив с графиком работы точки выдачи. Включает в себя данные о диапазоне дней недели (days) и временем работы в эти дни (time) | |
| services | array | Массив с данными по услугам точки выдачи, включает в себя данные по наименованию услуги (name) и том подключена ли она в точке выдачи (available = true|false) | |
| cod_limit | int | Ограничение способа оплаты | |
| driving_directions | string | Информация как добраться до точки выдачи | |
| storage_life | int | Срок хранения отправления в точке выдачи | |
| geography_guid | string | Гуид населенного пункта в котором расположена точка выдачи | |
| geography_name | string | Название населенного пункта в котором расположена точка выдачи |
Примеры использования
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<script>!function (e, t, n, c, s, a, i) { e.CsePvzWidget = s, e[s] = e[s] || function () { (e[s].q = e[s].q || []).push(arguments) }, e[s].l = 1 * new Date, a = t.createElement(n), i = t.getElementsByTagName(n)[0], a.async = 1, a.src = c, i.parentNode.insertBefore(a, i) }(window, document, "script", "https://lktest.cse.ru/dist/js/widget.js", "csepvzwidget"); csepvzwidget('init', { token: '84b416e88cdb63fc27300df837388b4e', city: 'cf862f77-442d-11dc-9497-0015170f8c09', popup: true, el: "#wdgt-container" });</script>
</head>
<body>
<div id="wdgt-container" style="width: 100%; height: 95vh"></div>
<button type="button" onclick="csepvzwidget('open', { callback: function(e) {console.log(e); }, onclose: function() {console.log('виджет закрыт');}});">
открыть виджет
</button>
</body>
</html> {
"guid": "b8b3de6c-a4aa-11e9-80d3-7cd30aebf950",
"name": "Почтомат Teleport 243",
"address": "193149, г Санкт-Петербург, ул Русановская, д 19 к 2",
"index": "",
"phones": [],
"emails": [],
"schedule": [
{
"days": "пн-вс",
"time": "09:00—23:00"
}
],
"services": [
{
"name": "Оплата наличными",
"available": false
},
{
"name": "Оплата банковской картой",
"available": true
},
{
"name": "Прием отправлений",
"available": false
},
{
"name": "Выдача отправлений",
"available": true
}
],
"cod_limit": 100000,
"driving_directions": "Постамат расположен в магазине "Дикси", 1 этаж.",
"storage_life": "3",
"geography_guid": "cf862f77-442d-11dc-9497-0015170f8c09",
"geography_name": "Санкт-Петербург"
} 