Schnittstellenleitfaden: Unterschied zwischen den Versionen

Zur Navigation springen Zur Suche springen
← Zum vorherigen Versionsunterschied
 
(40 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt)
Zeile 1: Zeile 1:
* '''für den Stammdatenexport an externe Webshop-Systeme'''
* '''Stammdatenexport an externe Webshop-Systeme'''
* '''für den Auftragsimport aus externen Webshop-Systemen'''
* '''Auftragsimport aus externen Webshop-Systemen'''


''Stand Dezember 2021''
''Stand Frühjahr 2026''


=Vorbemerkungen=
=Vorbemerkungen=
Zeile 25: Zeile 25:
Vor der Implementierung fordern wir beim Auftraggeber eine Freigabe zur Erstattung der Beratungskosten an.  
Vor der Implementierung fordern wir beim Auftraggeber eine Freigabe zur Erstattung der Beratungskosten an.  
Der entstandenen Aufwand wird dokumentiert.
Der entstandenen Aufwand wird dokumentiert.
==Formatkennzeichen==
{| class="wikitable"
! Zeichen !! Bedeutung
|-
| Alphanumerisch || UTF-8 Zeichenkette, ohne Delimiter
|-
| Gleitkommazahl || (-)n0,n, maximal 32-Bit
|-
| Ganzzahl || (-)i, maximal 32-Bit
|-
| Logischer Wert || True/False oder Wahr/Falsch, ohne Delimiter
|-
| Datum || ISO 8601 JJJJ-MM-TT, Zeitanteil wird ignoriert
|-
| Uhrzeit || ISO 8601 hh:nn:ss, Millisekunden werden ignoriert
|-
| Datumsstempel || JJJJ-MM-TT hh:nn:ss, Millisekunden werden ignoriert
|}
=Dateien=


==Dateiformate==
==Dateiformate==
Zeile 56: Zeile 78:
* Die Einstellungen für für den Datenaustausch mit Shopware oder Magento u.ä. finden Sie  [[WEBDRINK-Schnittstelle|hier]].
* Die Einstellungen für für den Datenaustausch mit Shopware oder Magento u.ä. finden Sie  [[WEBDRINK-Schnittstelle|hier]].


==Stammdatenexport als CSV==
=Stammdatenexport als CSV=
Die Daten werden mit einer FTP-Verbindung übertragen. Nach erfolgreichem Verbindungsaufbau werden die [[wikipedia:de:CSV_%28Dateiformat%29|CSV]]-Daten in einem zu definierenden Ordner kopiert.
Die Daten werden mit einer FTP-Verbindung übertragen. Nach erfolgreichem Verbindungsaufbau werden die [[wikipedia:de:CSV_%28Dateiformat%29|CSV]]-Daten in einem zu definierenden Ordner kopiert.


===Formatkennzeichen===
==Kunden.csv==
 
{| class="wikitable"
! Zeichen !! Bedeutung !!Format
|-
| A || Eindimensionaler String || UTF-8, ohne Delimiter
|-
| N || Gleitkommazahl || (-)n0,n, maximal 32-Bit
|-
| I || Ganzzahl || (-)i, maximal 32-Bit
|-
| B || Logischer Wert || True/False oder Wahr/Falsch, ohne Delimiter
|-
| D || Datum || ISO 8601 JJJJ-MM-TT, Zeitanteil wird ignoriert
|-
| T|| |Uhrzeit || ISO 8601 hh:nn:ss, Millisekunden werden ignoriert
|-
| @ || Zeitstempel || JJJJ-MM-TT hh:nn:ss, Millisekunden werden ignoriert
|}
 
===Feldbeschreibungen Datei "Kunden.csv“===
Nachfolgend wird ein Kundendatensatz beschrieben.
Nachfolgend wird ein Kundendatensatz beschrieben.


