datafeeds/ ermöglicht es Ihnen, Ihre Datenfeeds zu verwalten. Mit dieser Schnittstelle können Sie bereits erstellte Feeds aktualisieren und löschen oder neue Datenfeeds erstellen.
Unterstützte Methoden
Angabe aller unterstützten Methoden.Datenfelder eines Datenfeeds
Beispiel
Datenfeed-Vorlagen
Beispiel
Methoden für Datenfeeds
In diesem Abschnitt werden alle Endpunkte zur Verwaltung von Datenfeeds im Shopsystem beschrieben. Über die Schnittstelle können Datenfeeds erstellt, abgerufen, aktualisiert, gelöscht und geplant exportiert werden.GET datafeeds
Diese Methode liefert eine paginierte Liste aller im System vorhandenen Datenfeeds.Standardmäßig werden 100 Einträge pro Anfrage zurückgegeben. Über den optionalen Parameter
size kann die Anzahl der zurückgelieferten Datensätze angepasst werden – bis zu einem maximalen Wert von 300. Der size-Wert darf beliebig zwischen 1 und 300 gewählt werden.Die Ergebnisliste kann über definierte Filter- und Sortierparameter gezielt eingeschränkt und geordnet werden. Für den Zugriff ist eine Leseberechtigung für Datenfeeds erforderlich.
Beispiel
Antwort
Filterfelder
id, active, name, fileName, templateId, subshopIds, targetDirectory, exportStatus, lastExportStarted, lastExportFinished, createdAt, updatedAt
Sortierfelder
id, active, name, fileName, templateId, subshopIds, exportStatus, lastExportStarted, lastExportFinished, createdAt, updatedAt
Fehlercodes
GET datafeeds/{id}
Diese Methode ruft die vollständigen Details eines einzelnen Datenfeeds anhand seiner eindeutigen ID ab. Der Endpunkt liefert alle konfigurierten Eigenschaften des Datenfeeds, einschließlich Name, Exportoptionen, Verzeichnisangaben und Statusinformationen. Der Zugriff erfordert die entsprechende Leseberechtigung für Datenfeeds.Beispiel
Antwort
Fehlercodes
PUT datafeeds/{id}
Diese Methode aktualisiert einen bestehenden Datenfeed anhand seiner eindeutigen ID. Daten bleiben bis zur Generierung unverändert. Im Request-Body können verschiedene Eigenschaften des Datenfeeds geändert werden, darunter Name, Status, Dateiname, Exportoptionen und Zielverzeichnisse. Die FeldercreatedAt, updatedAt, lastExportStarted, lastExportFinished und exportStatus können übergeben werden, werden jedoch vom System ignoriert und nicht überschrieben.
Der aktualisierte Datenfeed wird als JSON-Objekt im Response zurückgegeben.
Für die Ausführung sind Schreibberechtigungen erforderlich.
Beispiel
Request Body
Antwort
Fehlercodes
POST datafeeds
Diese Methode erstellt einen neuen Datenfeed. Die Eigenschaften des Datenfeeds, wie Name, Status, Dateiname, Exportoptionen und Zielverzeichnisse, werden über den Request-Body definiert. Die FeldercreatedAt, updatedAt, lastExportStarted, lastExportFinished und exportStatus können zwar übergeben werden, werden jedoch vom System ignoriert und automatisch gesetzt.
Nach erfolgreicher Erstellung wird der vollständige Datenfeed als JSON-Objekt zurückgegeben.
Die Ausführung setzt Erstellberechtigungen voraus.
Beispiel
Request Body
Antwort
Fehlercodes
DELETE datafeeds/{id}
Diese Methode löscht einen bestehenden Datenfeed dauerhaft anhand seiner eindeutigen ID. Der Zugriff auf diesen Endpunkt setzt Löschberechtigungen voraus.Beispiel
Antwort
Fehlercodes
Methoden für Templates der Datenfeeds
In diesem Abschnitt werden die Endpunkte zur Verwaltung von Templates für Datenfeeds beschrieben. Templates definieren die Struktur und die enthaltenen Felder eines Datenfeeds, wie Produktdaten, Kategoriedaten oder weitere Informationen. Vor der Erstellung eines Datenfeeds muss ein passendes Template angelegt werden, da dieses die Grundlage für den späteren Export bildet.GET datafeeds/templates
Diese Methode liefert eine paginierte Liste aller im System vorhandenen Datenfeed-Templates. Über Filter- und Sortierparameter kann die Ergebnisliste eingeschränkt und sortiert werden. Die Templates bilden die Grundlage für die spätere Erstellung von Datenfeeds. Der Zugriff auf diesen Endpunkt erfordert Leseberechtigungen für Datenfeeds.Beispiel
Antwort
Filterfelder
id, name, content, createdAt, updatedAt
Sortierfelder
id, name, content, createdAt, updatedAt
Fehlercodes
GET datafeeds/templates/{id}
Diese Methode ruft die vollständigen Details einer einzelnen Datenfeed-Vorlage anhand ihrer eindeutigen ID ab. Die Antwort enthält die Stammdaten der Vorlage sowie deren inhaltliche Definition. Der Zugriff auf diesen Endpunkt setzt Leseberechtigungen für Datenfeeds voraus.Beispiel
Antwort
Fehlercodes
PUT datafeeds/templates/{id}
Diese Methode aktualisiert eine bestehende Datenfeed-Vorlage anhand ihrer eindeutigen ID. Im Request-Body können der Name und der Inhalt (content) der Vorlage geändert werden. Die Felder createdAt und updatedAt können zwar übergeben werden, werden jedoch vom System automatisch verwaltet und nicht überschrieben.
Nach erfolgreicher Aktualisierung wird die vollständige Vorlage im Response zurückgegeben. Schreibberechtigungen sind erforderlich.
Beispiel
Request Body
Antwort
Fehlercodes
POST datafeeds/templates
Diese Methode erstellt eine neue Datenfeed-Vorlage im System. Im Request-Body müssen der Name der Vorlage sowie deren Inhalt (content) angegeben werden. Die Felder createdAt und updatedAt können übergeben werden, werden jedoch automatisch vom System gesetzt und nicht übernommen.
Nach erfolgreicher Erstellung wird die vollständige Vorlage mit allen zugehörigen Informationen als JSON-Objekt zurückgegeben.
Erstellberechtigungen sind erforderlich.
Beispiel
Request Body
Antwort
Fehlercodes
POST datafeeds/templates/validate
Diese Methode prüft, ob der übergebene Inhalt (content) einer Datenfeed-Vorlage syntaktisch korrekt ist.
Dabei werden mögliche Formatierungsfehler oder Ungültigkeiten erkannt, bevor ein Template gespeichert oder verwendet wird. Der Request-Body muss das Feld content als String enthalten. Die Validierung speichert keine Daten, sondern dient ausschließlich der Überprüfung.
Leseberechtigungen für Datenfeeds sind erforderlich.
Beispiel
Request Body
Antwort
Fehlercodes
DELETE datafeeds/templates/{id}
Diese Methode löscht eine bestehende Datenfeed-Vorlage anhand ihrer eindeutigen ID. Die erfolgreiche Löschung wird durch das JSON-Objekt{"success": true} und den Status-Code bestätigt. Eine Vorlage kann nur gelöscht werden, wenn sie nicht mehr in Verwendung ist.
Für den Zugriff auf diesen Endpunkt sind Löschberechtigungen erforderlich.
Beispiel
Antwort
Fehlercodes
Methoden zur Erstellung (Build) von Datenfeeds
In diesem Abschnitt werden alle Endpunkte beschrieben, die den Build-Prozess von Datenfeeds steuern. Über die Schnittstelle können Build-Prozesse für einzelne oder alle Datenfeeds gestartet, der Status eines laufenden Builds abgefragt sowie zeit- oder importgesteuerte Builds vorbereitet werden. Die Build-Prozesse sorgen dafür, dass aktuelle und vollständige Exportdateien auf Basis der vorhandenen Templates und Daten erzeugt werden.GET datafeeds/build/{id}/status
Diese Methode liefert den aktuellen Status des Build-Prozesses eines Datenfeeds. Sie ermöglicht die Überwachung, ob ein Datenfeed derzeit erstellt wird, bereits abgeschlossen ist, oder, ob beim Erstellen Fehler aufgetreten sind. Jedes Element der Antwort enthältfilePath (relativer Dateipfad) und status (Statusinformationen). Zusätzlich wird das Feld url zurückgegeben, wenn saveTarget des Datenfeeds "contentData" ist.
Für den Zugriff sind Leseberechtigungen für Datenfeeds erforderlich.
Beispiel
Antwort
Fehlercodes
POST datafeeds/build/all
Diese Methode startet den Build-Prozess für alle im System vorhandenen Datenfeeds. Dabei werden sämtliche definierten Datenfeeds neu erstellt. Die Ausführung erfolgt asynchron; der Endpunkt bestätigt lediglich das Starten des Prozesses. Freigabeberechtigungen für Datenfeeds sind erforderlich.Beispiel
Request Body
Antwort
Fehlercodes
POST datafeeds/build/{id}
Diese Methode startet den Build-Prozess für einen bestimmten Datenfeed anhand seiner eindeutigen ID. Dabei wird der ausgewählte Feed neu erstellt. Die Ausführung erfolgt asynchron; der Endpunkt bestätigt lediglich das Starten des Build-Prozesses. Mit dem optionalen Query-ParametersubshopId (kann mehrfach angegeben werden) kann der Build auf bestimmte Subshops eingeschränkt werden.
Freigabeberechtigungen für Datenfeeds sind erforderlich.
Beispiel
Request Body
Antwort
Fehlercodes
POST datafeeds/build/hour/{hour}
Diese Methode startet die Generierung von Datenfeeds, die zu einer bestimmten Stunde generiert werden müssen. Der Pfadparameter{hour} bestimmt die Stunde im 24-Stunden-Format (0 bis 23). Die Generierung erfolgt asynchron – das bedeutet, dass die Antwort keine fertige Datei zurückliefert, sondern lediglich den Start des Prozesses bestätigt.
Freigabeberechtigungen für Datenfeeds sind erforderlich.