Skip to main content
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. Zusätzlich können kundenbezogene Informationen wie Bestellhistorie (Online-Bestellungen) bereitgestellt werden. Weitere typische Funktionen sind das Anlegen und Verwalten von Verfügbarkeitsalarmen, eine Übersicht eigener Bewertungen sowie Login, Registrierung und – sofern vorgesehen – persistente Sitzungen („eingeloggt bleiben“). Sämtliche Aufrufe erfordern eine aktive Session per x-session. Mehr dazu

Unterstützte Methoden

Angabe aller unterstützten Methoden.

Methoden für das Kundenkonto

Mithilfe dieser Methoden wird das Kundenkonto im Shop verwaltet. Sie lesen die Daten des aktuell eingeloggten Benutzers (Stammdaten, Adresse, Kundendatenfelder, Login-Status) aus und melden ein Konto mit E-Mail-Adresse/Passwort an. Optional kann die Funktion „Angemeldet bleiben” per Autologin-Token aktiviert werden. Darüber hinaus können neue Konten registriert und direkt eingeloggt werden. Bestehende Sessions lassen sich sauber abmelden. Zudem können Kundenkonten gelöscht werden.

GET account/get

Mit diesem Aufruf werden die Daten des aktuell eingeloggten Kundenkontos der übergebenen Session ausgeliefert. Typische Einsatzzwecke sind die Anzeige des Kontobereichs (Name, E-Mail-Adresse, Anzeigename) oder eine einfache „Angemeldet/Abgemeldet“-Prüfung im Frontend. Beispiel Aufruf, um Daten des aktuell eingeloggten Kundenkontos zu erhalten:

Parameterübersicht

Header-Parameter

Beispiel-Response

POST account/login

Mit diesem Aufruf wird ein Kundenkonto angemeldet. Sind die übergebenen Zugangsdaten korrekt, wird die aktive Sitzung in den Account eingeloggt. Wenn Autologin aktiviert ist, enthält die Antwort einen Autologin-Token. Beispiel-Aufruf, der das Kundenkonto mit der ID kundenkonto@example.coman der Session anmeldet

Beispiel-Request

Beispiel-Response

Parameterübersicht

Header-Parameter

Body-Parameter

Beispiel-Response

Fehlercodes

POST account/autologin

Durch diesen Aufruf wird für die aktuelle Sitzung die Funktion „Angemeldet bleiben“ aktiviert. Dadurch kann sich der Nutzer auf diesem Gerät künftig ohne erneute Passworteingabe wieder anmelden. Beispiel-Aufruf, der Autologin für das Kundenkonto mit der ID 51 aktiviert

Beispiel-Response

Parameterübersicht

Header-Parameter

Body-Parameter

Fehlercodes

POST account/register

Mit diesem Aufruf wird ein neues Kundenkonto erstellt und die aktuelle Sitzung direkt mit diesem Konto angemeldet. Somit kann der Nutzer nach der Registrierung sofort weitermachen. Beispiel-Aufruf um ein neues Kundenkonto mit der E-Mail-Adresse kundenkonto@example.com und dem Passwort password123 zu erstellen

Beispiel-Request

Beispiel-Response

Parameterübersicht

Header-Parameter

Body-Parameter

Beispiel-Response

Fehlercodes

POST account/logout

Mit diesem Aufruf wird der aktuell angemeldete Benutzer ausgeloggt

Beispiel-Response

Parameterübersicht

Header-Parameter

Fehlercodes

DELETE account/delete

Mit diesem Aufruf wird das aktuell eingeloggte Kundenkonto gelöscht. Nach erfolgreicher Ausführung wird die Sitzung beendet und der Zugang zum Konto entfernt. Achtung: Die Löschung kann nicht rückgängig gemacht werden! Beispiel-Aufruf um das aktuell eingeloggte Benutzerkonto dauerhaft zu löschen
Hinweis: Je nach Shop-Konfiguration kann eine E-Mail-Bestätigung (Double-Opt-In) erforderlich sein! Siehe hier (Einstellung doubleOptInEmail.enabled). Beispiel-Response
Parameterübersicht Header-Parameter Fehlercodes

