Pošta Widget

Pošta Widget je komponent, ktorý umožní používateľovi výber výdajného miesta Slovenskej pošty. Je určený pre internetové obchody, ktoré ponúkajú možnosť doručenia zásielky prostredníctvom Slovenskej pošty.

Integrácia

Integrácia Pošta Widgetu do web aplikácie vyžaduje:

načítanie JS knižnice
zobrazenie Pošta Widgetu

JS knižnicu je možné načítať vložením script tagu do hlavičky:

<html>
	<head>
		...
		<script
			src="https://static.posta.sk/pickup-widget/v1/lib.js"
			type="text/javascript"
		></script>
	</head>
	...
</html>

Prostredie	URL
Produkčné	`https://static.posta.sk/pickup-widget/v1/lib.js`
Testovacie	`https://static.posta.sk/pickup-widget/v1/lib-test1.js`

Widget je možné zobraziť volaním metódy open:

slposta.PickupWidget.open(config);

Argument	Typ	Povinné	Popis
`config`	`Object: PickupConfig`	áno	Konfiguračné parametre widgetu.

Pri zobrazení widgetu sa vytvorí iframe element, ktorý sa vloží na koniec body elementu a prekryje obsah stránky. Ak je zadaný parameter embedElement, iframe element sa vloží do špecifikovaného elementu. V tomto prípade je možné widget odstrániť volaním metódy close:

slposta.PickupWidget.close();

Dátové štruktúry

PickupConfig

Konfiguračné parametre widgetu.

Kľúč	Typ	Povinné	Popis
`callback`	`function`	áno	Funkcia, ktorá sa zavolá, keď používateľ potvrdí alebo zruší výber výdajného miesta. Funkcia dostane jeden argument, ktorý je buď `Object: PickupPoint`, ak bolo vybraté výdajné miesto (tlačidlo Doručiť sem v detaile výdajného miesta), alebo `null`, ak bol výber zrušený.
`branchKinds`	`Array: BranchKind`	nie	Druh výdajného miesta. Ak je uvedené, sprístupnia sa iba výdajné miesta daného druhu.
`shipmentType`	`string: ShipmentType`	nie	Typ zásielky. Ak je uvedené, sprístupnia sa iba výdajné miesta, na ktoré je možné doručiť zásielku daného typu.
`shipmentWeight`	`float`	nie	Hmotnosť zásielky v `kg`. Ak je uvedené, sprístupnia sa iba výdajné miesta, na ktoré je možné doručiť zásielku s danou hmotnosťou.
`uiHideMapButton`	`boolean`	nie	Skryť tlačidlo Mapa v hlavičke widgetu.
`uiHideCloseButton`	`boolean`	nie	Skryť tlačidlo Zatvoriť v hlavičke widgetu.
`uiHideHeader`	`boolean`	nie	Skryť hlavičku widgetu.
`embedElement`	`string \| DOMElement`	nie	Vloženie widgetu do špecifického elementu stránky. Element môže byť uvedený priamo (typ `DOMElement`), alebo ako CSS selektor (typ `string`). Ak parameter nie je uvedený, widget sa vloží na koniec `body` elementu a prekryje obsah stránky.

BranchKind

Druh výdajného miesta.

Hodnota	Popis
`office`	Pošta
`bbox`	BalíkoBOX
`point`	PoštaPOINT

ShipmentType

Typ zásielky.

Hodnota	Popis
`b`	Balík
`ex`	Expres kuriér
`zb`	Zmluvný balík

PickupPoint

Zvolené výdajné miesto.

Kľúč	Typ	Povinné	Popis
`id`	`string`	áno	Jedinečný identifikátor výdajného miesta.
`kind`	`string: BranchKind`	áno	Druh výdajného miesta.
`label`	`string`	áno	Názov výdajného miesta.
`deliveryAddress`	`Object: DeliveryAddress`	áno	Adresné údaje výdajného miesta.
`routing`	`Object: Routing`	nie	Smerovanie zásielky.

DeliveryAddress

Adresa výdajného miesta, použite pri podaji zásielky ako adresné údaje adresáta.

Kľúč	Typ	Povinné	Popis
`street`	`string`	nie	Ulica a číslo
`city`	`string`	áno	Obec
`zip`	`string`	áno	PSČ

Routing

Smerovanie zásielky, použite ak si vytvárate vlastné adresné štítky.

Kľúč	Typ	Povinné	Popis
`hss`	`string`	nie	HSS
`oss`	`string`	nie	OSS

Príklad

Nasledujúce volanie zobrazí widget, pričom sa sprístupnia iba BalíkoBOXy a PoštaPOINTy, na ktoré je možné doručiť expres zásielku s hmotnosťou 17 kg.

slposta.PickupWidget.open({
    callback: function(pickupPoint){ console.info(pickupPoint); },
    branchKinds: ["bbox", "point"],
    shipmentType: "ex",
    shipmentWeight: 17
});

Príklad objektu Object: PickupPoint, ktorý dostane callback funkcia ako argument, ak si používateľ zvolí doručenie do PoštaPOINTu:

{
	"id": "311136",
	"kind": "point",
	"label": "PoštaPOINT Kvety",
	"deliveryAddress": {
		"street": "Horná 55/2",
		"city": "Banská Bystrica PoštaPOINT Kvety",
		"zip": "19741"
	},
	"routing": {
		"hss": "ZV",
		"oss": "BB"
	}
}

Demo

Vyskúšajte si konfiguráciu rôznych parametrov, ktoré môžete použiť pri integrácii vo vašej aplikácii.

Otvoriť demo

Pošta Widget pre výber výdajného miestaDokumentácia