Zeile 89: Zeile 91:
|-
|-
|KDNr  
|KDNr  
|A20 (eingeschränkter Zeichensatz)
|Alphanumerisch
|Eindeutige Identnummer
|Eindeutige Identnummer
|-
|-
|Anrede  
|Anrede  
|A10
|Alphanumerisch
|Anrede, optional
|Anrede, optional
|-
|-
|Vorname
|Vorname
|A80
|Alphanumerisch
|Vorname, optional
|Vorname, optional
|-
|-
|Name/Firma
|Name/Firma
|A80
|Alphanumerisch
|Firmenname oder Name
|Firmenname oder Name
|-
|-
|Zusatz
|Zusatz
|A80
|Alphanumerisch
|optional Abteilung etc.
|optional Abteilung etc.
|-
|-
|Strasse
|Strasse
|A20
|Alphanumerisch
|Straße mit Hausnummer
|Straße mit Hausnummer
|-
|-
|PLZ
|PLZ
|A5
|Ganzzahl
|ohne Nationalitätskennzeichen
|ohne Nationalitätskennzeichen
|-
|-
|Ort
|Ort
|A80
|Alphanumerisch
|Ort
|Ort
|-
|-
|Telefon
|Telefon 1
|A20
|Alphanumerisch
|Telefon 1, optional
|optional
|-
|-
|Mobil
|Telefon 2
|A20
|Alphanumerisch
|Telefon 2, optional
|optional
|-
|-
|Email
|Email
|A255
|Alphanumerisch
|Mehrfacheinträge mit „,“ getrennt
|Mehrfacheinträge werden mit Komma getrennt
|-
|-
|StNr
|StNr
|A40
|Alphanumerisch
|StNr. oder USt.ID, optional
|StNr. oder USt.ID, optional
|-
|-
|BIC
|BIC
|A10
|Alphanumerisch
|ohne Leerzeichen, optional
|ohne Leerzeichen, optional
|-
|-
|IBAN
|IBAN
|A30
|Alphanumerisch
|Darf Leerzeichen enthalten, optional
|Darf Leerzeichen enthalten, optional
|-
|-
|Bar
|Bar
|B
|Logisch
|Kunde muss bei Lieferung zahlen
|Kunde muss bei Lieferung zahlen
|-
|-
|Gewerbe
|Gewerbe
|B
|Logisch
|Gewerbe oder Privatkunde
|Gewerbe oder Privatkunde
|-
|-
|Limit
|Limit
|N (-1, 0..n)
|Ganzzahl
| -1 = gesperrt, 0 = kein Limit
| -1 = gesperrt, 0 = kein Limit
|-
|-
|Preisgruppe
|Preisgruppe
|I (1..n)
|Ganzzahl
|Preisgruppenliste
|Preisgruppenliste
|}
|}
<!--//////////    Tabelle ENDE      //////////-->
<!--//////////    Tabelle ENDE      //////////-->


===Optional: Feldbeschreibungen Datei "Lieferadressen.csv“===
==Lieferadressen.csv==
Nachfolgend wird ein Adressdatensatz beschrieben. Diese Liste enthält zusätzliche Adressen eines Kunden. Die Datei ist optional. Sind keine Zusatzadressen vorhanden, wird die Baissadresse des Kundendatensatzes als Lieferadresse verwendet.
Nachfolgend wird ein Adressdatensatz beschrieben. Diese Liste enthält zusätzliche Adressen eines Kunden. Die Datei ist optional. Sind keine Zusatzadressen vorhanden, wird die Baissadresse des Kundendatensatzes als Lieferadresse verwendet.


Zeile 172: Zeile 174:
|-
|-
|KDNr  
|KDNr  
|A20 (eingeschränkter Zeichensatz)
|Alphanumerisch
|Eindeutige Identnummer
|Eindeutige Identnummer
|-
|-
|Anrede  
|Anrede  
|A10
|Alphanumerisch
|Anrede, optional
|Anrede, optional
|-
|-
|Vorname
|Vorname
|A80
|Alphanumerisch
|Vorname, optional
|Vorname, optional
|-
|-
|Name/Firma
|Name/Firma
|A80
|Alphanumerisch
|Firmenname oder Name
|Firmenname oder Name
|-
|-
|Zusatz
|Zusatz
|A80
|Alphanumerisch
|optional Abteilung etc.
|optional Abteilung etc.
|-
|-
|Strasse
|Strasse
|A20
|Alphanumerisch
|Straße mit Hausnummer
|Straße mit Hausnummer
|-
|-
|PLZ
|PLZ
|A5
|Ganzzahl
|ohne Nationalitätskennzeichen
|ohne Nationalitätskennzeichen
|-
|-
|Ort
|Ort
|A80
|Alphanumerisch
|Ort
|Ort
|-
|-
|Telefon
|Telefon
|A20
|Alphanumerisch
|Telefon 1, optional
|Telefon 1, optional
|-
|-
|Ident
|Ident
|A20
|Alphanumerisch
|Kennung der Adresse
|Kennung der Adresse
|}
|}
<!--//////////    Tabelle ENDE      //////////-->
<!--//////////    Tabelle ENDE      //////////-->


===Feldbeschreibungen Datei "Artikel.csv“===
==Artikel.csv==
Nachfolgend wird ein Artikeldatensatz beschrieben.  
Nachfolgend wird ein Artikeldatensatz beschrieben.  