DELETE account/deleteConfirm

Mit diesem Aufruf bestätigt man die Kontolöschung per Opt-In-Token und löschen das aktuell eingeloggte Kundenkonto endgültig. Er wird nur verwendet, wenn in Ihrem Shop die Kontolöschung per Double-Opt-In aktiviert ist. Ohne Double-Opt-In genügt der Aufruf von account/delete. Beispiel-Aufruf, der die Löschung des aktuell eingeloggten Benutzerkonto per Opt-In-Token bestätigt

Beispiel-Request

Beispiel-Response

Parameterübersicht

Header-Parameter

Body-Parameter

Fehlercodes


Methoden für die Adressverwaltung

Mithilfe dieser Methoden können die Adressen im Kundenkonto verwaltet werden. Sie listen alle verfügbaren Adressfelder auf und geben die zum eingeloggten Konto gehörenden Adressen zurück oder holen eine einzelne Adresse per ID ab. Neue Adressen können mit allen relevanten Feldern angelegt, bestehende Adressen gezielt aktualisiert oder als Hauptadresse markiert werden. Bei Bedarf können sie wieder gelöscht werden.

GET account/address/fields

Mit diesem Aufruf werden alle verfügbaren Adressfelder geliefert. Mithilfe dieser Informationen können Adressformulare im Frontend erstellt werden. Beispiel-Aufruf, der alle verfügbaren Adressfelder zurückgibt

Parameterübersicht

Beispiel-Response

GET account/address/list

Mit diesem Aufruf werden alle gespeicherten Adressen des aktuell angemeldeten Kundenkontos inklusive der Feldwerte Name, Straße, PLZ/Ort und Ländercode zurückgeliefert. Die Daten können genutzt werden, um Adressübersichten im Kundenkonto anzuzeigen. Beispiel-Aufruf, der alle gespeicherten Adressen des aktuellen eingeloggten Benutzerkontos zurückgibt

Parameterübersicht

Header-Parameter

Beispiel-Response

GET account/address/get

Mit folgendem Aufruf wird die konkrete Adresse des aktuell angemeldeten Kundenkontos anhand seiner Adress-ID zurückgeliefert. Diese kann beispielsweise zur Anzeige oder Vorbelegung der Adresse im Checkout verwendet werden. Beispiel-Aufruf, der die Adresse mit der ID 97 des angemeldeten Benutzerkontos zurückgibt:

Parameterübersicht

Header-Parameter

Body-Parameter

Beispiel-Response

POST account/address/create

Mit diesem Aufruf wird eine neue Adresse für das aktuell angemeldete Kundenkonto angelegt. Diese kann beispielsweise als Rechnungs- oder Lieferadresse im Checkout verwendet werden. Beispiel-Aufruf, der für das aktuell eingeloggte Benutzerkonto eine neue Adresse erstellt

Beispiel-Request

Hinweis: Wird nur address ohne angegebene Parameter übergeben, so werden für alle Felder die Standardwerte übernommen.

Parameterübersicht

Header-Parameter

Body-Parameter

Beispiel-Response

Fehlercodes

POST account/address/setMain

Mit dieser Anfrage kann eine bestehende Adresse des aktuell eingeloggten Kundenkontos als Hauptadresse festgelegt werden (z. B. als Standard für Versand/Rechnung). Sie kann verwendet werden, um eine Adresse als Standard für Rechnung oder Versand zu kennzeichnen. Beispiel-Aufruf, der die Adresse mit der ID 97 für das aktuell eingeloggte Kundenkonto als Hauptadresse setzt

Beispiel-Request

Parameterübersicht

Header-Parameter

Body-Parameter

Beispiel-Response

Fehlercodes

PUT account/address/update

