> For the complete documentation index, see [llms.txt](https://docs.premsoft.de/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.premsoft.de/plugins/faq-produkte-und-erlebniswelten/store-api.md).

# 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.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.premsoft.de/plugins/faq-produkte-und-erlebniswelten/store-api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.