Zeile 223: Zeile 225:
|-
|-
|Versionsnummer
|Versionsnummer
|I
|Alphanumerisch
|Wird nicht verwendet
|Wird nicht verwendet
|-
|-
|ArtNr
|ArtNr
|A20, eingeschränkter Zeichensatz
|Alphanumerisch
|Eindeutige Identnummer
|Eindeutige Identnummer
|-
|-
|Artikelbezeichnung
|Artikelbezeichnung
|A80
|Alphanumerisch
|Artikelbezeichnung  
|Artikelbezeichnung  
|-
|-
|Menge
|Menge
|I (0..n)
|Ganzzahl
|Flaschen im Kasten, Einzel = 0
|Flaschen im Kasten, Einzel = 0
|-
|-
|Gebinde-Inhalt
|Gebinde-Inhalt
|N (0..n)
|Kommazahl
|Liter
|Liter
|-
|-
|Warengruppe
|Warengruppe
|A40
|Alphanumerisch
|Warengruppe
|Warengruppe
|-
|-
|Untergruppe
|Untergruppe
|A40
|Alphanumerisch
|Wird nicht verwendet
|Wird nicht verwendet
|-
|-
|Hersteller
|Hersteller
|A40
|Alphanumerisch
|Hersteller
|Hersteller
|-
|-
|Bruttopreis
|Bruttopreis
|N
|Kommazahl
|Basispreis 1 des Artikels inkl. MwSt.
|Basispreis 1 des Artikels inkl. MwSt.
|-
|-
|Brutto-Pfand
|Brutto-Pfand
|N
|Kommazahl
|Basispreis 1 des Pfands inkl. MwSt.
|Basispreis 1 des Pfands inkl. MwSt.
|-
|-
|Brutto-Literpreis
|Brutto-Literpreis
|N
|Kommazahl
|Basispreis 1 pro Liter inkl. MwSt.
|Basispreis 1 pro Liter inkl. MwSt.
|-
|-
|Nettopreis
|Nettopreis
|N
|Kommazahl
|Basispreis 2 des Artikels exkl. MwSt.
|Basispreis 2 des Artikels exkl. MwSt.
|-
|-
|Netto-Pfand
|Netto-Pfand
|N
|Kommazahl
|Basispreis 2 des Pfands exkl. MwSt.
|Basispreis 2 des Pfands exkl. MwSt.
|-
|-
|Netto-Literpreis
|Netto-Literpreis
|N
|Kommazahl
|Basispreis 2 pro Liter exkl. MwSt.
|Basispreis 2 pro Liter exkl. MwSt.
|-
|-
|MwSt
|MwSt
|N (0..n)
|Kommazahl
|MwSt.-Satz in Prozent
|MwSt.-Satz in Prozent
|-
|-
|Barcode
|Barcode
|A20
|Alphanumerisch
|EAN des Teilgebinde oder Einzelartikel
|EAN des Teilgebinde oder Einzelartikel
|-
|-
|Lieferbar
|Lieferbar
|I
|Ganzzahl
|Wird nicht verwendet
|Wird nicht verwendet
|-
|-
|Angebotsart
|Angebotsart
|I
|Ganzzahl
|Wird nicht verwendet
|Wird nicht verwendet
|}
|}
<!--//////////    Tabelle ENDE      //////////-->
<!--//////////    Tabelle ENDE      //////////-->


===Optional: Feldbeschreibungen Datei "Favoriten.csv“===
==Favoriten.csv==
Nachfolgend wird ein Kundensortimentsdatensatz beschrieben. Diese Liste enthält die bisher bestellten Artikel eines Kunden. Die Datei ist optional.
Nachfolgend wird ein Kundensortimentsdatensatz beschrieben. Diese Liste enthält die bisher bestellten Artikel eines Kunden. Die Datei ist optional.


Zeile 306: Zeile 308:
|-
|-
|KDNr  
|KDNr  
|A20 (eingeschränkter Zeichensatz)
|Alphanumerisch
|Eindeutige Identnummer des Kunden
|Eindeutige Identnummer des Kunden
|-
|-
|ArtNr
|ArtNr
|A20, eingeschränkter Zeichensatz
|Alphanumerisch
|Eindeutige Identnummer des Artikels
|Eindeutige Identnummer des Artikels
|-
|-
|Anzahl
|Anzahl
|I
|Ganzzahl
|übliche Bestellmenge
|übliche Bestellmenge
|}
|}
<!--//////////    Tabelle ENDE      //////////-->
<!--//////////    Tabelle ENDE      //////////-->


===Optional: Feldbeschreibungen Datei "Sonderpreise.csv“===
==Sonderpreise.csv==
Nachfolgend wird eine Tabelle mit kundenspezifischen oder zeitlich beschränkten Sonderpreisen beschrieben. Die Datei ist optional.  
Nachfolgend wird eine Tabelle mit kundenspezifischen oder zeitlich beschränkten Sonderpreisen beschrieben. Die Datei ist optional.  