Mit diesem Aufruf kann eine bestehende Adresse des aktuell eingeloggten Kundenkontos aktualisiert werden. Es müssen nicht alle Felder ausgefüllt werden, nicht ausgefüllte Felder bleiben unverändert. Er kann beispielsweise verwendet werden, um eine Adresse für den Versand oder die Rechnung zu korrigieren. Beispiel-Aufruf, der für das aktuell eingeloggte Kundenkonto bei der Adresse mit der ID 97 den Vor- und Nachnamen ändert

Beispiel-Request

Parameterübersicht

Header-Parameter

Body-Parameter

Beispiel-Response

Fehlercodes

DELETE account/address/delete

Mit diesem Aufruf wird eine bestehende Adresse des aktuell eingeloggten Kundenkontos gelöscht. Beispiel-Aufruf, der die Adresse mit der ID 97 für das aktuell angemeldete Kundenkonto löscht

Beispiel-Request

Parameterübersicht

Header-Parameter

Body-Parameter

Beispiel-Response

Fehlercodes


Methoden für Benachrichtigungen

Mithilfe dieser Methoden können „Produkt wieder verfügbar“-Benachrichtigungen im Kundenkonto verwaltet werden. Sie lesen alle für das eingeloggte Kundenkonto hinterlegten Benachrichtigungen aus, legen neue Benachrichtigungen für eine Kombination aus E-Mail-Adresse und Produkt an und löschen bestehende Benachrichtigungen wieder.

GET account/backInStock/list

Mit folgendem Aufruf werden alle „Produkt wieder verfügbar“-Benachrichtigungen aufgelistet, die für das Konto aktiviert sind. Er kann verwendet werden, um sie dem Kunden im Kundenkonto zur Ansicht zur Verfügung zu stellen. Beispiel-Aufruf, der alle “Produkt wieder verfügbar”-Benachrichtigungen des aktuell eingeloggten Kundenkontos auflistet

Parameterübersicht

Header-Parameter

Beispiel-Response

POST account/backInStock/notify

Mit diesem Aufruf wird für das eingeloggte Konto eine „Produkt wieder verfügbar“-Benachrichtigung eingerichtet. Sobald der Artikel wieder auf Lager ist, wird eine E-Mail an die angegebene Adresse verschickt. Beispiel-Aufruf, der eine “Produkt wieder verfügbar”-Benachrichtigung für das Produkt mit der ID 12345 anlegt. Die Benachrichtigung wird an die E-Mail-Adresse <EMAIL> versendet

Beispiel-Request

Parameterübersicht

Header-Parameter

Body-Parameter

Fehlercodes

DELETE account/backInStock/notify

Durch diesen Aufruf wird die für das eingeloggte Konto erstellte „Produkt wieder verfügbar“-Benachrichtigung gelöscht. Beispiel-Aufruf, der eine “Produkt wieder verfügbar”-Benachrichtigung für das Produkt mit der ID 12345 und der E-Mail-Adresse <EMAIL> wieder löscht

Beispiel-Request

Parameterübersicht

Header-Parameter

Body-Parameter

Fehlercodes


Weitere Methoden für Kundendaten

Mithilfe dieser Methoden wird das Kundenkonto um zentrale Self-Service-Funktionen ergänzt. Benutzer können ihre Bestellhistorie paginiert einsehen oder einzelne Bestellungen mitsamt Positionen, Adressen sowie Zahlungs- und Versanddetails gezielt abrufen. Zusätzlich kann man den öffentlichen Anzeigenamen für Produktbewertungen und die E-Mail-Adresse des Kontos ändern. Bei Bedarf ist eine nachgelagerte Bestätigung per Opt-in-Token erforderlich. Der komplette Lebenszyklus von Passwörtern wird abgedeckt: vom Ändern des Passworts im eingeloggten Zustand (inklusive optionaler Prüfung der aktuellen E-Mail-Adresse und/oder des bisherigen Passworts) bis hin zum Prozess „Passwort vergessen“ mit Wiederherstellungs-E-Mail und anschließendem Zurücksetzen über einen Opt-in-Token.

GET account/order/list

