Kategorien („categories“)

Kategorien werden in allen konfigurierten Sprachen übertragen. Kategoriebilder liegen auf einem externen Bilderspeicher (SFTP oder Amazon S3). Als Bildangaben sind immer alle zum Basisordner relativen Pfadangaben anzugeben.

Beispiel für Kategorien in nur 1 Sprache (scopeId = "default"):

{
  "categories": {
    "default": [
      {
        "id": "1",
        "name": "Hauptkategorie",
        "parent_id": "0",
        "position": 1,
        "visible": true,
        "image": "http://cdnmax938.maxcdn.com/saalhsf/1.jpg",
        "description": "Beschreibung Hauptkategorie"
      },
      {
        "id": "2",
        "name": "Unterkategorie",
        "parent_id": "1",
        "position": 1,
        "visible": true
      },
      {
        "id": "3",
        "name": "Unterkategorie 2",
        "parent_id": "1",
        "position": 2,
        "visible": true
      }
    ]
  }
}

Beispiel für Kategorien in zwei Sprachen "de" (Deutsch) und "en" (Englisch) mit den gleichnamigen scopeIds:

{
  "categories": {
    "en": [
      {
        "id": "1",
        "name": "Main category",
        "parent_id": "0",
        "position": 1,
        "visible": true
      },
      {
        "id": "2",
        "name": "Sub category",
        "parent_id": "1",
        "position": 1,
        "visible": true
      },
      {
        "id": "3",
        "name": "Sub category 2",
        "parent_id": "1",
        "position": 2,
        "visible": true
      }
    ],
    "de": [
      {
        "id": "1",
        "name": "Hauptkategorie",
        "parent_id": "0",
        "position": 1,
        "visible": true
      },
      {
        "id": "2",
        "name": "Unterkategorie",
        "parent_id": "1",
        "position": 1,
        "visible": true
      },
      {
        "id": "3",
        "name": "Unterkategorie 2",
        "parent_id": "1",
        "position": 2,
        "visible": true
      }
    ]
  }
}

Aufbau

"categories": {
  "scopeId": **array of** `CategoryObject`,
  "scopeId": **array of** `CategoryObject`,...
}

CategoryObject:

Property name	Description	Definition
id	Eindeutiger Schlüssel für Kategorie	alphanumeric string, unique, max 255 characters
name	Kategoriename	string (utf8), max 255 characters
parent_id	Referenz auf einen eindeutigen Schlüssel einer Kategorie	alphanumeric string
position	Position/Reihenfolge der Kategorie innerhalb der Hierarchie (Elemente mit gleichem parent_id)	numeric, unsigned int
visible	true=Kategorie ist sichtbar im Menü, false=Kategorie ist nicht sichtbar im Menü	boolean
image	relativer Pfad zum Kategorie-Bild am Bilderspeicher	url, optional

Mapping Tabelle, Anforderungen onRetail

CategoryObject:

JSON API FELD	Transformation	onRetail Datenquelle	Anpassung	Aufwand
id	1:1	product.public.category.id	-	#0f0
name	1:1	product.public.category.name	Begrenzung auf 255 Zeichen, HTML Sonderzeichen filtern	#0f0
parent_id	1:1	product.public.category.parent_id	-	#0f0
position	1:1	product.public.category.sequence	-	#0f0
visible	1:1	-	visible Attribut zur Kategorie hinzufügen	#ff0
image	1:1	product.public.category.image	-	#0f0