Feld-Mapping Dokumentation: reybex → Ecwid

Übersicht

Diese Dokumentation beschreibt, welche Felder von reybex nach Ecwid übertragen werden und wie sie gemappt werden. Die Übertragung erfolgt über die Ecwid REST API.

⚠️ WICHTIGER HINWEIS

Diese Dokumentation unterliegt kontinuierlichen Änderungen.

Die Integration zwischen reybex und Ecwid befindet sich in ständiger Entwicklung. Daher kann es vorkommen, dass:

Neue Felder hinzugefügt werden - Um zusätzliche Funktionen zu unterstützen oder neue Ecwid-Features zu nutzen
Felder temporär entfernt werden - Wenn unerwartete Probleme auftreten, die negative Auswirkungen auf die Artikel haben

Empfehlung:
Bitte überprüfen Sie regelmäßig die aktuelle Dokumentation und testen Sie Änderungen in einer Testumgebung, bevor Sie sie in der Produktion einsetzen.

Verwendung dieser Dokumentation

Diese Dokumentation zeigt, welche Felder von reybex nach Ecwid übertragen werden. Für jedes Ecwid-Feld wird angegeben:
- Welches reybex-Feld die Quelle ist
- Unter welcher Bedingung es übertragen wird (Export-Gruppe)
- Besondere Hinweise zur Übertragung

Wichtige Konzepte

reybex-Artikelstruktur

Material: Ein Artikel/Produkt in reybex (entspricht Ecwid Product)
MaterialVariant: Eine Variante eines Artikels in reybex (z.B. Größe, Farbe)
MaterialMarktplace: Marktplatz-spezifische Einstellungen für einen Artikel

Ecwid-Produktstruktur

Product: Das Hauptprodukt in Ecwid
Product Class: Produktklasse mit Attributen
Combinations: Varianten-Kombinationen

1. Produkt-Felder (Product Level)

Die folgenden Felder werden auf Produktebene in Ecwid übertragen:

1.1 Basis-Informationen

Ecwid Feld	reybex Feld	Beschreibung	Bedingung
`product.name`	`material.name`	Produktname	Export-Gruppe: ARTIKEL_DATA
`product.sku`	`material.marketplaceSku`	Artikelnummer	Immer
`product.weight`	`material.grossWeight`	Gewicht	Export-Gruppe: ARTIKEL_DATA
`product.dimensions.length`	`material.length`	Länge	Immer
`product.dimensions.width`	`material.width`	Breite	Immer
`product.dimensions.height`	`material.height`	Höhe	Immer
`product.enabled`	Immer `true`	Aktiv-Status	Immer
`product.warningLimit`	`material.reorderStockLevel`	Nachbestellgrenze	Immer
`product.unlimited`	`!material.stock.value`	Unbegrenzter Bestand	Immer
`product.productClassId`	Automatisch erstellt/gesucht	Produktklassen-ID	Immer

1.2 Beschreibung

Ecwid Feld	reybex Feld	Beschreibung	Bedingung
`product.description`	`material.description`	Kurzbeschreibung	Export-Gruppe: DESCRIPTION
`product.descriptionTranslated[]`	`material.translations[].description`	Übersetzte Beschreibungen	Export-Gruppe: DESCRIPTION

Hinweise:
- Format: {DE: "Text", EN: "Text", ...}

1.3 SEO-Felder

Ecwid Feld	reybex Feld	Beschreibung	Bedingung
`product.seoTitle`	`material.seoTitle`	SEO-Titel	Export-Gruppe: SEO
`product.seoDescription`	`material.seoDescription`	SEO-Beschreibung	Export-Gruppe: SEO

1.4 Preise

Ecwid Feld	reybex Feld	Beschreibung	Bedingung
`product.price`	`material.price.value`	Verkaufspreis	Export-Gruppe: PRICE
`product.compareToPrice`	`material.price.rrp`	Vergleichspreis/UVP	Export-Gruppe: PRICE

1.5 Bestand

Ecwid Feld	reybex Feld	Beschreibung	Bedingung
`product.quantity`	`material.stock.value`	Bestand	Export-Gruppe: STOCK

1.6 Kategorien

Ecwid Feld	reybex Feld	Beschreibung	Bedingung
`product.categoryIds[]`	`material.categories[].id`	Kategorien (als IDs)	Export-Gruppe: CATEGORY

1.7 Steuern

Ecwid Feld	reybex Feld	Beschreibung	Bedingung
`product.tax.enabledManualTaxes[]`	`material.vatKeyCode` (gesucht in taxes)	Steuerklassen-IDs	Export-Gruppe: ARTIKEL_DATA

Hinweise:
- Steuerklassen werden anhand vatKeyCode gesucht
- Format: [taxId]

1.8 Attribute

Ecwid Feld	reybex Feld	Beschreibung	Bedingung
`product.attributes[]`	`material.brand.name` und `material.gtin`	Produktattribute	Export-Gruppe: ARTIKEL_DATA

Hinweise:
- Marke wird als BRAND Attribut übertragen
- GTIN wird als UPC Attribut übertragen
- Format: [{id: X, alias: "BRAND", value: "Marke"}, {id: Y, alias: "UPC", value: "GTIN"}]

1.9 Bilder

Ecwid Feld	reybex Feld	Beschreibung	Bedingung
`product.images[]`	`material.images[]`	Produktbilder	Export-Gruppe: IMAGE

Hinweise:
- Bilder werden über separate API-Calls hochgeladen
- Verwendet uploadImage() oder uploadNewFileImage() Methoden

1.10 Varianten-Optionen