Zeile 329: Zeile 331:
|-
|-
|KDNr  
|KDNr  
|A20 (eingeschränkter Zeichensatz)
|Alphanumerisch
|Eindeutige Identnummer des Kunden
|Eindeutige Identnummer des Kunden
|-
|-
|ArtNr
|ArtNr
|A20, eingeschränkter Zeichensatz
|Alphanumerisch
|Eindeutige Identnummer des Artikels
|Eindeutige Identnummer des Artikels
|-
|-
|NettoVK
|NettoVK
|N
|Kommazahl
|Netto Sonderpreis
|Netto Sonderpreis
|-
|-
|Start
|Start
|@
|Zeitstempel
|Zeitstempel Gültigkeitsbeginn eines Aktionspreises
|Zeitstempel Gültigkeitsbeginn eines Aktionspreises
|-
|-
|Ende
|Ende
|@
|Zeitstempel
|Zeitstempel Gültigkeitsende eines Aktionspreises
|Zeitstempel Gültigkeitsende eines Aktionspreises
|-
|-
|Gruppe
|Gruppe
|A20
|Alphanumerisch
|Aktionspreis gilt für Preisgruppe
|Aktionspreis gilt für Preisgruppe
|-
|-
|Ersetzen
|Ersetzen
|A5 (Ja, Nein)
|Logisch (ja/nein)
|Aktionspreis kann Sonderpreise überschreiben
|Aktionspreis kann Sonderpreise überschreiben
|-
|-
|Vorrat
|Vorrat
|I (-1, 1..n)
|Ganzzahl
|Beschränkter Vorrat eines Aktionspreises, -1 = kein Vorrat
|Beschränkter Vorrat eines Aktionspreises, -1 = kein Vorrat
|}
|}
<!--//////////    Tabelle ENDE      //////////-->
<!--//////////    Tabelle ENDE      //////////-->


{{Hinweis|'''Aktionspreise''': Ist das Feld '''KDNr''' leer, wird der eingetragene Preis '''NettoVK''' als zeitlich gesteuerter '''Aktionspreis''' behandelt, der im Zeitraum von '''Start ''' bis '''Ende''' unter Beachtung der Zugehörigkeit eines Kunden zur Preisgruppe in „Gruppe“, der Vorgabe der Möglichkeit zum '''Überschreiben''' eines möglichen Sonderpreises eines Kunden für den Artikel und Einschränkung der Gültigkeit eines Aktionspreises auf eine maximale Abverkaufsmenge '''Vorrat''' gilt.}}
''Aktionspreise'': Ist das Feld '''KDNr''' leer, wird der eingetragene Preis '''NettoVK''' als zeitlich gesteuerter ''Aktionspreis'' behandelt, der im Zeitraum von ''Start'' bis ''Ende'' unter Beachtung der Zugehörigkeit eines Kunden zur Preisgruppe in „Gruppe“, der Vorgabe der Möglichkeit zum ''Überschreiben'' eines möglichen Sonderpreises eines Kunden für den Artikel und Einschränkung der Gültigkeit eines Aktionspreises auf eine maximale Abverkaufsmenge ''Vorrat'' gilt.


==Auftragsimport als XML==
=Auftragsimport als XML=
Die Daten werden mit einer FTP-Verbindung übertragen. Nach erfolgreichem Verbindungsaufbau werden die [[wikipedia:de:Extensible_Markup_Language|XML]]-Daten aus einem zu definierenden Ordner geladen.
Die Daten werden mit einer FTP-Verbindung übertragen. Nach erfolgreichem Verbindungsaufbau werden die [[wikipedia:de:Extensible_Markup_Language|XML]]-Daten aus einem zu definierenden Ordner geladen.


'''Folgende Standards werden vereinbart:'''
'''Bedingungen:'''


* Elemente ohne Daten werden [[wikipedia:de:Extensible_Markup_Language|XML]]-konform als <Tag-Name/> dargestellt.
* Elemente ohne Daten werden [[wikipedia:de:Extensible_Markup_Language|XML]]-konform als <Tag-Name/> dargestellt
* Jede Bestellung wird einzeln erfasst.
* Jede Bestellung wird einzeln erfasst
* Der Datensatz enthält Bestellmerkmale sowie alle Details des Kunden.
* Der Datensatz enthält alle Informationen zur Bestellung und zum Kunden
* Der Zeichensatz ist UTF-8.
* Zeichensatz ist UTF-8
* Der Name der [[wikipedia:de:Extensible_Markup_Language|XML]]-Datei besteht aus dem Zeitstempel (YYYY-MM-DD-HHNNSS) sowie der Auftragsnummer, welche vom Webshop vergeben wird.  
* Der Name der [[wikipedia:de:Extensible_Markup_Language|XML]]-Datei besteht aus dem Zeitstempel (YYYY-MM-DD-HHNNSS) sowie der Auftragsnummer, welche vom Webshop vergeben wird. Beispiel: ''2012-02-06-105730-5432.xml''
 
{{Tipp1|'''Beispiel:''' 2012-02-06-105730-5432.xml}}


