Skip to main content

Documentation Index

Fetch the complete documentation index at: https://dokumentation.websale.de/llms.txt

Use this file to discover all available pages before exploring further.

Die Storefront API steht als zentrale REST-Schnittstelle für Storefronts im WEBSALE-Shopsystem zur Verfügung. Über sie lassen sich Headless-Storefronts, Progressive Web Apps, mobile Anwendungen oder CMS-basierte Frontends anbinden, ohne direkt auf interne Shop-Logik zugreifen zu müssen. Die API deckt typische Storefront-Funktionen ab – von der URL-Auflösung und Katalogdaten über Verfügbarkeit/Lager, Warenkorb und Gutscheine bis hin zu Kundenkonto, Merklisten, Bewertungen, Newsletter und Formularen. Die Storefront API folgt einem REST-Ansatz und nutzt JSON als Standard-Datenformat. Für eine klare Weiterentwicklung stehen Versionierung und Abwärtskompatibilität im Fokus (z. B. über Pfade wie /v1/, /v2/). Je nach Anwendungsfall wird zwischen öffentlichen und authentifizierten Endpunkten unterschieden. Subshops und Mehrmandantenstrukturen werden nativ unterstützt; für Listenabrufe sind Paging und Filterung vorgesehen, optional ergänzt durch Cache-Header. Die Authentifizierung erfolgt tokenbasiert. Die Storefront API ist technisch und fachlich von der Admin Interface API getrennt.

​
Inhaltsverzeichnis

  • Storefront API Basics — Die Seite Storefront API Basics beschreibt die grundlegenden technischen Rahmenbedingungen für die Nutzung der Storefront API. Dazu gehören u. a. Basis-URL und Versionierung, Request-/Response-Format (JSON), Authentifizierung sowie allgemeine Konventionen wie Header, Fehlercodes und Paging.
  • Storefront API Checkout (In Progress) — Die Storefront API Checkout stellt Funktionen für den Bestell- und Checkout-Prozess bereit. Darüber werden die Schritte abgedeckt, die typischerweise zwischen Warenkorb und Bestellabschluss stattfinden.
  • Storefront API Formulare — Über den API-Endpunkt für Formulare werden die im Shop verfügbaren Online-Formulare bereitgestellt und deren Felder, Pflichtangaben und Validierungen ausgeliefert. Über den Endpunkt können alle Formulare aufgelistet, ein einzelnes Formular oder Feld abgerufen und ausgefüllte Formulare übermittelt werden.
  • Storefront API Gutscheine — Die Storefront API Gutscheine ermöglicht es, Gutscheincodes in der Storefront einzulösen und zu entfernen. Die API prüft dabei automatisch, ob ein Code gültig ist, und liefert nach der Einlösung die aktualisierten Warenkorbwerte (z. B. Rabatte und Summen) sowie bei Bedarf Hinweise/Fehlermeldungen zurück.
  • Storefront API Katalog — Die Katalog API stellt die zentralen Informationen für Produkte und Kategorien bereit und bildet damit die Grundlage für Produktdetailseiten, Kategorieseiten und Navigationselemente. Sie liefert Standardattribute (z. B. Name, Beschreibung, Preis), ergänzt um individuelle Produkt- und Kategorieattribute sowie SEO-Informationen wie Meta-Daten und sprechende URLs.
  • Storefront API Kundenbewertungen — Die Storefront-API für Kundenbewertungen stellt Funktionen bereit, um Kundenbewertungen zu erstellen, abzurufen, zu aktualisieren, zu löschen und auszuwerten. Darüber hinaus lassen sich z.B. die eigene Bewertung eines eingeloggten Kontos, alle freigegebenen Bewertungen eines Produkts sowie Statistikwerte abfragen.
  • Storefront API Kundenkonto — Die Kundenkonto API stellt die Funktionen für den Bereich „Mein Konto“ bereit. Dazu gehören die Verwaltung persönlicher Daten, Zugangsdaten und Adressen (Adressbuch anlegen/ändern/löschen) sowie typische Account-Prozesse wie E-Mail-Änderung (inklusive Double-Opt-In), Passwort ändern/zurücksetzen („Passwort vergessen“) und das Löschen des Kontos.
  • Storefront API Konfigurationen — Die Konfiguration API liefert plattform- und subshopspezifische Einstellungen, die für Darstellung und Verhalten der Storefront relevant sind.
  • Storefront API Lagerbestand — Die Verfügbarkeit-&-Lager API ergänzt Katalogdaten um Bestands- und Verfügbarkeitsinformationen. Damit lässt sich im Frontend anzeigen, ob ein Produkt und dessen Variante aktuell verfügbar ist oder als ausverkauft gilt, und entsprechende Hinweise können direkt an Produktlisten oder auf Produktdetailseiten ausgegeben werden.
  • Storefront API Merkliste — Mithilfe der Storefront-API für Merklisten können Produkte gespeichert, verwaltet und später schnell wiedergefunden werden. Sie bietet Endpunkte zum Anlegen, Umbenennen und Löschen von Merklisten sowie zum Hinzufügen und Entfernen einzelner Produkte.
  • Storefront API Newsletter — Die Newsletter API dient zur Integration von Newsletter-Anmeldungen und -Abmeldungen für das WEBSALE Newsletter-Modul in der Storefront. Sie kann sowohl für eingeloggte Kunden als auch für anonyme Besucher verwendet werden und bildet die üblichen Opt-in/Opt-out-Vorgänge im Frontend ab.
  • Storefront API Session-Handling — Das Storefront API Session-Handling stellt Funktionen bereit, um Sessions in der Storefront zu erstellen und zu verwalten. Damit lassen sich Benutzerzustände (z. B. anonymer Besuch oder eingeloggter Kunde) sowie sessiongebundene Daten wie Warenkorb und Merkliste konsistent über mehrere Requests hinweg nutzen.
  • Storefront API URL-Resolution — Die URL-Resolution API dient dazu, eine Storefront-URL (insbesondere SEO-URLs) auf den passenden Shop-Inhalt aufzulösen. Damit kann das Frontend sein Routing auf sprechenden URLs aufbauen und erhält als Ergebnis, ob die URL beispielsweise zu einem Produkt oder einer Kategorie gehört – inklusive der erforderlichen internen IDs.
  • Storefront API Warenkorb — Die Warenkorb API steuert sämtliche Interaktionen rund um den Warenkorb: Artikel können hinzugefügt, Mengen geändert und Positionen entfernt werden.

​
Ausblick & aktuell noch nicht enthalten

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