Store API

Das FAQ-Manager-Plugin stellt einen Store-API-Endpunkt bereit, der für Headless-Projekte oder eigene Storefront-Implementierungen genutzt werden kann.

FAQs für ein Produkt laden

Liefert die ermittelten FAQ-Gruppen (mit ihren Einträgen), die aktive Plugin-Konfiguration und das FAQPage-Rich-Snippet zum übergebenen Produkt zurück. Der Payload entspricht dem, was die reguläre Storefront zum Rendern der Produktdetailseite verwendet, sodass eine Headless-App dieselbe Ansicht ohne zweiten Roundtrip für Metadaten rendern kann.

Endpunkt: GET /store-api/prems-faq/product/{productId}

(POST wird auf demselben Pfad ebenfalls akzeptiert.)

Login erforderlich: Nein

Parameter:

Parameter	Typ	Pflicht	Beschreibung
productId	string	Ja	Die UUID des Produkts (URL-Parameter).

Antwort: 200 OK mit folgendem JSON-Body:

Feld	Typ	Beschreibung
groups	array	Die passenden FAQ-Gruppen, sortiert nach Priorität. Jede Gruppe enthält den übersetzten name, die description, den Override descriptionVisibility und ein entries-Array mit den aktiven Einträgen. Abonnement-Limits (Anzahl Gruppen, Anzahl Einträge, blockierte Inhaltstypen) sind bereits angewendet.
config	object	Die aktive Plugin-Konfiguration: active (bool), placement (string) und descriptionVisibility (string, der Plugin-weite Standard).
richSnippet	object	Der FAQPage-JSON-LD-Payload für die ermittelten Einträge. Leer, wenn keine Einträge passen.

Ist das Plugin für den aktuellen Verkaufskanal nicht aktiv, wird ein leerer Payload zurückgeliefert (leere groups, die aktuelle config, leeres richSnippet).

Fehler:

• 404 Not Found – Das Produkt existiert nicht oder ist im aktuellen Verkaufskanal-Kontext nicht erreichbar.