Zur Übertragung Ihrer Daten bieten wir mehrere mögliche Formate an. Wir empfehlen Ihnen den Einsatz einer SOAP-Schnittstelle, um Daten mittels PUSH-Nachrichten direkt im Online-Shop aktuell zu halten.
SOAP ist ein Protokoll zum Austausch XML basierter Nachrichten zwischen Servern und kann sowohl zur Definition der Datenkommunikation, der Funktionen und der Nachrichteninhalte verwendet werden.
Wenn Ihr Server / Ihre Applikation keinen Datenaustausch via SOAP unterstützen sollte, so bieten wir als Alternative auch die Datenübertragung über reine XML-Dokumente an.
Sollte Ihr System weder SOAP noch XML unterstützen, können wir alle Informationen alternativ auch in einer CSV-Datei austauschen. Bei Verwendung einer CSV-Datei ist jedoch darauf zu achten, dass alle Refernzierungen angegeben werden. Bitte nehmen Sie vorab Kontakt mit uns auf, um die Namenskonventionen abzuklären.
Für die Orientierung im Online-Shop muss zunächst ein thematischer Katalog eingerichtet werden. Dieser ist auch unter der Bezeichnung "Themenbaum" bekannt. Jeder Artikel muss, damit er im Shop gefunden wird, einem Zweig zugeordnet werden. Die Äste des Themenbaums können in beliebige Tiefe mehrstufig aufgebaut werden.
Als Root-Element verwenden Sie das XML-Element catalog_product_groups.
| Bezeichnung | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| catalog_product_group | catalog_product_group | 1 ... * | Produktgruppe |
| Eigenschaft | Werte | Vorkommen | Beschreibung |
|---|---|---|---|
| ProductGroupID | string | 1 | Produkt-Gruppen-Nummer |
| ParentGroupID | string | 1 | Die übergeordnete Produktgruppen ID |
| Bezeichnung | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| ProductGroupName | multilingual_string | 1 ... * | Bezeichnung der Produktgruppe |
Schnittstellen-Beschreibung zur Aktualisierung Ihrer Produktdaten im Online-Shop. Boolesche Werte werden als "true" bzw. als "false" definiert, sofern im Beispiel nicht anders beschrieben.
Als Root-Element verwenden Sie das XML-Element products.
| Bezeichnung | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| product | product | 1 ... * | Produkt |
| Eigenschaft | Werte | Vorkommen | Beschreibung |
|---|---|---|---|
| ProductID | string | 1 | Ihre interne eindeutige Produkt-Bezeichnung. Diese Bezeichnung definiert alle möglichen Angaben zum Produkt unter einer einheiltichen Kennung |
| EAN | string | 0 ... 1 | EAN-Code |
| ShowArticle | boolean | 1 | Definiert, ob der Artikel im Shop dargestellt werden soll z.B. true / false |
| BaseProductID | string | 0 ... 1 | Referenz-Produkt-Bezeichnung, wenn es sich um ein und den selben Artikel handelt, jedoch dieser unterschiedliche ProductFacts aufweist oder in unterschliedlichen Verpackungsmengen geliefert wird |
| mode | new update |
1 | new: Dieser Datensatz wird vollständig spezifiziert update: Bei diesem Datensatz handelt es sich um ein Delta-Update |
| Bezeichnung | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| ProductGroups | product_groups | 0 ... 1 | Produktgruppen, wo dieses Produkt gelistet werden soll |
| ProductFacts | product_facts | 0 ... 1 | Merkmale des Produkts |
| SalePrice | price | 1 ... 4 | Verkaufspreis |
| SpecialSalePrice | price | 0 ... 4 | Sonderverkaufspreis |
| ContentNetWeight | content_net_weight | 0 ... 1 | Inhaltsangabe pro Stück |
| Packaging | packaging | 1 | Verpackungsinhalt |
| Media | media | 0 ... 1 | Mediadaten |
| ShippingDestinations | shipping_destinations | 0 ... 1 | Zu beliefernde Länder |
| StockInformations | stock_informations | 0 ... 1 | Informationen zum aktuellen Lagerstand |
| Keywords | keywords | 0 ... 1 | Synonym-Tabelle zur Auffindung des Artikels bei Volltext-Suche |
| Accessories | accessories | 0 ... 1 | Zubehörartikel |
Wenn keine "BaseProductID" definiert wurde, sind folgende Felder zu spezifizieren:
| Bezeichnung | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| ProductName | multilingual_string | 1 ... * | Aussagekräftige Artikelbezeichnung zur Darstellung im Online-Shop |
| BriefDescription | multilingual_string | 1 ... * | Die Kurzbeschreibung sollte 250 Zeichen nicht überschreiten und werblich getextet sein, damit sie den Käufer dazu verleiten auf die Detailseite zu klicken. |
| LongDescription | multilingual_string | 1 ... * | Detailierte Beschreibung des beworbenen Produkts. Der Text sollte alle entscheidungsrelevanten Themen behandeln. Dem Kunden sollen hier alle Fragen über Wirkung, Vorteile, Hinweise und Contra-Indikationen beantwortet werden. |
| Bezeichnung | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| ProductGroupID | string | 1 ... * | Referenz-Bezeichnung zum Themenbaum |
| Bezeichnung | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| color | multilingual_string | 0 ... 1 | Farbbezeichnung z.B. rot |
| size | multilingual_string | 0 ... 1 | Größe des Artikels z.B. XXL |
| net_content_weight_litre | float | 0 ... 1 | Inhaltsangabe in Liter z.B. 1.000 |
| net_weight | integer | 0 ... 1 | Inhaltsangabe in Gramm z.B. 750 |
| shipping_units | integer | 0 ... 1 | Grund-Verpackungsinhalt z.B. 6 |
| Eigenschaft | Werte | Vorkommen | Beschreibung |
|---|---|---|---|
| type | list_net list_gros suggested_retail_price |
1 | Preistyp |
| currency | string | 1 | Währung |
| Datentyp |
|---|
| float |
| Eigenschaft | Werte | Vorkommen | Beschreibung |
|---|---|---|---|
| relation | g ml |
1 | Typ der Inhaltsangabe |
| Datentyp |
|---|
| float |
| Eigenschaft | Werte | Vorkommen | Beschreibung |
|---|---|---|---|
| type | unit cardboard pallet |
1 | Typ der Verpackung. Wenn Sie Einzelstücke liefern, dann handelt es sich immer um die Angabe "unit". Sobald von einem Produkt mehrere Stück zusammen verkauft werden, muss zwischen Karton und Palette unterschieden werden |
| Bezeichnung | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| PackagingUnits | integer | 1 | Anzahl der Artikel in einer Verpackung z.B. 1 |
| UnitType | unit bowl bottle |
1 | Welche Einheit wird verpackt z.B. unit |
| Eigenschaft | Werte | Vorkommen | Beschreibung |
|---|---|---|---|
| type | handbook datasheet picture |
1 | Typ der angegebenen Datei |
| lang | ISO-639-1 |
0 ... 1 | Sprache |
| Datentyp |
|---|
| string |
| Bezeichnung | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| Destination | shipping_destination | 1 |
| Eigenschaft | Werte | Vorkommen | Beschreibung |
|---|---|---|---|
| country | ISO-3166 | 1 | Länderbezeichnung |
| Bezeichnung | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| ShippingCost | shipping_cost | 0 ... 1 | Individuelle Versandkosten. Bei Verwendung dieser Funktion wird dieser Artikel beim Versand separat berechnet |
| Bezeichnung | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| PayRollType | lump_sum per_unit |
1 | lump_sum: einmalige Versandkosten - egal wieviele Artikel bestellt werden per_unit: Versandkosten multipliziert mit der bestellten Menge des Artikels |
| Cost | float | 1 | Versandkosten |
| Bezeichnung | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| StockQuantity | integer | 1 | Aktuelle Lagerstückzahl die sofort lieferbar ist |
| DisplayStockQuantity | quanity indicator |
0 ... 1 | quantity: Anzeige der Stückzahlen indicator: Anzeige eines Textes wie z.B. Sofort lieferbar |
| Dispatch | dispatch | 1 | Reaktionszeit |
| Eigenschaft | Werte | Vorkommen | Beschreibung |
|---|---|---|---|
| type | immediately dispatch_date delayed_dispatch |
1 | Reaktionszeitbeschreibung |
Im Falle des Typen "dispatch_date" sind folgende Felder zu spezifizieren:
| Bezeichnung | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| date | YYYY-MM-DD | 0 ... 1 | Datum, wann der Versand erfolgen kann |
Im Falle des Typen "delayed_dispatch" sind folgende Felder zu spezifizieren:
| Bezeichnung | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| amount | integer | 0 ... 1 | Anzahl z.B. 5 |
| relation | days months weeks |
0 ... 1 | days: Tage months: Monate week: Wochen |
Unser Online-Shop-System zeigt automatisch <= 10 Artikel auf Lager bereits eine Meldung an, dass nur noch wenige Exemplare verfügbar sind. Sobald die Lagerstückzahl <= 5 erreicht, wird der Kunde auf eine eventuell verzögerte Lieferung hingewiesen.
| Beispiele: | Leeres Lager + Artikel direkt vom Außenlager lieferbar |
Leeres Lager + Artikel direkt vom Außenlager lieferbar, Lieferzeit unbekannt |
|
Leeres Lager + Artikel direkt vom Außenlager lieferbar, Lieferzeit bekannt ( 5 Tage ) |
|
Leeres Lager + Artikel im Außenlager bestellt, Liefertermin unbekannt |
|
Leeres Lager + Artikel im Außenlager bestellt, Liefertermin bekannt (22.12.2009) |
| Bezeichnung | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| keyword | multilingual_string | 1 ... * | Synonym |
| Bezeichnung | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| ProductID | string | 1 ... * | Eindeutige Produkt-Bezeichnung |
| Eigenschaft | Werte | Vorkommen | Beschreibung |
|---|---|---|---|
| lang | ISO-639-1 | 0 ... 1 | Sprache |
| Datentyp |
|---|
| string |
Nach Abschluss des Warenkorbs übermitteln wir die Bestellinformationen an Ihr System. Wenn Ihr System "unbezahlte Bestellungen" nicht verwalten kann, können wir Ihrem System die Bestellinformationen erst dann übermitteln, wenn der Zahlungseingang im Online-Shop verbucht wurde.
Als Root-Element verwenden Sie das XML-Element orders.
| Bezeichnung | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| order | order | 1 | Bestellung |
| Eigenschaft | Werte | Vorkommen | Beschreibung |
|---|---|---|---|
| order_id | integer | 1 | Bestellnummer des Online-Shop-Systems |
| Bezeichnung | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| Address | contact | 1 | Adresse des Bestellers |
| SellingOnlineShop | onlineshop | 1 | Informationen über den Online-Shop auf dem die Bestellung getätigt wurde |
| Seller | contact | 1 | Verkäufer |
| Shipping | shipping | 1 | Ausgewählter Versand |
| Payment | payment | 1 | Ausgewählte Zahlungsart |
| InvoiceItems | invoicelist | 1 | Rechnungsdaten |
| Eigenschaft | Werte | Vorkommen | Beschreibung |
|---|---|---|---|
| type | commercial individual |
1 | commercial: Gewerblicher Kunde individual: Privatkunde |
| Bezeichnung | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| sex | female male |
1 | female: Frau male: Herr |
| firstname | string | 1 | Vorname |
| surname | string | 1 | Nachname |
| street | string | 1 | Straße |
| country | ISO-3166 | 1 | Land |
| zip | string | 1 | Postleitzahl |
| city | string | 1 | Ort |
| phone | string | 0 ... 1 | Telefonnummer |
| cellphone | string | 0 ... 1 | Mobiltelefonnummer |
| email_address | string | 0 ... 1 | eMail-Adresse |
Im Falle des Typen "commercial", müssen folgende Felder zusätzlich übertragen werden:
| Bezeichnung | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| company_name | string | 1 | Firmenbezeichnung |
| Bezeichnung | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| url | string | 1 | URL zum Online-Shop |
| operator | contact | 1 | Betreiber des Online-Shops |
| Eigenschaft | Werte | Vorkommen | Beschreibung |
|---|---|---|---|
| type | parcel_service pickup_at_store |
1 | parcel_service: Versand pickup_at_store: Abholung im Geschäft |
Im Falle des Typen "parcel_service" sind folgende Felder zu spezifizieren:
| Bezeichnung | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| delivery_address | contact | 1 | Versandadresse |
| parcel_service_name | string | 1 | Ausgewählter Dienstleister |
| packages | packages | 1 | Paketzusammenstellung |
Im Falle des Typen "pickup_at_store" sind folgende Felder zu spezifizieren:
| Bezeichnung | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| pickup_point | contact | 1 | Adresse, wo die Ware abgeholt wird |
| Bezeichnung | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| packet | package | 1 ... * |
| Eigenschaft | Werte | Vorkommen | Beschreibung |
|---|---|---|---|
| paket_id | integer | 1 | Eindeutige Bezeichnung des Pakets |
| Bezeichnung | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| item | parcel_item | 1 ... * | Paketinhalt |
| Eigenschaft | Werte | Vorkommen | Beschreibung |
|---|---|---|---|
| product_id | string | 1 | Eindeutige Produktbezeichnung |
| shipping_quantity | integer | 1 | Zu versendende Menge |
| Eigenschaft | Werte | Vorkommen | Beschreibung |
|---|---|---|---|
| type | prepayment directdebit invoice paypal cash_on_pickup cash_on_delivery |
1 | prepayment: Vorauskasse-Zahlung directdebit: Lastschriftverfahren invoice: Rechnung paypal: PayPAL cash_on_pickup: Zahlung bei Abholung case_on_delivery: Nachnahme-Zahlung |
Im Falle des Typen "prepayment" werden zusätzlich die anvisierten Bankdaten übermittelt:
| Bezeichnung | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| account_holder | string | 1 | Kontoinhaber |
| account_number | string | 1 | Kontonummer |
| bank_name | string | 1 | Name der Bank |
| bank_identification_number | string | 1 | Bankleitzahl |
| bank_identification_code | string | 0 ... 1 | BIC für SEPA-Überweisungen |
| international_account_number | string | 0 ... 1 | IBAN für SEPA-Überweisungen |
Im Falle des Typen "directdebit" werden zusätzich die angegebenen Bankdaten übermittelt:
| Bezeichnung | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| account_holder | string | 1 | Kontoinhaber |
| account_number | string | 1 | Kontonummer |
| bank_name | string | 1 | Name der Bank |
| bank_identification_number | string | 1 | Bankleitzahl |
Im Falle des Typen "paypal" werden zusätzich die verwendeten PayPAL-Daten übermittelt:
| Bezeichnung | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| paypal_account_name | string | 1 | eMail-Adresse des PayPAL Accounts |
| Eigenschaft | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| invoice_number | string | 0 ... 1 | Rechnungsnummer, wenn diese vom System erstellt wurde |
| currency | ISO-4217 | 1 | Währung |
| total_amount_net | float | 1 | Netto-Summe |
| total_amount_gros | float | 1 | Brutto-Summe |
| Bezeichnung | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| item | invoiceitem | 1 | Rechnungszeile |
| Eigenschaft | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| type | product shipping_handling_charge payment_handling_charge minimum_order_value_surcharge prepayment_discount gift |
1 | product: Produkt shipping_handling_charge: Versand Zusatzgebühr payment_handling_charge: Zahlungsart Zusatzgebühr minimum_order_value_surcharge: Mindestbestellsumme unt. prepayment_discount: Rabatt auf Vorauskassezahlung gift: Gutschein |
| vat | float | 1 | Angewandter Mehrwertsteuersatz |
| quantity | integer | 1 | Bestellmenge |
| unit_price_gros | float | 1 | Einzelstückpreis |
| total_price_gros | float | 1 | Gesamtpreis |
| tax | float | 1 | Im Gesamtpreis enthaltene Mehrwertsteuer |
| Datentyp |
|---|
| string |
Im Falle des Typen "product" werden zusätzlich folgende Informationen mit übertragen:
| Eigenschaft | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| product_id | string | 1 | Eindeutige Produkt-Bezeichnung |
Im Falle des Typen "shipping_handling_charge" werden zusätzlich folgende Informationen mit übertragen:
| Eigenschaft | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| packet_id | integer | 1 | Eindeutige Paket-Bezeichnung |
Im Falle des Typen "prepayment_discount" werden zusätzlich folgende Informationen mit übertragen:
| Eigenschaft | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| prepayment_discount_percentage | float | 1 | Prozentueller Nachlass |
Im Falle des Typen "gift" werden zusätzlich folgende Informationen mit übertragen:
| Eigenschaft | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| gift_code | string | 1 | Verwendeter Gutschein-Code |
| gift_percentage | float | 0 ... 1 | Prozentueller Nachlass |
Sobald sich ein Auftragsstatus oder ein Lieferscheistatus sich ändert, sind diese Informationen entsprechend mit Ihrem, sowie mit dem Online-Shop-System abzugleichen. Entsprechend sind folgende Datenaustausch-Dokumente definiert:
Als Root-Element verwenden Sie das XML-Element status_changes.
| Bezeichnung | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| status | status | 1 | Auftragsstatus |
| Eigenschaft | Werte | Vorkommen | Beschreibung |
|---|---|---|---|
| order_id | integer | 1 | Bestellnummer des Online-Shop-Systems |
| type | order delivery_bill |
1 | order: Bestellung delivery_bill: Lieferschein |
| status | cancled | 1 | cancled: Bestellung storniert |
Im Falle des Typen "order" werden zusätzlich folgende Informationen mit übertragen:
| Eigenschaft | Werte | Vorkommen | Beschreibung |
|---|---|---|---|
| status | cash_received | 1 | cash_received: Geldeingang verbucht |
Im Falle des Typen "delivery_bill" werden zusätzlich folgende Informationen mit übertragen:
| Eigenschaft | Werte | Vorkommen | Beschreibung |
|---|---|---|---|
| delivery_bill_id | integer | 1 | Lieferschein-Nummer |
| status | pickupRequestedProducts readyForShipping onWay |
1 | pickupRequestedProducts: Waren werden Kommissioniert readyForShipping: Paket wurde verpackt und steht zur Auslieferung bereit onWay: Paket ist auf dem Weg zum Kunden |
Im Falle des Status "cash_received" werden zusätzlich folgende Informationen mit übertragen:
| Bezeichnung | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| amount | float | 0 ... 1 | Verbuchter Eingangsbetrag |
Im Falle des Status "cancled" werden zusätzlich folgende Informationen mit übertragen:
| Bezeichnung | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| reason | string | 0 ... 1 | Grund der Stornierung |
Im Falle des Status "readyForShipping" und "onWay" werden zusätzlich folgende Informationen mit übertragen:
| Bezeichnung | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| parcel_service | string | 0 ... 1 | Anvisierter Versandservice |
| tracking_id | string | 0 ... 1 | Vom Transportunternehmen mitgeteilte Sendungsverfolgungsnummer |
| shipping_date | YYYY-MM-DD | 0 ... 1 | Anvisiertes Datum, wann der Paketdienst das Paket abholen wird |
| weight | float | 0 ... 1 | Gewicht des versendeten Pakets |
| dispatcher | string | 0 ... 1 | Name der Person, die für die Abfertigung des Pakets zuständig war |
Sobald ein Kunde seinen Einkauf abgeschlossen hat, übermitteln wir Ihnen die zu reservierenden Produkte.
Als Root-Element verwenden Sie das XML-Element reservations.
| Bezeichnung | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| reservation | reservation | 1 | Reservierung |
| Eigenschaft | Werte | Vorkommen | Beschreibung |
|---|---|---|---|
| reservation_id | string | 1 | Eindeutige Identifizierung der Reservierung eines einzigen Produkts |
| mode | add change remove |
1 | add: Neue Reservierung hinzufügen change: Ändern einer Reservierung remove: Löschen einer Reservierung |
Im Falle des Modus "add" werden folgende Informationen übertragen:
| Bezeichnung | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| ProductID | string | 1 | Eindeutige Produkt-Bezeichnung |
| amount | integer | 1 | Anzahl der zu reservierenden Menge |
| time_to_life | YYYY-MM-DD HH:MM | 0 ... 1 | Angabe, wann die Reservierung automatisiert zu entfernen ist |
Im Falle des Modus "change" wird mindestends eins der folgenden Informationen übertragen:
| Bezeichnung | Datentyp | Vorkommen | Beschreibung |
|---|---|---|---|
| amount | integer | 0 ... 1 | Anzahl der zu reservierenden Menge |
| time_to_life | YYYY-MM-DD HH:MM | 0 ... 1 | Angabe, wann die Reservierung automatisiert zu entfernen ist |
Bei Fragen zu unserem Datenformat erreichen Sie uns Montag bis Donnerstag von 08:30 Uhr bis 17:00 Uhr und Freitags bis 15:30 Uhr unter der Rufnummer +43 (0)662 9396 - 920 oder per eMail unter support@seminar-shop.com.