==Aufbau der XML-Datei==
==Aufbau der XML-Datei==
  <order>
  <order>
   [notwendig, einmal]
   [notwendig, einmal]
 
   <paymentDetails>
   <paymentDetails>
     [optional, einmal]
     [optional, einmal]
   </paymentDetails>
   </paymentDetails>    
   
   <DeliveryDetails>
   <DeliveryDetails>
     [optional, mehrfach]
     [optional, mehrfach]
   </DeliveryDetails>
   </DeliveryDetails>  
   <article>
   <article>
     [optional, mehrfach]
     [optional, mehrfach]
   </article>
   </article>
  </order>
  </order>
  <customer>
  <customer>
   [notwendig, einmal]
   [notwendig, einmal]
 
   <DeliveryAddress>
   <DeliveryAddress>
     [optional, einmal]
     [optional, einmal]
   </DeliveryAddress>
   </DeliveryAddress>
   <BankDetails>
   <BankDetails>
     [optional, einmal]
     [optional, einmal]
   </BankDetails>
   </BankDetails>
  </customer>
  </customer>


===Die Entität "order"===
==Die Entität "order"==


Die Entität ist primär, notwendig und einmalig. Sie enthält Informationen zur Bestellung.
Die Entität ist primär, notwendig und einmalig. Sie enthält Informationen zur Bestellung.
Zeile 531: Zeile 523:
<!--//////////    Tabelle ENDE      //////////-->
<!--//////////    Tabelle ENDE      //////////-->
    
    
=== Die Entität "paymentDetails"===
== Die Entität "paymentDetails"==


Die Entität ist in <order> enthalten, optional und einmalig. Sie enthält optionale Informationen zur Zahlweise
Die Entität ist in <order> enthalten, optional und einmalig. Sie enthält optionale Informationen zur Zahlweise
Zeile 553: Zeile 545:
|}
|}
<!--//////////    Tabelle ENDE      //////////-->
<!--//////////    Tabelle ENDE      //////////-->
===Die Entität "DeliveryDetails"===
 
==Die Entität "DeliveryDetails"==


Die Entität ist in <order> enthalten, optional und wiederholbar. Sie enthält optionale Informationen zu Transportkosten
Die Entität ist in <order> enthalten, optional und wiederholbar. Sie enthält optionale Informationen zu Transportkosten
Zeile 581: Zeile 574:
<!--//////////    Tabelle ENDE      //////////-->
<!--//////////    Tabelle ENDE      //////////-->
   
   
===Die Entität "article"===
==Die Entität "article"==


Die Entität ist in <order> enthalten, (thoretisch) optional und wiederholbar. Sie enthält Informationen zu Bestellposten
Die Entität ist in <order> enthalten, (thoretisch) optional und wiederholbar. Sie enthält Informationen zu Bestellposten
Zeile 654: Zeile 647:
<!--//////////    Tabelle ENDE      //////////-->
<!--//////////    Tabelle ENDE      //////////-->


===Die Entität "customer"===
==Die Entität "customer"==


Die Entität ist primär, notwendig und einmalig. Sie enthält Informationen zum Kunden
Die Entität ist primär, notwendig und einmalig. Sie enthält Informationen zum Kunden


Primär, Notwendig, einmalig
<!--//////////    Tabelle ANFANG      //////////-->
<!--//////////    Tabelle ANFANG      //////////-->
:{| class="wikitable" style="text-align:left"
:{| class="wikitable" style="text-align:left"
Zeile 787: Zeile 779:
|}
|}
<!--//////////    Tabelle ENDE      //////////-->
<!--//////////    Tabelle ENDE      //////////-->
==Die Entität "DeliveryAddress"===
 
==Die Entität "DeliveryAddress"==


Die Entität ist in <customer> enthalten, optional und einmalig. Sie enthält optionale Informationen zur Lieferadresse
Die Entität ist in <customer> enthalten, optional und einmalig. Sie enthält optionale Informationen zur Lieferadresse
Zeile 797: Zeile 790:
!! style="background:#B3B7FF" | Beispiel
!! style="background:#B3B7FF" | Beispiel
!! style="background:#B3B7FF" | Erläuterungen
!! style="background:#B3B7FF" | Erläuterungen
|-
|<street>
|<street>
|Alphanumerisch
|Alphanumerisch
Zeile 843: Zeile 837:
|}
|}
<!--//////////    Tabelle ENDE      //////////-->
<!--//////////    Tabelle ENDE      //////////-->
===Die Entität "BankDetails"===
==Die Entität "BankDetails"==


Die Entität ist in <customer> enthalten, optional und einmalig. Sie enthält optionale Informationen zur Bankverbindung
Die Entität ist in <customer> enthalten, optional und einmalig. Sie enthält optionale Informationen zur Bankverbindung
Zeile 870: Zeile 864:
|}
|}
<!--//////////    Tabelle ENDE      //////////-->
<!--//////////    Tabelle ENDE      //////////-->


