Die Storefront API befindet sich derzeit in Entwicklung.
Sie wird künftig die zentrale Schnittstelle zwischen dem WEBSALE-Shopsystem und externen Storefronts bilden – etwa Headless-Storefronts, Progressive Web Apps, mobile Anwendungen oder CMS-basierte Frontends.

Ziel ist eine moderne, standardisierte REST-API, die alle wesentlichen Funktionen einer Storefront abdeckt: von der Produktsuche über Warenkorb und Kundenkonto bis hin zu Bewertungen, Merklisten und transaktionalen Benachrichtigungen.

Aktuell steht die Storefront API noch nicht zur Verfügung.
Das WEBSALE-Team arbeitet mit Hochdruck daran, die ersten Endpunkte bereitzustellen und die zugehörige Dokumentation zu veröffentlichen.
Diese Seite dient als Vorschau auf den geplanten Funktionsumfang.

Geplanter Funktionsumfang (MVP)

Im Folgenden sind die zentralen Funktionsbereiche beschrieben, die die Storefront API künftig abdecken wird. Die konkrete technische Ausgestaltung der Endpunkte befindet sich noch in Planung.

1. Technische Grundstruktur

Die Storefront API wird:

• auf einem modernen REST-Ansatz basieren,

• JSON als Standard-Datenformat nutzen,

• klare Versionierung (z. B. /v1/, /v2/) und Abwärtskompatibilität gewährleisten,

• zwischen öffentlichen und authentifizierten Endpunkten unterscheiden,

• Subshops und Mehrmandantenstrukturen nativ unterstützen,

• performantes Paging, Filterung und optionale Cache-Header bereitstellen,

• sichere Authentifizierung über Token bieten,

• und vollständig getrennt von der Admin Interface API betrieben werden.

2. URL-Resolution API

Die URL-Resolution API (SEO-URL Zuordnung) dient der Ermittlung und Zuordnung von URLs zu den entsprechenden Shop-Inhalten. Sie ist ein notwendiger Zwischenschritt, bevor der eigentliche Inhalt (z. B. Produktdetails oder Kategorieansichten) über die Katalog API geladen werden kann.

Beispiel:
Die Storefront übermittelt die URL /herren/schuhe/sneaker.
Die API liefert zurück, dass es sich um eine Kategorie handelt – inklusive der internen Kategorie-ID.
Anschließend kann die Storefront über die Katalog API die passenden Inhalte abrufen.

Geplante Funktionen

• Erkennung, ob eine URL einem Produkt oder einer Kategorie zugeordnet ist

• Rückgabe der zugehörigen Produkt- oder Kategorie-ID

• Unterstützung für sprechende SEO-URLs (z. B. /herren/schuhe/sneaker)

• Nutzung als Routing-Grundlage für Storefronts

3. Katalog API

Die Katalog API bildet das Herzstück jeder Storefront.
Sie stellt die zentralen Daten für Produkte und Kategorien bereit und dient als Informationsquelle für die Darstellung von Produktdetails, Kategorieseiten und Navigationselementen.

Geplante Funktionen

• Standard-Produkt- und Kategorieattribute (z. B. Name, Beschreibung, Preis etc.)

• Individuelle Produktattribute (z. B. Material, Pflegehinweise etc.)

• Individuelle Kategorieattribute (z. B. zusätzliche SEO-Texte etc.)

• SEO-Informationen (z. B. Meta-Titel, Meta-Description, sprechende URLs)

• Kategoriestruktur (Hierarchie, Unterkategorien, Verknüpfungen)

• Produkte anzeigen (z. B. innerhalb einer Kategorie oder Ergebnisliste)

• Einzelne Produkte oder Kategorien laden

Die für die Darstellung und Steuerung von Kategorieseiten und Suchergebnissen erforderlichen Funktionen – etwa Filter, Sortierung, Blättern (Paging) oder die Anzahl der Produkte pro Seite – werden nicht über die Katalog API bereitgestellt.

Diese Funktionen stammen aus dem separaten WEBSALE|search Modul und müssen über die entsprechenden WEBSALE WebComponents eingebunden werden.

4. Verfügbarkeit & Lager API

Diese Schnittstelle liefert Bestands- und Verfügbarkeitsinformationen.
Sie ergänzt die Produktdaten um Hinweise, ob eine Variante aktuell verfügbar oder ausverkauft ist.

Geplante Funktionen:

• Anzeige von Lagerbestand und Verfügbarkeit

5. Warenkorb API

Die Warenkorb-API steuert sämtliche Interaktionen rund um das Hinzufügen, Ändern und Entfernen von Artikeln im Warenkorb.

Bevor ein vollständiger Checkout verfügbar ist, stellt die API auch bereits vorläufige Warenkorbberechnung inklusive möglicher Versandkosten bereit. So können Nutzer schon im Warenkorb einen Überblick über die zu erwartenden Versandkosten erhalten.

