storefrontApi - Storefront-API

storefrontApi - Storefront-API

Der Knoten storefrontApi bündelt die Konfigurationsmöglichkeiten für die Storefront-API.


Inhaltsverzeichnis

 


1. storefrontApi* - Grundstruktur

Nachfolgend der Grundaufbau des Knotens storefrontApi:

{ "storefrontApi": { "redirects": {}, "catalogApiSettings": {} } }

 


2. storefrontApi.redirects - Template-Weiterleitung

Der Knoten storefrontApi.redirects definiert, welcher Name (identifier) auf welches Template im Shop verweist.

 

Beispielkonfiguration:

{ "identifier": "checkout", "targetTemplateName": "checkout.htm" }

 

Parameterbeschreibung:

Parameter

Typ

Beschreibung

Parameter

Typ

Beschreibung

identifier

string

Freier Name der Weiterleitung, wird als viewIdentifier im API-Aufruf verwendet.

Mehr dazu:
https://websale.atlassian.net/wiki/spaces/WSDOKU/pages/3613491214/Storefront+API+Session-Handling#2.1-POST-session%2FprepareRedirect

targetTemplateName

string

Pfad/Name der Ziel-Template-Datei (z.B. checkout.htm)

 


3. storefrontAPI.catalogApiSettings - Steuerung der Katalog-Endpunkte

Der Knoten storefrontApi.catalogApiSettings steuert, welche Katalog-Endpunkte in der Storefront-API verfügbar sind und welche Felder darüber ausgeliefert werden dürfen.

 

Beispielkonfiguration:

{ "categoryFieldWhitelist": null, "enableCategoryDataEndpoint": true, "enableCategoryWhitelist": false, "enableProductDataEndpoint": true, "enableProductWhitelist": false, "productFieldWhitelist": null }

 

Parameterbeschreibung:

Parameter

Typ

Beschreibung

Parameter

Typ

Beschreibung

enableProductDataEndpoint

bool

Aktiviert/deaktiviert den Produkt-Endpunkt der Storefront-API.

enableCategoryDataEndpoint

bool

Aktiviert/deaktiviert den Kategorien-Endpunkt der Storefront-API.

enableProductWhitelist

bool

Schaltet eine Whitelist für auslieferbare Produktfelder ein. Wenn true, werden nur Felder aus productFieldWhitelistzurückgegeben.
Default: false

enableCategoryWhitelist

bool

Schaltet eine Whitelist für auslieferbare Kategoriefelder ein. Wenn true, werden nur Felder aus categoryFieldWhitelistzurückgegeben.

Default: false

productFieldWhitelist

multiAssoc

Liste erlaubter Produktfelder aus content.productField und/odercontent.customProductField.

Wirkt nur, wenn enableProductWhitelist = true.

categoryFieldWhitelist

multiAssoc

Liste erlaubter Kategoriefelder aus content.categoryField und/oder content.customCategoryField.

Wirkt nur, wenn enableCategoryWhitelist = true.

© 2025 WEBSALE AG | Impressum | Datenschutz