{{Hinweis|Abhängig vom <priceMode> werden die Preise Brutto oder Netto übergeben. Ausnahme ist der Wert <sumTotal>, welcher immer die Gesamtsumme inklusive der gesetzlichen Steuer enthält.}}
{{Hinweis|Abhängig vom <priceMode> werden die Preise Brutto oder Netto übergeben. Ausnahme ist der Wert <sumTotal>, welcher immer die Gesamtsumme inklusive der gesetzlichen Steuer enthält.}}
Zeile 876: Zeile 869:
{{Hinweis|Die Tags <discountPercent und <discountFix> definieren mögliche Rabatte sowie Gutscheine. Bei prozentualen Rabatten sind diese direkt in den Artikelpreisen berücksichtigt. Bei einem Einmalbetrag werden die Werte in dem Tag <sumTotal> berücksichtigt.}}
{{Hinweis|Die Tags <discountPercent und <discountFix> definieren mögliche Rabatte sowie Gutscheine. Bei prozentualen Rabatten sind diese direkt in den Artikelpreisen berücksichtigt. Bei einem Einmalbetrag werden die Werte in dem Tag <sumTotal> berücksichtigt.}}


==Beispieldateien==
==Beispiel einer Auftragsdatei==
In diesem Abschnitt werden Dateien beschrieben
 
===Format WEBDRINK===
Das folgende Listing veranschaulicht eine Auftragsdatei:


  <order>
  <order>
Zeile 954: Zeile 943:
   <dateOfBirth/>
   <dateOfBirth/>
   <dataStatus>new</dataStatus>   
   <dataStatus>new</dataStatus>   
   <newsletter>  
   <newsletter></newsletter>  
   <DeliveryAddress>
   <DeliveryAddress>
     <street>Musterstraße</street>
     <street>Musterstraße</street>
     <streetNumber>10</streetNumber>
     <streetNumber>10</streetNumber>
     <additionalAddressInformation>5. Etage</additionalAddressInformation
     <additionalAddressInformation>5. Etage</additionalAddressInformation>
     <postcode>35708</postcode>
     <postcode>35708</postcode>
     <town>Haiger</town>
     <town>Haiger</town>
Zeile 973: Zeile 962:
  </customer>
  </customer>