Geplante Funktionen:

• Produkte in den Warenkorb legen (auch direkt aus Listen)

• Bestellmenge ändern oder löschen

• Warenkorb anzeigen

• Mindestbestellwerte, Maximalbestellmengen etc.

• Gutscheine eingeben, ändern oder entfernen

• Rabatte und Summen anzeigen

• Versandkosten anzeigen

6. Merkliste API

Mit dieser Schnittstelle lassen sich Merklisten anlegen, verwalten und anzeigen – wahlweise anonym (nicht eingeloggt) oder kundengebunden.

Geplante Funktionen:

• Produkte merken oder entfernen

• Merklisten anlegen, ändern, löschen

• Merklisten teilen

7. Bewertungen (Ratings) API

Diese API-Komponente ermöglicht es, Produktbewertungen im Frontend darzustellen und neue Rezensionen entgegenzunehmen.

Geplante Funktionen:

• Produktbewertungen anzeigen

• Produktbewertungen ändern

• Bewertungen abgeben

8. Kundenkonto API

Die Kundenkonto API ermöglicht die Verwaltung persönlicher Daten, Adressen, Zugangsdaten und Bestellinformationen. Sie bildet die Grundlage für den Bereich „Mein Konto“ innerhalb der Storefront und stellt alle Funktionen bereit, die Kunden zur Selbstverwaltung ihrer Daten benötigen.

Geplante Funktionen:

• Adressbuch verwalten (anlegen, ändern, löschen)

• E-Mail-Adresse ändern (mit Double-Opt-In-Bestätigung)

• Passwort ändern oder zurücksetzen („Passwort vergessen“)

• Konto löschen

• Bestellhistorie anzeigen (nur Online-Bestellungen, keine Ladengeschäfte)

• Verfügbarkeitsalarme anlegen und verwalten

• Übersicht eigener Bewertungen

• Login für Bestandskundinnen und -kunden

• Registrierung für neue Kundinnen und Kunden

• Eingeloggt bleiben (persistente Sitzung)

9. Newsletter API

Diese API-Komponente ermöglicht die einfache Integration von Newsletter-Anmeldungen und -Abmeldungen für das WEBSALE Newsletter-Modul in der Storefront. Sie kann sowohl für eingeloggte Kundinnen und Kunden als auch für anonyme Besucher verwendet werden.

Geplante Funktionen:

• Newsletter-Anmeldung

• Newsletter Abmeldung

10. Konfiguration API

Die Konfigurations API stellt alle plattform- und subshopspezifischen Einstellungen bereit, die für die Darstellung und das Verhalten der Storefront erforderlich sind. Sie ermöglicht es, zentrale Parameter dynamisch abzurufen, anstatt sie fest im Frontend zu hinterlegen.

So können Storefronts automatisch die korrekten Währungen, Steuersätze, Länder, Sprachen oder Anreden verwenden und unterschiedliche Subshop-Konfigurationen berücksichtigen.

Geplante Funktionen

• Abruf globaler Plattform-Einstellungen (z. B. ShopID, Länderlisten, Anreden)

• Abruf subshopspezifischer Konfigurationen (z. B. Sprache, Währung, Preisformatierung)

• Zugriff auf steuerrelevante Parameter (z. B. Brutto-/Nettoanzeige, Mehrwertsteuerkontext) etc.

11. Formular API

Die Formular API ermöglicht die dynamische Bereitstellung, Validierung und Übermittlung von Formularen innerhalb der Storefront. Sie stellt die erforderlichen Strukturen und Prüfregeln bereit, damit Formulare flexibel gestaltet und zentral ausgewertet werden können – ohne feste Definitionen im Frontend-Code.

Geplante Funktionen

• Abruf der verfügbaren Formulare und ihrer Felder (z. B. Kontaktformular, Rückrufanfrage, Newsletter-Anmeldung)

• Auslesen von Formularfeldern und zugehörigen Attributen (z. B. Feldtyp, Pflichtfeld, Standardwert, Abhängigkeiten)

• Validierung von Eingaben nach hinterlegten Regeln (z. B. Pflichtfelder, Feldabhängigkeiten, Formatprüfungen)

• Formularabsendung

Ausblick & nicht enthalten im MVP

Folgende Themen werden in einer späteren Ausbaustufe berücksichtigt:

• Checkout-Prozess (Zahlungs- und Versandarten, Bestellabschluss)

• Verwaltung gespeicherter Zahlungsdaten

• Events & Webhooks

• Systemmails (Transactional Messaging API)

• Direktbestellng (DirectOrder)

• B2B-Funktionen wie Registrierungs- und Freigabeprozesse, Firmenkonten inkl. Berechtigungen etc.

• Erweiterte Auftrags- und Fulfillment-Prozesse