Skip to main content

Documentation Index

Fetch the complete documentation index at: https://dokumentation.websale.de/llms.txt

Use this file to discover all available pages before exploring further.

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

​
storefrontApi* - Grundstruktur

Nachfolgend der Grundaufbau des Knotens storefrontApi 
{
  "storefrontApi": {
    "redirects": {},
    "catalogApiSettings": {}
  }
}

​
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
ParameterTypBeschreibung
identifierstringFreier Name der Weiterleitung, wird als viewIdentifier im API-Aufruf verwendet.
Mehr dazu: Storefront API Session-Handling
targetTemplateNamestringPfad/Name der Ziel-Template-Datei (z.B. checkout.htm)

​
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
ParameterTypBeschreibung
enableProductDataEndpointboolAktiviert/deaktiviert den Produkt-Endpunkt der Storefront-API.
enableCategoryDataEndpointboolAktiviert/deaktiviert den Kategorien-Endpunkt der Storefront-API.
enableProductWhitelistboolSchaltet eine Whitelist für auslieferbare Produktfelder ein.
Wenn true, werden nur Felder aus productFieldWhitelistzurückgegeben. Default: false
enableCategoryWhitelistboolSchaltet eine Whitelist für auslieferbare Kategoriefelder ein.
Wenn true, werden nur Felder aus categoryFieldWhitelistzurückgegeben. Default: false
productFieldWhitelistmultiAssocListe erlaubter Produktfelder aus content.productField und/odercontent.customProductField.
Wirkt nur, wenn enableProductWhitelist = true.
categoryFieldWhitelistmultiAssocListe erlaubter Kategoriefelder aus content.categoryField und/oder content.customCategoryField.
Wirkt nur, wenn enableCategoryWhitelist = true.