Skip to main content
Die Optionen-API liefert die Werte von Template-Optionen über die Storefront-API, analog zum Template-Modul $wsOptions. So lassen sich im Template definierte und im Admin-Interface gepflegte Optionswerte auch aus einem externen Frontend auslesen.
Die Optionen müssen weiterhin im Template definiert werden (siehe Optionen). Die Storefront-API liest die Werte nur aus und ersetzt die Definition nicht.

​
Unterstützte Methoden

Angabe aller unterstützten Methoden.

​
Methoden für Optionen

Mit dieser Methode wird der Wert einer einzelnen Template-Option bereitgestellt - sowohl für globale Optionen als auch für Optionen, die mit attachTo an einen Konfigurationsknoten gebunden sind.

​
GET options/get

Liefert den Wert einer Template-Option, analog zu $wsOptions.get(name, nodeId). Der Parameter nodeId ist optional und wird für Optionen angegeben, die an einen Konfigurationsknoten gebunden sind. Beispiel-Aufruf, der den Wert einer an eine Zahlungsart gebundenen Option ausliest:

​
Parameterübersicht

Es sind ausschließlich die Parameter name und nodeId erlaubt. Jeder weitere Query-Parameter führt zu 400 Bad Request mit error: "invalidParameters" und einem Eintrag in paramErrors.

​
Beispiel-Response

Wurde im Request kein nodeId übergeben, entfällt das Feld nodeId in der Antwort. Der Typ von value entspricht dem Typ der Option (z. B. bool, string, int).

​
Statuscodes

Der Endpunkt antwortet bei gültigen Parametern immer mit 200 OK. Existiert keine Option mit dem angefragten name, enthält die Antwort das Feld value ohne Wert (null). Prüfen Sie deshalb im Frontend auf value, nicht auf den HTTP-Status. 404 Not Found liefert der Endpunkt nur, wenn eine andere Methode als GET verwendet wird.
  • Optionen – Template-Optionen definieren.
  • $wsOptions – dieselben Werte im Template auslesen.