Ecwid Feld	reybex Feld	Beschreibung	Bedingung
`product.options[]`	`material.variants.items[].nameValuePairs`	Varianten-Optionen	Export-Gruppe: VARIANT

Option-Format:
- {type: "SELECT", name: "X", choices: [{text: "Y", ...}], required: false, defaultChoice: 0}

2. Varianten-Felder (Combinations)

Die folgenden Felder werden auf Variantenebene in Ecwid übertragen:

2.1 Basis-Informationen

Ecwid Feld	reybex Feld	Beschreibung	Bedingung
`combination.sku`	`variant.sku`	Varianten-SKU	Export-Gruppe: VARIANT
`combination.options[]`	`variant.nameValuePairs[]`	Varianten-Optionen	Export-Gruppe: VARIANT

2.2 Preise

Ecwid Feld	reybex Feld	Beschreibung	Bedingung
`combination.price`	`variant.price.value`	Variantenpreis	Export-Gruppe: VARIANT
`combination.compareToPrice`	`variant.prices.rrp[0]`	Varianten-UVP	Export-Gruppe: VARIANT

2.3 Bestand

Ecwid Feld	reybex Feld	Beschreibung	Bedingung
`combination.quantity`	`variant.stock`	Variantenbestand	Export-Gruppe: VARIANT

3. Export-Felder-Gruppen

Die Übertragung wird durch Export-Felder-Gruppen gesteuert:

Export-Gruppe	Beschreibung	Übertragene Ecwid-Felder
ARTIKEL_DATA	Artikeldaten	`name`, `weight`, `tax.enabledManualTaxes`, `attributes`
DESCRIPTION	Beschreibung	`description`, `descriptionTranslated[]`
SEO	SEO-Felder	`seoTitle`, `seoDescription`
PRICE	Preis	`price`, `compareToPrice`
STOCK	Bestand	`quantity`
CATEGORY	Kategorien	`categoryIds[]`
IMAGE	Bilder	`images[]`
VARIANT	Varianten	`options[]`, `combinations[]`

4. Besondere Verhaltensweisen

4.1 REST API

Ecwid verwendet REST API für alle Operationen:
- Produkt-Erstellung: POST /products (JSON)
- Produkt-Update: PUT /products/{productId} (JSON)
- Varianten-Erstellung: POST /products/{productId}/combinations (JSON)

4.2 Produktklassen-Verwaltung

Produktklassen werden automatisch erstellt, wenn sie nicht existieren
Verwendet updateAttribute() Methode
Format: {name: "X", attributes: [{name: "Y", type: "CUSTOM", show: "DESCR"}]}

4.3 Varianten-Verwaltung

Varianten werden als combinations übertragen
Optionen werden automatisch erstellt, wenn sie nicht existieren
Verwendet getProductOptions() und getVariantOption() Methoden

4.4 Bild-Upload

Bilder werden über separate API-Calls hochgeladen
Verwendet uploadImage() oder uploadNewFileImage() Methoden

4.5 Steuerklassen

Steuerklassen werden anhand vatKeyCode gesucht
Verwendet getStoreTaxes() Methode
Format: [taxId]

5. Zusammenfassung: Vollständige Feld-Mappings

Produkt-Ebene

Ecwid Feld	reybex Feld	Export-Gruppe	Hinweise
`name`	`material.name`	ARTIKEL_DATA	-
`sku`	`material.marketplaceSku`	Immer	-
`weight`	`material.grossWeight`	ARTIKEL_DATA	-
`dimensions.length`	`material.length`	Immer	-
`dimensions.width`	`material.width`	Immer	-
`dimensions.height`	`material.height`	Immer	-
`enabled`	Immer `true`	Immer	-
`warningLimit`	`material.reorderStockLevel`	Immer	-
`unlimited`	`!material.stock.value`	Immer	-
`productClassId`	Automatisch erstellt/gesucht	Immer	-
`description`	`material.description`	DESCRIPTION	-
`descriptionTranslated[]`	`material.translations[].description`	DESCRIPTION	Mehrsprachig
`seoTitle`	`material.seoTitle`	SEO	-
`seoDescription`	`material.seoDescription`	SEO	-
`price`	`material.price.value`	PRICE	-
`compareToPrice`	`material.price.rrp`	PRICE	-
`quantity`	`material.stock.value`	STOCK	-
`categoryIds[]`	`material.categories[].id`	CATEGORY	-
`tax.enabledManualTaxes[]`	`material.vatKeyCode` (gesucht)	ARTIKEL_DATA	-
`attributes[]`	`material.brand.name` und `gtin`	ARTIKEL_DATA	-
`images[]`	`material.images[]`	IMAGE	-
`options[]`	`material.variants.items[].nameValuePairs`	VARIANT	-

Varianten-Ebene

Ecwid Feld	reybex Feld	Export-Gruppe	Hinweise
`sku`	`variant.sku`	VARIANT	-
`options[]`	`variant.nameValuePairs[]`	VARIANT	-
`price`	`variant.price.value`	VARIANT	-
`compareToPrice`	`variant.prices.rrp[0]`	VARIANT	-
`quantity`	`variant.stock`	VARIANT	-

6. API-Endpunkte

Produkt-Erstellung: POST /products (JSON)
Produkt-Update: PUT /products/{productId} (JSON)
Varianten-Erstellung: POST /products/{productId}/combinations (JSON)
Produktklassen: GET /classes, POST /classes, PUT /classes/{classId}
Steuern: GET /taxes

Version: 1.0
Erstellt: 2024
Zielgruppe: Externe Nutzer ohne reybex-Kenntnisse

← Zurück zur Übersicht