Widgetreferens

Utvecklardokumentation: alla sidor

Börja

Hjälp och dokumentation

Ändringar

Använd den sparade widgeten från Installera. Sidan anger bara produkt- eller platsnycklarna som behövs. Utelämnad typ ger where-to-buy; tomma, okända och borttagna typer visar inget.

<script
    src="https://cdn.test.stockisto.com/widget.js"
    data-api-base="https://api.test.stockisto.com"
    data-embed="we_0123456789abcdef0123456789abcdef"
    data-sku="7130171"
    async
></script>

01De åtta widgetarna

WidgetPlaceringNycklarWidgetsida
where-to-buyVarumärkets produktsida; butiker nära kundendata-embed, data-skuVar finns varan
guided-handoffVarumärkets produktsida; förfrågan till butik och installatördata-embedHitta installatör
store-locatorVarumärkets sida; nätverket på karta eller listadata-embedHitta butik
installer-finderVarumärkets sida; godkända installatörerdata-embedHitta installatör
store-availabilityÅterförsäljarens produktsida; lager per filialdata-stockisto-slug, data-retailer, data-skuLager i butik
store-cardButikssida; adress, öppettider, varumärken och betygdata-store-id, data-retailerButikskort
installer-cardInstallatörens sida; behörighet och täckningdata-installer, data-stockisto-slugInstallatörskort
stock-alertÅterförsäljarens produktsida; mejl vid åter i lagerdata-stockisto-slug, data-store-id, data-skuLageravisering
AttributVärden eller standard
data-widget-typewhere-to-buy, guided-handoff, store-locator, installer-finder, store-availability, store-card, installer-card, stock-alert, (where-to-buy)
data-viewfull, inline, button, pill, corner, map, list, (full)

02Produkter

En produktkod, högst 100 tecken. Okänd kod visar att produkten saknas, aldrig hela varumärkets resultat. data-skus tar högst 6 kommaseparerade koder.

AttributVad det gör
data-sku-typeKodtypen i data-sku. rsk, gtin, enummer, mpn, sku, vvs, nrf, lvi, retailer_sku, nobb, finfo, efo, elnummer_dk, sahkonumero, tun, ean
data-skuEn produktkod, högst 100 tecken.
data-skus-typeKodtypen i data-skus. rsk, gtin, enummer, mpn, sku, vvs, nrf, lvi, retailer_sku, nobb, finfo, efo, elnummer_dk, sahkonumero, tun, ean
data-skusHögst 6 kommaseparerade produktkoder.

03Plats och lista

En fast sökpunkt med data-lat och data-lng hindrar en fråga om webbläsarens plats. data-radius anges i kilometer. data-per-view styr rader i inline-vyn.

AttributStandardVad det gör
data-latFast latitud för sökningen. -90–90
data-lngFast longitud för sökningen. -180–180
data-radius50Sökradie i kilometer. >= 0
data-filterFiltrera lager eller återförsäljarstatus. confirmed, showroom, authorized
data-rankstockSortera resultatet. stock, distance, price
data-channelallVälj försäljningskanal. all, near, online
data-pricesretailerVälj vilka priser som visas. retailer, online, msrp, off
data-audienceconsumerVälj kundgrupp. consumer, trade
data-quantityÖnskat antal. 1–9007199254740991
data-reservefalseAktivera reservationer.
data-guidedfalseAktivera guidade frågor.
data-per-view3Rader innan alla visas. 1–12
data-jsonldonInkludera strukturerade data. on, off
data-map-height480Kartans höjd i pixlar. 320–800

04Utseende

data-theme och färginställningarna tar hex-färger. data-width tar full eller 200 till 2000 pixlar. Webbläsaren tillhandahåller typsnittet; inget webbtypsnitt laddas.

AttributVärden eller standard
data-theme-presetlight, heritage, dark, blue, copper, fjord, oak, signal, graphite, (heritage)
data-radius-scalesm, md, lg, (md)
data-densityspacious, cozy, compact, dense, (cozy)
data-shadowsoft, flat, none, (soft)
data-fontgrotesk, sans, serif, mono, system, (grotesk)
data-theme(#1e5e45)
data-theme-accent2Andra accentfärgen, hexvärde.
data-theme-surfaceKortets bakgrund, hexvärde.
data-theme-inkTextfärg, hexvärde.
data-widthFull bredd eller 200 till 2000 pixlar.

05Språk och samtycke

AttributVärden eller standard
data-analytics-consentBara det bokstavliga true skickar analys. Lämna avstängt tills samtycke finns.
data-langen, sv, nb, da, fi, (en)

Utan data-lang följer widgeten sidans språk, sedan webbläsaren och sist engelska. Bara värdet true i data-analytics-consent aktiverar analys.

06Content Security Policy

CSPTESTFör
script-srchttps://cdn.test.stockisto.comAlla widgetar
connect-srchttps://api.test.stockisto.comAlla widgetar
style-src'unsafe-inline'Alla widgetar
img-srchttps://api.test.stockisto.comAlla widgetar
frame-srchttps://find.test.stockisto.comHitta butik och Hitta installatör

07Startfel

data-stockisto-errorVad ni ska kontrollera
unknown-widget-typedata-widget-type
embed-unavailabledata-embed, data-api-base
missing-data-sourcedata-embed, data-stockisto-slug
unknown-brand-slugdata-stockisto-slug
pill-target-locator-without-brand-slugdata-stockisto-slug

08Analyshändelser

Med samtycke skickar widgeten händelser till /api/v1/analytics/events utan inloggningsuppgifter. API:et svarar 202. För koppling till ert konto krävs sidans domän i Tillåtna ursprung.

Händelser för säljaråtgärder

Händelsen heter retailer_cta_click, med widgetEvent cta_click och ctaType call, directions eller website.

En offertlänk som öppnar ett telefonnummer eller en webbplats räknas som ett telefon- eller webbplatsklick.

09Installera från npm

Inte lanserat än. Det lokala paketet har version 2.11.0 med ESM, CommonJS och TypeScript-typer. npm-installation är inte tillgänglig förrän publiceringen har verifierats. Använd skripttaggen ovan.

import {
    readConfig,
    fetchRetailers,
    mountStoreListWidget,
} from "@stockisto/widget";

const script = document.createElement("script");
script.dataset.apiBase = "https://api.test.stockisto.com";
script.dataset.stockistoSlug = "your-brand-slug";
script.dataset.sku = "7130171";
const config = readConfig(script);
const { rows } = await fetchRetailers(config, new AbortController().signal);
const container = document.getElementById("where-to-buy");
if (container) mountStoreListWidget(container, rows, config);
Widgetnpm
where-to-buymountStoreListWidget, mountPdpWidget, mountWhereToBuyButton, mountPillWidget, mountCornerWidget
store-locatormountStoreLocatorWidget(container, config)
installer-findermountInstallerFinderWidget
store-availabilitymountStoreAvailabilityWidget(container, config, rows)
store-cardmountStoreCardWidget, storeCardParts
installer-cardmountInstallerCardWidget
guided-handoffrenderGuidedHandoff