Dokumentace One Widget
Widget slouží k výběru výdejního místa v nákupním košíku e-shopu. Zákazník si na mapě snadno a pohodlně vybere nejbližší výdejní místo ONE POINT nebo výdejní box ONE BOX. Grafická podoba widgetu je totožná s webovými stránkami ONE.
Widget je možné používat dvěma způsoby:
- Použitím přesměrování - pri výběru dopravy v objednávce proběhne přesměrování na stránku widgetu a po výběru výdejního místa je zákazník přesměrován zpět do procesu objednávky eshopu.
- Použitím za pomoci elementu iframe - widget se implementuje jako součást objednávkového formuláře a uživatel není přesměrováván mimo stránky eshopu.
Využití widgetu pomocí přesměrování
Prvním způsobem využití výběru výdejního místa je přesměrování (automatické, či vyvolané zákazníkem eshopu).
Při tomto využití widgetu je nutné definovat v url parametry (při vkládání url adres do parametrů mějte na paměti, že je potřeba dodržet escape konvence speciálních znaků v URL):
- selectMode s hodnotou redirect
- selectTarget obsahujicí URL pro přesměrování po úspěšném výběru výdejního místa (callback).
- cancelUrl obsahujicí URL pro přesměrování při výskytu chyby (fallback).
Dále je možné v url definovat volitelné parametry:
- cancelMessage - pokud je přítomno, zavírací tlačítko posílá zprávu s obsahem {"widgetClosed": true}
- fixedType - typ výdejního místa. Odstraní možnost uživatelského výběru filtru na typ. Možné hodnoty:
- Box
- Point
- disableBoxType - zakáže určitý typ výdejních boxů, může obsahovat více hodnot oddělených čárkou.
- oxbox
- alzabox
- onebox
- disablePointType - zakáže určitý typ výdejních boxů, může obsahovat více hodnot oddělených čárkou.
- sazka
- country - omezí výběr výdejních míst na danou zemi:
- cz
- sk
Využití widgetu použitím elementu <iframe>
Tímto způsobem využití integrujete widget přímo do Vašeho objednávkového formuláře. Při tomto využití je nutné definovat v url následujicí parametry:
- selectMode s hodnotou postMessage
Dále je možné v url definovat volitelné parametry:
- fixedType - typ výdejního místa. Odstraní možnost uživatelského výběru filtru na typ. Možné hodnoty:
- Box
- Point
- disableBoxType - zakáže určitý typ výdejních boxů, může obsahovat více hodnot oddělených čárkou.
- oxbox
- alzabox
- onebox
- disablePointType - zakáže určitý typ výdejních boxů, může obsahovat více hodnot oddělených čárkou.
- sazka
- country - omezí výběr výdejních míst na danou zemi:
- cz
- sk
Příklad widgetu za použití iframe:
Následně je nutné na stránku do které widget vkládáte vložit script, který bude zpracovávát výsledky z odeslané z widgetu (tento script slouží pouze jako příklad, každý eshop musí zpracovat svůj vlastní script pro integraci do košíku): <script>
window.addEventListener("message", (e) => {
document.querySelector("span#example-output").innerHTML = e.data.selectedName + " - " + e.data.selectedID; });
</script>