Zum Hauptinhalt springen
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.
BefehlEndpunkteGETPUTPOSTDELETE
Wert einer Template-Option abfragenoptions/get

​
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: 
GET https://<ihr-shop>.de/api/v1/options/get?name=showPaymentIconInFooter&nodeId=payment.payment.bill

​
Parameterübersicht

ParameterTypBeschreibung
namestringPflicht. Name der Option, wie im Template definiert.
nodeIdstringOptional. ID des Konfigurationsknotens bei attachTo-Optionen. Ohne Angabe wird der globale Wert geliefert.

​
Beispiel-Response

{
  "name": "showPaymentIconInFooter",
  "nodeId": "payment.payment.bill",
  "value": true
}
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

Existiert keine Option mit dem angefragten name, antwortet der Endpunkt mit 404 Not Found.
  • Optionen – Template-Optionen definieren.
  • $wsOptions – dieselben Werte im Template auslesen.