Use this file to discover all available pages before exploring further.
Mit dem Endpunkt seo/urls/ stellen wir Ihnen eine Schnittstelle bereit, mit der Sie technische Namen der Shop-Seiten verbergen können und stattdessen klarere Bezeichnungen zu benutzen. Diese können manuell gesetzt oder nach einem Schema generiert werden.
In diesem Abschnitt werden die verfügbaren Endpunkte zur Verwaltung von SEO-URLs beschrieben. Sie ermöglichen das Abfragen, Erzeugen, Überprüfen, Aktualisieren und Löschen von SEO-URLs für Kategorien, Produkte und Templates im Shop-System.Die Nutzung dieser Methoden erfordert entsprechende Berechtigungen für das Lesen oder Bearbeiten von SEO-Daten.
Dieser Endpunkt dient dazu, den aktuellen Status der Generierung von SEO-URLs zu überprüfen. Er gibt an, ob aktuell ein Generierungsprozess läuft ("running": true) oder bereits abgeschlossen ist ("running": false). Dies ist insbesondere hilfreich, wenn nach dem Start eines Generierungsvorgangs auf dessen Abschluss gewartet werden soll, bevor weitere Schritte erfolgen.Für die Nutzung dieses Endpunkts sind entsprechende Leseberechtigungen für SEO-Daten erforderlich.
Der Endpunkt GET seo/urls/categories gibt eine Liste von SEO-URLs für Kategorien zurück.Die Liste kann über Sortier- und Filterparameter eingeschränkt werden. Der optionale Parameter size bestimmt die Anzahl der zurückgegebenen Ergebnisse und muss im Bereich von 1 bis 300 liegen.Für die Nutzung dieses Endpunkts sind entsprechende Berechtigungen zum Lesen von SEO-Daten erforderlich.
Das Beispiel ruft alle SEO-URLs, die zurzeit im Shop verwendet werden und nicht nur gültig sind (main = 1), von Kategorien ab und sortiert die Ergebnisse aufsteigend nach dem Feld resourceIdentifier.
Dieser Endpunkt liefert eine Liste aller SEO-URLs von Produkten. Mithilfe von optionalen Parametern können die Ergebnisse gefiltert und sortiert werden, z. B. nach Erstellungsdatum oder nach Produkt-ID. Der Parameter size steuert die Anzahl der Einträge pro Seite und muss im Bereich 1–300 liegen.Für den Zugriff werden entsprechende Leserechte für SEO-Daten benötigt.
Dieser Endpunkt ruft eine Liste der SEO-URLs für allgemeine Shop-Seiten (z. B. Login, Registrierung) ab. Die Ergebnisse lassen sich über optionale Parameter filtern und sortieren. Der Parameter size legt die maximale Anzahl an Ergebnissen pro Seite fest und muss im Bereich von 1 bis 300 liegen.Für den Zugriff sind entsprechende Leserechte für SEO-Daten erforderlich.
Dieser Endpunkt prüft, ob ein bestimmter SEO-Pfad (seoPath) bereits im System verwendet wird und liefert zusätzliche Informationen zur zugehörigen Ressource zurück. Damit lassen sich etwa potenzielle Kollisionen vor dem Speichern neuer URLs vermeiden.Die Nutzung erfordert Schreibrechte für SEO-Daten.
URLs werden erneut generiert. Optionaler Parameter deleteOld bestimmt, ob alle zurzeit nicht genutzte, aber noch gültige URLs gelöscht werden. Ob eine URL im Shop genutzt wird und nicht einfach nur gültig ist, bestimmt das Feld main.
Dieser Endpunkt startet die (Re-)Generierung einer SEO-URL. Der alte Wert wird nicht gelöscht.Die Nutzung des Endpunkts erfordert Schreibrechte für SEO-Daten.
Mit diesem Endpunkt können Sie eine neue SEO-URL erstellen oder eine bestehende URL aktualisieren. Dabei muss angegeben werden, welchem Controller (viewControllerId) und welchem Objekt (resourceIdentifier) die URL zugeordnet ist. Die URL wird über optimalPathEsc definiert.Der Endpunkt erfordert Schreibrechte für SEO-Daten.
Mit diesem Endpunkt kann eine bestehende SEO-URL entfernt werden. Nach dem Löschen ist die URL nicht mehr erreichbar, und es erfolgt keine automatische Weiterleitung mehr.Der Endpunkt setzt Löschberechtigungen für SEO-Daten voraus.
Bei technischen Fragen und Hilfestellungen ist unser Support-Team für Sie erreichbar: Zum KundenportalBitte senden Sie uns eine möglichst detaillierte Beschreibung sowie Screenshots, Requests/Antworten, damit wir Ihre Anfrage zeitnah und zielführend beantworten können.