Mit diesem Aufruf wird die Bestellhistorie des aktuell eingeloggten Kundenkontos angezeigt. Er kann für die „Meine Bestellungen“-Seite im Kundenkonto genutzt werden. Über die Query-Parameter page und size lässt sich die Paginierung steuern (z. B. Seite 1 mit zehn Einträgen). So können Bestellungen seitenweise geladen und komfortabel angezeigt werden. Beispiel-Aufruf, der die Bestellhistorie der Seite 1 mit 10 Einträgen des aktuell eingeloggten Kundenkontos anzeigt

Parameterübersicht

Header-Parameter

Body-Parameter

Beispiel-Response

GET account/order/get

Mit diesem Aufruf werden die Details einer konkreten Bestellung des aktuell eingeloggten Kundenkontos abgerufen, beispielsweise für die Detailseite der Bestellung. Beispiel-Aufruf, der für das aktuell eingeloggte Kundenkonto die Details zur Bestellung mit der ID 4869 abruft

Parameterübersicht

Header-Parameter

Body-Parameter

Beispiel-Response

POST account/displayName/update

Mit diesem Aufruf lässt sich der öffentliche Anzeigename des aktuell eingeloggten Kundenkontos ändern. Dabei handelt es sich um den Namen, der bei Produktbewertungen neben den Rezensionen angezeigt wird. Beispiel-Aufruf, der den öffentlichen Anzeigenamen des aktuell eingeloggten Benutzerkontos auf Name ändert

Beispiel-Request

Parameterübersicht

Header-Parameter

Body-Parameter

Beispiel-Response

Fehlercodes

POST account/email/update

Mit dem folgenden Aufruf kann die E-Mail-Adresse des eingeloggten Kontos geändert werden. Je nach Konfiguration wird anschließend möglicherweise eine E-Mail-Verifizierung ausgelöst. Beispiel-Aufruf, der die E-Mail-Adresse für das aktuell eingeloggte Benutzerkonto auf neue.adresse@example.com ändert

Beispiel-Request

Parameterübersicht

Header-Parameter

Body-Parameter

Fehlercodes

POST account/email/verify

Mit dem folgenden Aufruf wird die E-Mail-Adresse mithilfe des Opt-In-Tokens aus der Bestätigungs-E-Mail bestätigt. Beispiel-Aufruf, der die E-Mail-Adresse mithilfe des Opt-In-Token <OPT_IN_TOKEN> verifiziert

Beispiel-Request

Parameterübersicht

Header-Parameter

Body-Parameter

Beispiel-Response

Fehlercodes

POST account/password/change

Mit diesem Aufruf wird das Passwort des aktuell eingeloggten Kontos geändert. Je nach Shop-Konfiguration kann die Eingabe des aktuellen Passworts erforderlich sein und/oder eine E-Mail-Bestätigung ausgelöst werden. Beispiel-Aufruf, um für das aktuelle Benutzerkonto ein neues Passwort (<NEUES_PASSWORT>) zu setzen

Beispiel-Request

Parameterübersicht

Header-Parameter

Body-Parameter

Beispiel-Response

Fehlercodes

POST account/password/forgotten

Mit dem folgenden Aufruf wird die Passwort-Zurücksetzung für die angegebene E-Mail-Adresse gestartet (es wird eine E-Mail mit weiteren Informationen zum Vorgehen versendet). Beispiel-Aufruf, der den “Passwort vergessen”-Link an die E-Mail-Adresse kunde@example.com sendet

Beispiel-Request

Parameterübersicht

Header-Parameter

Body-Parameter

Fehlercodes

POST account/password/reset

Mit folgendem Aufruf kann das Passwort mithilfe des Opt-In-Tokens aus der „Passwort vergessen“-E-Mail zurückgesetzt werden: Beispiel-Aufruf, der die Passwortrücksetzung für das Kundenkonto mit der E-Mail-Adresse kundenkonto@example.com bestätigt und als neues Passwort password setzt

Beispiel-Response

Parameterübersicht

Header-Parameter

Body-Parameter

Fehlercodes