content - Katalog (Kategorien & Produkte)
Der Knoten content bildet die zentrale Konfigurationsebene für alle Inhalte des Katalogs.
Hier werden die Strukturen, Felder und Einstellungen definiert, die zur Verwaltung von Produkten, Kategorien und den dazugehörigen Medien- und Attributsdaten dienen.
Zu den wichtigsten Bereichen gehören:
Kategorien
Definition von Kategoriefeldern, Feldgruppen und ergänzenden Informationen zur Darstellung im Frontend.Produkte
Verwaltung von Produktfeldern, Varianten, Produkttypen und allgemeinen Produkteinstellungen.Medien
Steuerung von Bild- und Videoformaten, Speicherzielen und automatischen Konvertierungsprozessen.Verknüpfungen & Erweiterungen
Zuordnung benutzerdefinierter Felder überusedFields, Definition zusätzlicher Attribute oder Feldgruppen.
Die im Knoten content enthaltenen Konfigurationen bilden somit die Grundlage für sämtliche katalogbasierten Funktionen des Shops – von der Produktdarstellung im Frontend bis zur Datenintegration über die API.
Die einzelnen Konfigurationsbereiche sind im Admin Interface unter verschiedenen Services zu finden (z. B. Katalog → Produkte, Katalog → Kategorien etc.). Sie können auch über die REST API Konfiguration bearbeitet werden.
Inhaltsverzeichnis
- 1 1. content* - Grundstruktur
- 2 2. content.categoryField - Standard-Kategoriefelder
- 3 3. content.categoryFieldGroup - Kategoriefeldgruppen
- 4 4. content.contentFieldDataTypes - Datentypen (oneOf)
- 4.1 4.1 Überblick der verfügbaren Datentypen
- 4.2 4.2 Details & Parametertabellen je Typ
- 4.2.1 4.2.1 bool
- 4.2.2 4.2.2 dateTime
- 4.2.3 4.2.3 enumeration
- 4.2.4 4.2.4 float
- 4.2.5 4.2.5 image
- 4.2.6 4.2.6 integer
- 4.2.7 4.2.7 list
- 4.2.8 4.2.8 map
- 4.2.9 4.2.9 multiFormatImage
- 4.2.10 4.2.10 price
- 4.2.11 4.2.11 text
- 4.2.12 4.2.12 uinteger
- 4.2.13 4.2.13 video
- 5 5. content.customCategoryField - Benutzerdefinierte Kategoriefelder
- 6 6. content.customProductField - Benutzerdefinierte Produktfelder
- 7 7. content.imageFormat - Bildformate & Konvertierungseinstellungen
- 8 8. content.inventory - Lagerverwaltung & Bestandsmeldungen
- 9 9. content.productField - Standard-Produktdatenfelder
- 10 10. content.productSettings - Allgemeine Produkteinstellungen
- 11 11. content.productType - Produkttypen
- 12 12. content.usedFields - Zuordnung benutzerdefinierter Felder
- 13 13. content.videoSettings - Videoeinstellungen für Produkte und Kategorien
1. content* - Grundstruktur
Nachfolgend der Grundaufbau des Knotens contents:
{
"content": {
"categoryFieldGroup": {...},
"categoryField": {...},
"contentFieldDataTypes": {...},
"customCategoryField": {...},
"customProductField": {...},
"imageFormat": {...},
"inventory": {...},
"productAttribute": {...},
"productFieldGroup": {...},
"productField": {...},
"productSettings": {...},
"productType": {...},
"usedFields": {...},
"videoSettings": {...}
}
}
Parameterbeschreibungen
Parameter | Beschreibung |
|---|---|
| Gruppiert Kategoriefelder. |
| Vordefinierte Standardfelder für Kategorien. |
| Zentrale Typendefinitionen für Felder. |
| Eigene (benutzerdefinierte) Kategoriefelder. |
| Eigene Produktfelder für individuelle Datenpunkte. |
| Vorgaben für Bildformate / -größen. |
| Einstellungen zum Bestands- / Verfügbarkeitsmanagement. |
| Verwaltung von Atrributen zur Katalognavigation und Suche. |
| Gruppiert Produktfelder. |
| Vordefinierte Standardfelder für Produkte. |
| Globale Produktschalter & Defauls. |
| Definition von Produkttypen. |
| Nutzungsübersicht der Felder. |
| Vorgaben für Videoeinbindung. |
2. content.categoryField - Standard-Kategoriefelder
Dieser Knoten beschreibt die vordefinierten Systemfelder einer Kategorie. Erstellen oder Löschen zusätzlicher Felder ist an dieser Stelle nicht möglich. Je nach Feld sind bestimmte Eigenschaften editierbar, andere werden ausschließlich vom System geführt.
Bestehende Werte können – sofern das jeweilige Feld editierbar ist – über das Admin Interface (Service „Katalog → Kategorien“) oder über die REST API Konfiguration geändert werden. Systemverwaltete Felder (z. B. Timestamps) sind schreibgeschützt.
Beispielkonfiguration content.categoryField.descr
{
"label": "",
"manualEditable": true,
"name": "descr",
"required": false,
"searchable": false,
"serviceFilter": false,
"type": {
"bool": null,
"dateTime": null,
"enumeration": null,
"float": null,
"image": null,
"integer": null,
"list": null,
"map": null,
"multiFormatImage": null,
"price": null,
"text": {
"maxLength": 4096,
"regex": null,
"searchIndexBehaviour": "notAnalyzed"
},
"uinteger": null,
"video": null
}
}In diesem Beispiel wurde das Feld descr als Kategorie-Beschreibungsfeld definiert, das redaktionell gepflegt werden kann. Es ist nicht suchrelevant und kein Pflichtfeld.
Parameterübersicht
Parameter | Typ | Beschreibung |
|---|---|---|
|
| Systeminterne eindeutige ID des Feldes. Wird automatisch vergeben und ist schreibgeschützt ( |
|
| Anzeigename des Feldes im Admin Interface. Dient der besseren Lesbarkeit und kann angepasst werden, ohne die Funktion des Feldes zu beeinflussen. |
|
| Steuert, ob der Wert dieses Feldes manuell bearbeitet werden darf. |
|
| Technischer Name des Feldes. Muss eindeutig sein. Übersicht der Standardfelder für Kategorien:
|
|
| Markiert das Feld als Pflichtfeld. |
|
| Gibt an, ob der Inhalt des Feldes in der Suchindizierung der Core-Suche berücksichtigt wird. Diese Einstellung hat keine Auswirkung auf das Suchmodul WEBSALE | search. Hier sind separate Anpassungen im Suchmodul selbst notwendig. |
|
| Datentyp des Feldes. Zulässige Werte sind über |
3. content.categoryFieldGroup - Kategoriefeldgruppen
Der Knoten content.categoryFieldGroup dient zur logischen Gruppierung von Kategoriefeldern innerhalb des Katalogs. Da in umfangreichen Shops eine große Anzahl individueller Kategorie-Felder existieren kann, lassen sich diese hier in thematische Gruppen zusammenfassen – etwa für SEO-Daten, Bilder, Marketinginhalte oder Stammdaten.
Die Gruppierung erleichtert die Übersichtlichkeit im Admin Interface und sorgt dafür, dass Felder strukturiert dargestellt werden. Eine Feldgruppe kann mehrere bestehende Felder referenzieren.
Neue Gruppen können aktuell nur über die REST API Konfiguration erstellt werden.
Beispielkonfiguration content.categoryFieldGroup.robots
{
"fields": [
"customCategoryField.robotsNoIndex",
"customCategoryField.robotsNoFollow"
],
"name": "Robots"
}Parameterübersicht
Parameter | Typ | Beschreibung |
|---|---|---|
|
| Anzeigename der Feldgruppe. Dient zur eindeutigen Identifikation und zur Anzeige im Admin Interface. |
|
| Enthält eine Liste der zugehörigen Felder. |
4. content.contentFieldDataTypes - Datentypen (oneOf)
Der Typ contentFieldDataTypes definiert, welcher Datentyp type einem Produkt- und/oder Kategoriedatenfeld zugewiesen wird. Dadurch stellt WEBSALE einheitliche, validierbare Felddefinitionen für Kategorien und Produkte (z. B. „Text mit max. Länge“, „Ganzzahl mit Min/Max“, „Auswahlliste“) zur Verfügung
Es gilt das oneOf-Prinzip: Genau ein Datentyp ist aktiv; alle anderen Typobjekte sind nicht gesetzt (z. B. null oder fehlen).
Beispielkonfiguration für die Zuweisung von Datentypen type bei einem Datenfeld:
{
...
"type": {
"bool": null,
"dateTime": null,
"enumeration": null,
"float": null,
"image": null,
"integer": null,
"list": null,
"map": null,
"multiFormatImage": null,
"price": null,
"text": {
"maxLength": 4096,
"regex": null,
"searchIndexBehaviour": "notAnalyzed"
},
"uinteger": null,
"video": null
}
...
}
4.1 Überblick der verfügbaren Datentypen
int?, uint?, float?, string? bedeuten optional. Wird die Eigenschaft nicht gesetzt, gilt „keine zusätzliche Einschränkung“.
Typname | Eigenschaft (Auszug) | Beschreibung |
|---|---|---|
| - | Wahr/Falsch. In Beschreibungen stets die Wirkung für |
| - | Zeitstempel/Datum-Uhrzeit (ISO-8601). Oft systemgeführt. |
|
| Auswahlliste fester Werte (Whitelist). |
|
| Gleitkommazahl (z. B. Maße, Gewichte). |
| - | Einzelnes Bild (Format/Storage außerhalb festgelegt). |
|
| Signierte Ganzzahl (inkl. negative Werte). |
|
| Geordnete Liste homogener Werte (Typ aus Feldkontext). |
|
| Schlüssel-Wert-Sammlung (Strings → Werte; Größe begrenzen). |
|
| Bildreferenz in mehreren Zielformaten / Breakpoints. |
|
| Preise / Beträge (fachlich wie |
|
| Freitextfeld.
|
|
| Unsignierte Ganzzahl (≥ 0). |
| - | Einzelnes Video (Referenz/Storage außerhalb). |
4.2 Details & Parametertabellen je Typ
4.2.1 bool
Beispiel:
"type": { "bool": {} }
Parameterübersicht
Parameter | Typ | Beschreibung |
|---|---|---|
- | - | Keine zusätzlichen Eigenschaften. Wirkung im Feldkontext klar dokumentieren: |
4.2.2 dateTime
Beispiel:
"type": { "dateTime": {} }
Parameterübersicht
Parameter | Typ | Beschreibung |
|---|---|---|
- | - | Keine zusätzlichen Eigenschaften. Erwartetes Format: ISO-8601 (z. B. Wird häufig systemgeführt (z. B. |
4.2.3 enumeration
Beispiel - Produktzuordnungstyp:
"type": { "enumeration": { "options": ["manual", "rules"] } }
Parameterübersicht
Parameter | Typ | Beschreibung |
|---|---|---|
|
| Liste der zulässigen Werte (Whitelist). Eingaben müssen einem der Einträge entsprechen. |
4.2.4 float
Beispiel – Gewicht in kg:
"type": { "float": { "min": 0.0, "max": 200.0 } }
Parameterübersicht
Parameter | Typ | Beschreibung |
|---|---|---|
|
| Untere Schranke (inklusive). |
|
| Obere Schranke (inklusive). |
4.2.5 image
Beispiel:
"type": { "image": {} }
Parameterübersicht
Parameter | Typ | Beschreibung |
|---|---|---|
- | - | Bildreferenz; Validierung, Größenbeschränkung und Speicherort werden außerhalb definiert (z. B. in |
4.2.6 integer
Beispiel – Bereich −100 … 100:
"type": { "integer": { "min": -100, "max": 100 } }
Parameterübersicht
Parameter | Typ | Beschreibung |
|---|---|---|
|
| Untere Schranke (inklusive). |
|
| Obere Schranke (inklusive). |
4.2.7 list
Beispiel – max. 20 Einträge:
"type": { "list": { "maxEntries": 20 } }
Parameterübersicht
Parameter | Typ | Beschreibung |
|---|---|---|
|
| Maximale Anzahl der Listeneinträge. |
4.2.8 map
Beispiel – Key-Value-Struktur für Eigenschaften:
"type": { "map": { "maxEntries": 50 } }
Parameterübersicht
Parameter | Typ | Beschreibung |
|---|---|---|
|
| Maximale Anzahl der Schlüssel-Wert-Paare. |
4.2.9 multiFormatImage
Beispiel – Zwei Ausgabeformate:
"type": {
"multiFormatImage": {
"imageFormats": ["thumb_1x1", "hero_16x9"]
}
}
Parameterübersicht
Parameter | Typ | Beschreibung |
|---|---|---|
|
|
© 2025 WEBSALE AG | Impressum | Datenschutz