===Format SHOPWARE===
=JSON =
Das folgende Listing veranschaulicht eine Auftragsdatei. Die zugehörige XML-Datei "2012-02-06-105730-5432.xml" kann [[https://www.fakturax.de/files/2012-02-06-105730-5432.xml hier]] heruntergeladen werden.
Die Anwendung unterstützt den Auftragsimport mittels REST-API. Die Kommunikation erfolgt über eine HTTPS-Schnittstelle, welche JSON-Objekte im Request-Body erwartet. Die Zeichenkodierung ist UTF-8.
 
==JSON-Objekte==
JSON Request-Objekt:
*'''id:''' Eindeutiger Identifier innerhalb des Requests.
*'''command:''' String für den auszuführenden Command.
*'''params:''' Parameter für den Command.
 
JSON Response-Objekt:
*'''id:''' Hierbei handelt es sich um die übergebene Id des Requests.
*'''result:''' Bei einer erfolgreichen Verarbeitung wird immer ein result übergeben. Bei einem error existiert dieser Wert nicht.
*'''error:''' Ausschließlich bei einem Fehler existiert dieses Objekt. Es unterteilt sich immer in code und message. Bei einem Validierungsfehler wird ein Objekt input übergeben. Die Keys des Objektes enthalten die fehlgeschlagenen Parameter einschließlich der Fehlermeldung.
 
* Single data sent to Server:
{"id":"1","command":"articles/set","params":{"data":{"articleNumber":"H64326426","name":"Testartikel","quantity":3,"unit":1.74,"taxRate":19,"prices":[{"priceGroup":"1","fromArticleQuantity":1,"fromCartQuantity":1,"netPrice":8.15,"netDeposit":0}],"groups":[{"groupName":"Testgruppe"}]}}}
* Single data receive from Server:
{"id":"1","result":{"articles":{"data":{"id":"63f8340b5f86a975e10f8725"}}}}
 
*Batch data sent to Server:
[{"id":"1","command":"articles/update","params":{"data":{"articleNumber":"1","availability":"Kein Bestand"}}}, {"id":"2","command":"articles/update","params":{"data":{"articleNumber":"2","availability":"Kein Bestand"}}}]
*Batch data received from Server:
[{"id":"1","result":{"articles":{"updated":{"matched":1,"upserted":0,"modified":1}}}}, {"id":"2","result":{"articles":{"updated":{"matched":1,"upserted":0,"modified":1}}}}]
 
==Authentifizierung==
Die Authentifizierung erfolgt über einen API-Token, welcher über den Header "Authorisation: Bearer apiToken" wird.  
 
cURL Beispiel-Request:
 
curl -X POST <domain>
-H "Authorisation: Bearer apiToken"
-H "Content-Type: application/json"
-d "{"id": 1,"command":"articles/delete", "params": {"data":{"articleNumber": "123"}}}"


<xml version="1.0" encoding="UTF-8" standalone="yes">
= Stammdatenexport als JSON =
<order>
== Artikel ==
  <orderID>8372</orderID>
<!--//////////    Tabelle ANFANG      //////////-->
  <ip>87.153.22.57</ip>
:{| class="wikitable" style="text-align:left"
  <orderDate>2012-06-04 13:46:40</orderDate>
! style="background:#B3B7FF" | Entität
  <deliveryDate>2012-07-07</deliveryDate>
!! style="background:#B3B7FF" | Typ
  <deliveryPeriod>Vormittags</deliveryPeriod>
!! style="background:#B3B7FF" | Beispiel
  <comment/>
!! style="background:#B3B7FF" | Erläuterungen
  <payment>bankCollection</payment>
|-
  <priceMode>gross</priceMode>
|articleNumber
  <taxRate>19.00</taxRate>
|Alphanumerisch (20 Zeichen)
  <merchandiseValue>55.95</merchandiseValue>
|12345
  <deliveryCosts>10.00</deliveryCosts>
|Eindeutige Artikelnummer
  <smallVolumePurchase>0.00</smallVolumePurchase>
|-
  <sumTotal>80.05</sumTotal>
|articleName
  <discountPercent>0.00</discountPercent>
|Alphanumerisch (225 Zeichen)
  <discountFix>0.00</discountFix>
|Coca Cola Classic 12x 1,00l PET
  <article>
|Artikelbezeichnung
    <amount>2</amount>
|-
    <articleNumber>17106</articleNumber>
|articleManufacturer
    <name>Possmann Apfelwein 1 l (6x1,00)</name>
|Alphanumerisch (255)
     <package>6x1,00</package>
|Coca Cola
    <price>8.49</price>
|Hersteller
     <deposit>2.40</deposit>
|-
    <taxRate>19</taxRate>
|articleGroup
     <ean/>
|Alphanumerisch (255)
  </article>
|Limonade
  <article>
|Warengruppe
    <amount>3</amount>
|-
     <articleNumber>23105</articleNumber>
|articlePackage
    <name>Veltins Pils 0,5 (20x0,50)</name>
|Alphanumerisch (20)
    <package>20x0,50</package>
|Kasten
    <price>12.99</price>
|Verpackungseinheit
    <deposit>3.10</deposit>
|-
     <taxRate>19</taxRate>
|articleVolume
    <ean>4005249000367</ean>
|Kommazahl
  </article>
|12.00
  <deliveryDetails>
|Inhalt (Liter)
    <name>Anfahrtspauschale</name>
|-
    <price>4.00</price>
|articleWeight
  </deliveryDetails>
|Kommazahl
  <deliveryDetails>
|15.00
    <name>5 Artikel à 1,20€</name>
|Masse (kg)
    <price>6.00</price>
|-
  </deliveryDetails>
|availGeneral
  <customer>
|Alphanumerisch (255)
    <wdCustomerID>2578</wdCustomerID>
|lagernd
    <customerNumber/>
|Informatione zur Verfügbarkeit
    <street>Musterstr.</street>
|-
    <streetNumber>1</streetNumber>
|availStock
    <additionalAddressInformation/>
|Ganzzahl
    <postcode>35708</postcode>
|123
    <town>Haiger</town>
|Bestand
    <title>Frau </title>
|-
    <company/>
|articleDescription
    <name>Mustermann</name>
|Objekt
    <firstName>Max</firstName>
|Koffeinhaltiges Erfrischungsgetränk mit Pflanzenextrakten
    <phone>5468715687</phone>
|Artikelbeschreibung
    <fax/>
|-
    <mobile/>
|articleAdditionalData
    <email>mustermann@mustermann.de</email>
|Objekt
    <registrationDate>2012-06-01 18:48:49</registrationDate>
|Entdecke die Welt von Coca-Cola!
    <newsletter>0</newsletter>
|Weitere Artikelinformationen
    <bankDetails>
|-
      <accountOwner>Max Mustermann</accountOwner>
|articleLegalInfo
      <accountNumber>99999999</accountNumber>
|Objekt
      <bankCode>999999999</bankCode>
|Wasser, Zucker, Kohlensäure, Farbstoff E 150d, Phosphorsäure, natürliche Aromen, koffeinhaltig
      <bank>Mustermann eG</bank>
|Pflichtangaben
      <iban>999999999</iban>
|-
      <bic>DE0075XX</bic>
|articlekeywords
    </bankDetails>
|Objekt
  </customer>
|Cola, Limonade
</order>
|Suchwörter
</xml>
|-
|articleImages
|Objekt
|keine
|Artikelabbildungen
|-
|articleTaxRate
|Kommazahl
|19.0
|Mehrwertsteuersatz
|-
|articlePriceGroups
|Array
|Gewerbe, Privat
|Preisgruppen
|-
|articlePriceNetto
|Array
|9.99, 10.9159
|Preise (Netto)
|-
|unitContentCount
|Ganzzahl
|12
|Einzelgebinde in der Verpackungseinheit
|-
|UnitContentVol
|Kommazahl
|1.00
|Inhalt Einzelgebinde in Liter
|-
|depositTaxRate
|Kommazahl
|19.0
|Mehrwertsteuersatz Pfand
|-
|depositNetto
|Kommazahl
|3.30
|Pfandwert (Netto)
|-
|depositPackageType
|Alphanumerisch (40)
|Kasten 3,30 (12x 0,15 €)
|Pfandbezeichnung
|-
|depositType
|Alphanumerisch (20)
|MEHRWEG
|Einweg oder Mehrweg
|}
<!--//////////     Tabelle ENDE     //////////-->
 
==Bestandsänderungen==
<!--//////////     Tabelle ANFANG     //////////-->
:{| class="wikitable" style="text-align:left"
! style="background:#B3B7FF" | Entität
!! style="background:#B3B7FF" | Typ
!! style="background:#B3B7FF" | Beispiel
!! style="background:#B3B7FF" | Erläuterungen
|-
|storageIdent
|Alphanumerisch(20)
|10110
|Artikelnummer
|-
|storageStock
|Ganzzahl
|119
|Neuer Bestand
|}
<!--//////////     Tabelle EDE     //////////-->
 
==Kunden==
<!--//////////     Tabelle ANFANG     //////////-->
:{| class="wikitable" style="text-align:left"
! style="background:#B3B7FF" | Entität
!! style="background:#B3B7FF" | Typ
!! style="background:#B3B7FF" | Beispiel
!! style="background:#B3B7FF" | Erläuterungen
|-
|customerNumber
|Alphanumerisch (20)
|10210
|Kundennummer
|-
|customerMail
|Alphanumerisch (255)
|muellermeierschmidt@gmx.de
|E-Mail
|-
|customerPriceGroup
|Alphanumerisch (20)
|Gewerbe
|Preisgruppe
|-
|customerAddresses
|Array
|Lieferadressen (ident, strasse, plz, ort, vorname, name, zusatz, telefon)
|-
|customerpriceMode
|Integer
|1
|Preismodus (1: Gewerbe, 2: Privat)
|-
|customerStatus
|Alphanumerisch (20)
|Status (new, changed, unchanged, inactive)
|-
|customerDiscount
|Kommazahl
|3.00
|Prozentualer Rabatt
|-
|customerFavorites
|Array
|12345, 10
|Liste von Artikelnummern und Bestellmengen
|-
|customerPrices
|Array
|12345, 9.50
|Kundensepzifische Preise
|-
|customerPaymentType
|Ganzzahl
|59
|Zahlweise als EDI Payment Means Typ Code
|-
|customerPaymentIdent
|Alphanumerisch 30
|DE3541507001000567305
|Information zur Zahlweise (Einzug: IBAN)
|}
 
=Bestellimport als JSON=
 
<!--//////////     Tabelle ANFANG     //////////-->
:{| class="wikitable" style="text-align:left"
! style="background:#B3B7FF" | Entität
!! style="background:#B3B7FF" | Typ
!! style="background:#B3B7FF" | Beispiel
!! style="background:#B3B7FF" | Erläuterungen
|-
|orderIdent
|Alphanumerisch(20)
|10110
|Auftragsnummer
|-
|orderDeliveryAdressIdent
|Ganzzahl
|1
|Identnummer der Lieferadresse
|-
|orderInvoiceAdressIdent
|Ganzzahl
|1
|Identnummer der Rechnungsadresse
|-
|orderDate
|Zeitstempel
|2026-06-20 13:05:21
|Bestellzeitpunkt
|-
|orderIP
|Alphanumerisch
|123.456.789.012
|IP Adresse der Bestellung
|-
|DeliveryDate
|Zeitstempel
|2026-06-22 14:00:00
|Wunschtermin Lieferung
|-
|DeliveryInfo
|Alphanumerisch(255)
|bitte in Garage abstellen
|Hinweise zur Bestellung
|-
|paymentType
|Ganzzahl
|59
|Zahlweise als EDI Payment Means Typ Code
|-
|paymentIdent
|Alphanumerisch 30
|DE3541507001000567305
|Information zur Zahlweise (Einzug: IBAN)
|-
|orderPositions
|array
|12345, 5
|Bestellposten (articleIdent, articleQuantity)
|}


= Einzelnachweise =
= Einzelnachweise =


<references />
<references />
Abgerufen von „https://wiki.fakturax.de/index.php?title=Schnittstellenleitfaden“