...
Änderungsübersicht
Änderungen gegenüber der Version 2.5:
...
Anpassen der Versionsnummer
...
Anpassung Ablauf Suche
Streichen der Anforderung “Schliessen des Shops nach der Übertragung”.
...
Erweiterung Codelisten Rohstoffe um
MS = Messing
MK = MK Kupfer
...
Änderungsübersicht
Änderungen gegenüber der Version 2.5:
Anpassen der Versionsnummer
Anpassung Ablauf Suche
Streichen der Anforderung “Schliessen des Shops nach der Übertragung”.Einführung zusätzlicher Parameter “Mehrfachrückgabe“ und “HookUrl Timeout“ zur Steuerung der Rückgabe der im Prozess Artikelsuche.
Erweiterung Codelisten Rohstoffe um
MS = Messing
MK = MK KupferÄnderung Feldbeschreibung “Basis DEL-Notierung” in “Basis Notierung”
Änderung Feldbeschreibung “Aktuelle DEL-Notierung” in “Aktuelle Notierung”
Neuer Inhalte "Summe Rohstoffzuschläge”
Neuer Inhalt “skontofähiger Betrag”
Anpassen Bespiele und SchemataErweiterung Beispiel Rohstoffzuschlägeund Schemata
Erweiterung Beispiel Rohstoffzuschläge
Kürzung der Feldlänge PLZ auf 9 Stellen
Streichen des Name4 in den Adressdaten
Erweiterung der Strasse um Strasse 2 und Strasse 3 in den Adressdaten
Erweiterung der Lieferadresse um die Geo-Daten
Erweiterung der Referenzen in den Kopfdaten
Aufnahme der Referenzangaben in die Positionsdaten
Präambel
Die IDS Schnittstelle dient der (halb-)automatischen Kommunikation zwischen der kaufmännischen Software von Handwerksbetrieben mit den Internetpräsenzen der Großhändler und der Verbände.
...
Warenkorbübernahme Shop zur Handwerkssoftware
Über diese Funktion soll die Übernahme eines Warenkorbs aus dem Shop-System in die Handwerkssoftware realisiert werden.
Für den Prozess wurden folgende Prozessschritte abgestimmt.
a) Starten des GH-Shops aus der Handwerkssoftware in einem Browserfenster
Beim Aufruf des GH-Shops soll eine automatische Anmeldung erfolgen. Hierfür werden bei der Anfrage die Parameter „Kundennummer“, „Benutzername“ und „Passwort“ übertragen.
Zusätzlich ist der Parameter „Version“ zur Angabe der Version der Schnittstelle (ab Version 1.3) möglich.
Die Zugangsdaten sollen den beim Anwender bereits bekannten Zugangsdaten im Shop-System entsprechen.
Bei der Übertragung der Parameter soll die POST Variante (komplexere Implementierung aber unbegrenzte Parameterlänge) möglich sein. Die GET Variante wird auf Grund der nicht ausreichenden Länge der Parameter nicht unterstützt.
Beim Aufruf der Shop-Anbindung muss im HTTP-Header der Content "text/html" angegeben werden. Weiterhin muss der Zeichensatz angegeben werden, um eine eindeutige Interpretation zu ermöglichen. Für die Formulardaten muss der enctype "multipart/form-data" angegeben werden. Die gleichen Festlegungen gelten auch beim Aufruf der Hook-URL.
Der Zeichensatz der xml Struktur für den Warenkorb soll in der xml Deklaration angegeben werden. Wird nichts angegeben, so wird utf-8 genutzt. Es kann in jeder Anfrage nur ein Warenkorb übermittelt werden.
Für die Übertragung wird die Nutzung von HTTPS empfohlen, grundsätzlich soll aber auch HTTP möglich sein.
Die Rück-Kommunikation zur Handwerkssoftware soll über eine HOOK-URL erfolgen. Diese wird als Parameter beim Aufruf des GH-Shops übertragen.
Zusätzlich kann der Parameter „Target“ angegeben werden. Hier wird das Target angegeben, welches durch die Handwerkssoftware überwacht wird, um den Abschluss der Rück-Kommunikation festzustellen. Das Target muss, nach Abschluss der Rück-Kommunikation, durch den Shop aktualisiert werden. Wird der Parameter nicht übertragen wird „TOP“ als Standard-Target genutzt.
Die Festlegung, welche Aktion im GH-Shop aufgerufen werden soll, erfolgt über einen Aktionsparameter. Sollten für andere Aktionen weitere Parameter erforderlich sein, so werden diese in Abhängigkeit von der Aktion definiert.
Falls beim Aufruf Fehler auftreten, sollen diese im Browserfenster angezeigt werden. Das genaue Fehlerhandling obliegt den einzelnen GH-Shops und wird hier nicht weiter betrachtet.
Falls der GH-Shop ein Weiterarbeiten z. B. über eine manuelle Anmeldung ermöglicht, müssen die Aufrufparameter aus der Handwerkssoftware erhalten bleiben, um den Abschluss des Prozesses zu ermöglichen.
Hinweis: Beim Zugriff auf die Shop-Systeme ist zu beachten, dass es zu Problemen kommen kann, wenn in einem Shop-System mehrere Funktionen parallel gestartet werden.
b) Aktionen in GH-Shop
Dieser Schritt wird für den Prozess als Blackbox betrachtet, da die möglichen Aktionen innerhalb der einzelnen GH-Shops individuell sind.
c) Übernahme des Warenkorbsdie Übernahme eines Warenkorbs aus dem Shop-System in die Handwerkssoftware realisiert werden.
Für den Prozess wurden folgende Prozessschritte abgestimmt.
a) Starten des GH-Shops aus der Handwerkssoftware in einem Browserfenster
Beim Aufruf des GH-Shops soll eine automatische Anmeldung erfolgen. Hierfür werden bei der Anfrage die Parameter „Kundennummer“, „Benutzername“ und „Passwort“ übertragen.
Zusätzlich ist der Parameter „Version“ zur Angabe der Version der Schnittstelle (ab Version 1.3) möglich.
Die Zugangsdaten sollen den beim Anwender bereits bekannten Zugangsdaten im Shop-System entsprechen.
Bei der Übertragung der Parameter soll die POST Variante (komplexere Implementierung aber unbegrenzte Parameterlänge) möglich sein. Die GET Variante wird auf Grund der nicht ausreichenden Länge der Parameter nicht unterstützt.
Beim Aufruf der Shop-Anbindung muss im HTTP-Header der Content "text/html" angegeben werden. Weiterhin muss der Zeichensatz angegeben werden, um eine eindeutige Interpretation zu ermöglichen. Für die Formulardaten muss der enctype "multipart/form-data" angegeben werden. Die gleichen Festlegungen gelten auch beim Aufruf der Hook-URL.
Der Zeichensatz der xml Struktur für den Warenkorb soll in der xml Deklaration angegeben werden. Wird nichts angegeben, so wird utf-8 genutzt. Es kann in jeder Anfrage nur ein Warenkorb übermittelt werden.
Für die Übertragung wird die Nutzung von HTTPS empfohlen, grundsätzlich soll aber auch HTTP möglich sein.
Die Rück-Kommunikation zur Handwerkssoftware soll über eine HOOK-URL erfolgen. Diese wird als Parameter beim Aufruf des GH-Shops übertragen.
Zusätzlich kann der Parameter „Target“ angegeben werden. Hier wird das Target angegeben, welches durch die Handwerkssoftware überwacht wird, um den Abschluss der Rück-Kommunikation festzustellen. Das Target muss, nach Abschluss der Rück-Kommunikation, durch den Shop aktualisiert werden. Wird der Parameter nicht übertragen wird „TOP“ als Standard-Target genutzt.
Die Festlegung, welche Aktion im GH-Shop aufgerufen werden soll, erfolgt über einen Aktionsparameter. Sollten für andere Aktionen weitere Parameter erforderlich sein, so werden diese in Abhängigkeit von der Aktion definiert.
Falls beim Aufruf Fehler auftreten, sollen diese im Browserfenster angezeigt werden. Das genaue Fehlerhandling obliegt den einzelnen GH-Shops und wird hier nicht weiter betrachtet.
Falls der GH-Shop ein Weiterarbeiten z. B. über eine manuelle Anmeldung ermöglicht, müssen die Aufrufparameter aus der Handwerkssoftware erhalten bleiben, um den Abschluss des Prozesses zu ermöglichen.
Hinweis: Beim Zugriff auf die Shop-Systeme ist zu beachten, dass es zu Problemen kommen kann, wenn in einem Shop-System mehrere Funktionen parallel gestartet werden.
b) Aktionen in GH-Shop
Dieser Schritt wird für den Prozess als Blackbox betrachtet, da die möglichen Aktionen innerhalb der einzelnen GH-Shops individuell sind.
c) Übernahme des Warenkorbs
Die Übertragung des Warenkorbs erfolgt in den im Kapitel „Dateninhalte“ beschriebenen Datenstrukturen. Der übertragene Warenkorb muss dem Schema „Warenkorb_empfangen.xsd“ entsprechen.
Die Übernahme der Daten erfolgt als Übertragung eines Formulars an die HOOK-URL analog der OCI Schnittstelle.
d) Schließen des GH-Shops
Nach Abschluss der Verarbeitung muss das Browserfenster geschlossen werden und der Prozess ist abgeschlossen.
Warenkorbübergabe Handwerkssoftware zum Shop
Über diese Funktion soll die Übergabe eines Warenkorbs aus der Handwerkssoftware in das Shop-System realisiert werden.
Für den Prozess wurden folgende Prozessschritte abgestimmt.
a) Starten des GH-Shops aus der Handwerkssoftware in einem Browserfenster
Analog zu Punkt a) Warenkorbübernahme GH-Shop zur Handwerkssoftware.
Es wird ein anderer Aktionsparameter gesendet. Darüber hinaus werden die Daten des Warenkorbs als zusätzlicher Parameter übertragen.
Hinweis: Der Parameter Hook-Url muss in jedem Fall mitgesendet werden, da nur dann eine Rückübertragung möglich ist.
Die Übertragung des Warenkorbs erfolgt in den im Kapitel „Dateninhalte“ beschriebenen Datenstrukturen. Der übertragene Warenkorb muss dem Schema „Warenkorb_empfangensenden.xsd“ entsprechen.
Die Übernahme der Daten erfolgt als Übertragung eines Formulars an die HOOK-URL analog der OCI Schnittstelle.
d) Schließen des GH-Shops
Nach Abschluss der Verarbeitung muss das Browserfenster geschlossen werden und der Prozess ist abgeschlossen.
Warenkorbübergabe Handwerkssoftware zum Shop
Über diese Funktion soll die Übergabe eines Warenkorbs aus der Handwerkssoftware in das Shop-System realisiert werden.
Für den Prozess wurden folgende Prozessschritte abgestimmt.
a) Starten des GH-Shops aus der Handwerkssoftware in einem Browserfenster
Analog zu Punkt a) Warenkorbübernahme GH-Shop zur Handwerkssoftware.
Es wird ein anderer Aktionsparameter gesendet. Darüber hinaus werden die Daten des Warenkorbs als zusätzlicher Parameter übertragen.
Hinweis: Der Parameter Hook-Url muss in jedem Fall mitgesendet werden, da nur dann eine Rückübertragung möglich ist.
Die Übertragung des Warenkorbs erfolgt in den im Kapitel „Dateninhalte“ beschriebenen Datenstrukturen. Der übertragene Warenkorb muss dem Schema „Warenkorb_senden.xsd“ entsprechen.
Bei der Verarbeitung des Warenkorbs im GH-Shop müssen folgende Punkte gegeben sein:
· Es dürfen keine Positionen „verschluckt“ werden (bei der Verarbeitung entfallen) bzw. es muss eine entsprechende Fehlermeldung angezeigt werden.
· Übertragene Positionsnummern müssen erhalten bleiben.
· Ein Bezug zu Belegen z. B. Angeboten soll bei der Übertragung möglich sein und bei der Verarbeitung erhalten bleibenBei der Verarbeitung des Warenkorbs im GH-Shop müssen folgende Punkte gegeben sein:
· Es dürfen keine Positionen „verschluckt“ werden (bei der Verarbeitung entfallen) bzw. es muss eine entsprechende Fehlermeldung angezeigt werden.
· Übertragene Positionsnummern müssen erhalten bleiben.
· Ein Bezug zu Belegen z. B. Angeboten soll bei der Übertragung möglich sein und bei der Verarbeitung erhalten bleiben.
Hinweis: Beim Zugriff auf die Shop-Systeme ist zu beachten, dass es zu Problemen kommen kann, wenn in einem Shop-System mehrere Funktionen parallel gestartet werden.
b) Bearbeitung des Warenkorbs
Dieser Schritt wird für den Prozess weitgehend als Blackbox betrachtet, da die möglichen Aktionen innerhalb der einzelnen GH-Shops individuell sind. Folgende Festlegung wurde allerdings getroffen:
Beim Bearbeiten des Warenkorbs müssen die übertragenen Positionsnummern erhalten bleiben.
c) Rückübertragung des geänderten Warenkorbs
Analog zum Prozess Warenkorbübernahme GH-Shop zur Handwerkssoftware (Schritt c) soll auch hier die Rückübertragung der Daten möglich sein.
Artikeldeeplink
Über diese Funktion soll die Anfrage an das Shop-System mittels der GH-Nummer erfolgen. Als Antwort erscheint eine Seite im Browser, die Artikeldaten bereitstellt.
Der Prozess wurde wie folgt festgelegt:
a) Starten des GH-Shops aus der Handwerkssoftware in einem Browserfenster
Analog zu Punkt a) Warenkorbübernahme GH-Shop zur Handwerkssoftware.
Es wird ein anderer Aktionsparameter gesendet. Zusätzlich wird die Artikelnummer als Parameter übertragen.
Hinweis: Beim Zugriff auf die Shop-Systeme ist zu beachten, dass es zu Problemen kommen kann, wenn in einem Shop-System mehrere Funktionen parallel gestartet werden.
b) Bearbeitung des Warenkorbs
Dieser Schritt wird für den Prozess weitgehend als Blackbox betrachtet, da die möglichen Aktionen innerhalb der einzelnen GH-Shops individuell sind. Folgende Festlegung wurde allerdings getroffen:
Beim Bearbeiten des Warenkorbs müssen die übertragenen Positionsnummern erhalten bleiben.
c) Rückübertragung des geänderten Warenkorbs
Analog zum Prozess Warenkorbübernahme GH-Shop zur Handwerkssoftware (Schritt c) soll auch hier die Rückübertragung der Daten möglich sein.
Artikeldeeplink
Über diese Funktion soll die Anfrage an das Shop-System mittels der GH-Nummer erfolgen. Als Antwort erscheint eine Seite im Browser, die Artikeldaten bereitstellt.
Der Prozess wurde wie folgt festgelegt:
a) Starten des GH-Shops aus der Handwerkssoftware in einem Browserfenster
Analog zu Punkt a) Warenkorbübernahme GH-Shop zur Handwerkssoftware.
Es wird ein anderer Aktionsparameter gesendet. Zusätzlich wird die Artikelnummer als Parameter übertragen.
Hinweis: Beim Zugriff auf die Shop-Systeme ist zu beachten, dass es zu Problemen kommen kann, wenn in einem Shop-System mehrere Funktionen parallel gestartet werden.
Artikelsuche
Über diese Funktion wird die Artikelsuche im Großhandelsshop oder in Open Datapool aufgerufen. Hierzu wird der Suchbegriff als Parameter übertragen.
Für den Prozess wurden folgende Prozessschritte definiert.
a) Starten der Suche aus der Handwerkssoftware in einem Browserfenster
Beim Aufruf der Plattform soll eine automatische Anmeldung erfolgen, falls diese erforderlich ist. Hierfür können bei der Anfrage die Parameter „Kundennummer“, „Benutzername“ und „Passwort“ übertragen werden.
Bei der Übertragung der Parameter muss die POST Variante (komplexere Implementierung aber unbegrenzte Parameterlänge) möglich sein. Die GET Variante wird aufgrund der nicht ausreichenden Länge der Parameter nicht unterstützt.
Beim Aufruf der Plattform muss im HTTP-Header der Content "text/html" angegeben werden. Weiterhin muss der Zeichensatz angegeben werden, um eine eindeutige Interpretation zu ermöglichen. Für die Formulardaten muss der enctype "multipart/form-data" angegeben werden. Die gleichen Festlegungen gelten auch bei der späteren Rückübertragung zur Hook-URL.
Der Zeichensatz der xml Struktur für den Warenkorb soll in der xml Deklaration angegeben werden. Wird nichts angegeben, so wird utf-8 genutzt. Es kann in jeder Anfrage nur eine Artikelliste übermittelt werden.
Für die Übertragung wird die Nutzung von HTTPS empfohlen, grundsätzlich soll aber auch HTTP möglich sein. Das Protokoll wird von der Plattform vorgegeben.
Die Rück-Kommunikation zur Handwerkssoftware erfolgt über eine HOOK-URL. Diese wird als Parameter beim Aufruf der Plattform übertragen.
Zusätzlich kann der Parameter „Target“ angegeben werden. Hier wird das Target angegeben, welches durch die Handwerkssoftware überwacht wird, um den Abschluss der Rück-Kommunikation festzustellen. Das Target muss, nach Abschluss der Rück-Kommunikation, durch den Shop aktualisiert werden. Wird der Parameter nicht übertragen, wird „TOP“ als Standard-Target genutzt.
Die Festlegung, welche Aktion in der Plattform aufgerufen werden soll, erfolgt über den Aktionsparameter ("AS“).
Falls beim Aufruf Fehler auftreten, werden diese im Browserfenster angezeigt. Das genaue Fehlerhandling obliegt der einzelnen Plattform und wird hier nicht weiter betrachtet.
Hinweis: Der Parameter Hook-Url muss in jedem Fall mitgesendet werden, da nur dann eine Rückübertragung möglich ist.
Die Übertragung des Suchbegriffs erfolgt im Parameter „searchterm“.
In Parameter „searchterm“ können mehrere Begriffe, getrennt durch Leerzeichen, angegeben werden.
Die Anwendung des Suchstrings erfolgt durch die Suchengine des empfangenden Systems entsprechend der dort vorhandenen Logik. Die konkrete Suchlogik wird durch den Aufruf nicht beeinflusst.
Als Ergebnis des Aufrufs wird das Suchergebnis angezeigt.
a) Aktionen im aufgerufenen System
Dieser Schritt wird für den Prozess als Blackbox betrachtet, da die möglichen Aktionen innerhalb der einzelnen aufgerufenen Systeme unterschiedlich sein können.
b) Übernahme der Artikel
Die Übertragung der Artikel erfolgt in den im Kapitel „Dateninhalte“ beschriebenen Datenstrukturen. Der übertragene Warenkorb muss dem Schema „Warenkorb_empfangen_2-5.xsd“ entsprechen.
Die Übernahme der Daten erfolgt als Übertragung eines Formulars an die HOOK-URL analog der OCI Schnittstelle.
c) Schließen des Systems
Nach Abschluss der Verarbeitung kann das Browserfenster geschlossen werden und der Prozess ist abgeschlossen. Die Steuerung obligt der Handwerkssoftware und wird nicht durch den Shop vorgegeben. So ist eine mehrfache Übertragung an eine HOOK-URL möglich.
Heatinglabel senden
Über diese Funktion soll die Übergabe einer Artikelliste aus der Handwerkssoftware in eine Plattform zur Berechnung des ErP-Labels realisiert werden.
Für den Prozess wurden folgende Prozessschritte abgestimmt.
a) Starten der Plattform aus der Handwerkssoftware in einem Browserfenster
Beim Aufruf der Plattform soll eine automatische Anmeldung erfolgen, falls diese erforderlich ist. Hierfür können bei der Anfrage die Parameter „Kundennummer“, „Benutzername“ und „Passwort“ übertragen werden.
Bei der Übertragung der Parameter muss die POST Variante (komplexere Implementierung aber unbegrenzte Parameterlänge) möglich sein. Die GET Variante wird auf Grund der nicht ausreichenden Länge der Parameter nicht unterstützt.
Beim Aufruf der Plattform muss im HTTP-Header der Content "text/html" angegeben werden. Weiterhin muss der Zeichensatz angegeben werden, um eine eindeutige Interpretation zu ermöglichen. Für die Formulardaten muss der enctype "multipart/form-data" angegeben werden. Die gleichen Festlegungen gelten auch bei der späteren Rückübertragung zur Hook-URL.
Der Zeichensatz der xml Struktur für den Warenkorb soll in der xml Deklaration angegeben werden. Wird nichts angegeben, so wird utf-8 genutzt. Es kann in jeder Anfrage nur eine Artikelliste übermittelt werden.
Für die Übertragung wird die Nutzung von HTTPS empfohlen, grundsätzlich soll aber auch HTTP möglich sein. Das Protokoll wird von der Plattform vorgegeben.
Die Rück-Kommunikation zur Handwerkssoftware erfolgt über eine HOOK-URL. Diese wird als Parameter beim Aufruf der Plattform übertragen.
Zusätzlich kann der Parameter „Target“ angegeben werden. Hier wird das Target angegeben, welches durch die Handwerkssoftware überwacht wird, um den Abschluss der Rück-Kommunikation festzustellen. Das Target muss, nach Abschluss der Rück-Kommunikation, durch den Shop aktualisiert werden. Wird der Parameter nicht übertragen, wird „TOP“ als Standard-Target genutzt.
Die Festlegung, welche Aktion in der Plattform aufgerufen werden soll, erfolgt über einen Aktionsparameter.
Falls beim Aufruf Fehler auftreten, werden diese im Browserfenster angezeigt. Das genaue Fehlerhandling obliegt der einzelnen Plattform und wird hier nicht weiter betrachtet.
Hinweis: Der Parameter Hook-Url muss in jedem Fall mitgesendet werden, da nur dann eine Rückübertragung möglich ist.
Die Übertragung der Artikelliste erfolgt im Parameter „heatinglabel“ in den im Kapitel „Dateninhalte Heatinglabel“ beschriebenen Datenstrukturen. Die übertragene Artikelliste muss dem Schema „heatinglabel_senden.xsd“ entsprechen.
Bei der Verarbeitung der Artikelliste in der Plattform müssen folgende Punkte gegeben sein:
Es dürfen keine Positionen „verschluckt“ werden (bei der Verarbeitung entfallen) bzw. es muss eine entsprechende Fehlermeldung angezeigt werden.
Übertragene Positionsnummern müssen erhalten bleiben (RefItems).
b) Bearbeitung des Artikelliste
Dieser Schritt wird für den Prozess als Blackbox betrachtet.
Folgende Festlegungen wurden allerdings getroffen:
Das manuelle Verändern der Artikelliste soll in der Plattform möglich sein.
Hinzugefügte Positionen müssen bei der Rückübertragung mit einem entsprechenden Status versehen werden.
Beim Bearbeiten der Artikelliste müssen die übertragenen Positionsnummern erhalten bleiben.
c) Rückübertragung der Berechnungsergebnisse und der Artikelliste
Innerhalb der Plattform kann die Rückübertragung der Berechnungsergebnisse, des ErP-Labels, des Datenblatts und der Artikelliste an die HOOK-URL gestartet werden.
Die Rückübertragung der Artikelliste erfolgt in den im Kapitel „Dateninhalte Heatinglabel“ beschriebenen Datenstrukturen. Die übertragene Artikelliste muss dem Schema „heatinglabel_empfangen.xsd“ entsprechen.
Logininformationen
Über diese Funktion wird am Shop System angefragt, welche Logininformationen erforderlich sind.
Bei der Anfrage wird nur der Parameter Aktionscode = „LI“ für Logininformationen übertragen. Als Antwort wird folgende XML Struktur erwartet:
<Logininformationen>
<Kundennummer_erforderlich>false</Kundennummer_erforderlich>
<Benutzername_erforderlich>true</Benutzername_erforderlich>
<Passwort_erforderlich>true</Passwort_erforderlich>
</Logininformationen>
Erlaubte Werte sind true / false.
Schnittstellenversion
Über diese Funktion wird am Shop angefragt, welche Versionen der Schnittstelle unterstützt werden.
Bei der Anfrage wird nur der Parameter Aktionscode = „SV“ für Schnittstellenversion übertragen. Als Antwort wird folgende XML Struktur erwartet:
<Schnittstellenversionen>
<Version>1.3</Version>
<Version>2.0</Version>
<Version>2.1</Version>
<Version>2.2</Version>
<Version>2.3</Version>
</Schnittstellenversionen>
Erlaubte Werte sind „1.3“, „2.0“, „2.1“, „2.2“ und „2.3“.
Parameterdefinition
Innerhalb des Aufrufs der Funktionen können folgende Parameter übertragen werden:
...
Anfrage-parameter
...
Beschreibung
...
Muss / Kann
...
Format
...
HTTP Parameter
...
Kundennummer
...
Kundennummer des Anwenders beim angefragten Unternehmen
...
Kann
...
STRING 50
...
kndnr
...
Benutzername
...
Benutzername des Anwenders beim angefragten Unternehmen
...
Kann
...
STRING 50
...
name_kunde
...
Passwort
...
Passwort des Anwenders beim angefragten Unternehmen
...
Kann
...
STRING 50
...
pw_kunde
...
Aktionscode
...
Gibt an, welche Aktion aufgerufen wird.
Möglich sind hier z. B.
„WKS“ -> „Warenkorb Senden“ (Handwerkssoftware zum GH_Shop)
„WKE“ -> „Warenkorb Empfangen“ (Handwerkssoftware vom GH_Shop)
„ADL“ -> „Artikeldeeplink“
„LI“ -> „Logininformationen“
„SV“ -> „Schnittstellenversion“
„HLS“ -> „Heating Label“
„AS“ -> „Artikelsuche“
...
Muss
...
Codeliste Aktionen
...
action
...
Warenkorb
...
Parameter zur Übertragung des Warenkorbs.
Kann nur in Verbindung mit der Aktion WKS Warenkorb Senden genutzt werden
...
Kann
...
STRING
...
warenkorb
...
HOOK-URL
...
Angabe der Rücksprungadresse
...
Kann
...
STRING 256
...
hookurl
...
GH-Nummer
...
Angabe der Großhandelsartikelnummer zu der Daten angezeigt werden sollen.
Kann nur in Verbindung mit der Aktion ADL Artikeldeeplink genutzt werden.
...
Kann
...
STRING 35
...
ghnummer
...
Version
...
Angabe welche Version der Schnittstelle genutzt wird.
Konstant „2.3“
...
Kann
...
STRING 5
...
Version
...
Target
...
Angabe des Frames, in der die Aktualisierung nach dem Abschluss der Rück-Kommunikation durch den Shop erfolgt.
...
Kann
...
STRIG 50
...
Target
...
Heatinglabel
...
Parameter zur Übertragung der Artikelliste.
Kann nur in Verbindung mit der Aktion HLS Heatinglabel Senden genutzt werden
...
Kann
...
STRING
...
heatinglabel
...
Suchbegriff
...
Parameter zur Übertragung des Suchbegriffs.
Kann nur in Verbindung mit der Aktion „AS“ „Artikelsuche“ genutzt werden
...
Kann
...
STRING
...
searchterm
...
Mehrfachrückgabe
...
Angabe, ob die HookUrl mehrfach aus der Suche aufgerufen werden kann.
...
Kann
...
Boolesan
...
multipleResult
...
HookUrl Timeout
...
Angabe, wie lange eine Hook-URL initial oder nach der letzten Übertragung aktiv bleibt und eine Übertragung möglich ist.
Angabe ist in Sekunden
...
Kann
...
Integer
...
hookURLTimeout
1 Datentypen
Folgende skalare Datentypen werden verwendet:
...
Name
...
Beschreibung/Format
...
Beispiel
...
STRING
...
PCDATA
...
Freizeithemd Charlie
...
INTEGER
...
Ganzzahlige Zahl mit optionalem Vorzeichen. Keine Brüche. Keine Fließkommazahlen. Es ist kein Trennzeichen zum Abgrenzen von 1000er-Stellen erlaubt.
...
1; 58502; -13
...
DEZIMAL
...
Fließkommazahl in 64-bit IEEE Standard 488.
Dezimaltrennzeichen ist der Punkt. Es ist kein Trennzeichen zum Abgrenzen von 1000er-Stellen erlaubt.
...
.314159265358979E+1
...
BOOLEAN
...
Die Werte "true" oder "false" können angegeben werden.
...
true oder false
...
DATE
...
Datum im ISO 8601 Format (YYYY-MM-DD) (siehe http://www.w3.org/TR/NOTE-datetime)
...
2009-11-26
...
TIME
...
Zeit im ISO 8601 Format (HH:MM:SS) ohne Zeitzone (siehe http://www.w3.org/TR/NOTE-datetime)
...
16:17:55
Dateninhalte
Dateninhalte Warenkorb
...
Dateninhalt
...
Beschreibung
...
Muss / Kann
...
Einfach / Mehrfach
...
Format
...
Referenz XML
...
Kopfebene
...
Warenkorb
...
Struktur zur Abbildung des Warenkorbs
...
M
...
Einfach
...
-
...
Warenkorb
...
Warenkorb Info
...
Struktur zur Abbildung der Warenkorb-Informationen
...
M
...
Einfach
...
-
...
WarenkorbInfo
...
Nachrichten Datum
...
M
...
Einfach
...
DATE
...
WarenkorbInfo/Date
...
Nachrichten Uhrzeit
...
M
...
Einfach
...
TIME
...
WarenkorbInfo/Time
...
Rückgabekennzeichen
...
Nur die Werte
"Warenkorbrückgabe" und
"Warenkorbrückgabe mit Bestellung"
sind möglich.
Hinweis:
Das Rückgabekennzeichen ist für die Sendung des Warenkorbs an das Shop-System nicht relevant und kann nicht übertragen werden.
...
M / -
...
Einfach
...
STRING
...
WarenkorbInfo/RueckgabeKZ
...
Version
...
Angabe der Schnittstellenversion
Konstant „2.5.1“
...
M
...
Einfach
...
STRING 10
...
WarenkorbInfo/Version
...
Bestellung
...
Struktur zur Abbildung der Bestellung
...
M
...
Einfach
...
-
...
Order
...
Bestellinformationen
...
Struktur zur Abbildung der Bestellinformationen
...
K
...
Einfach
...
-
...
Order/OrderInfo
...
Anfragenummer
...
Anfragenummer aus der Handwerkssoftware
...
K
...
Einfach
...
STRING 15
...
Order/OrderInfo/InquiryNo
...
Angebotsnummer
...
Angebotsnummer aus dem Großhandels-System.
Bei der Übergabe eines Warenkorbs von der Handwerkssoftware zum Großhandels-System dient dieses Feld zur Referenzierung bestehender Angebote / Abrufaufträge usw., auf die sich die Positionen beziehen.
Hinweis: Es ist zu beachten, dass das referenzierte Angebot noch gültig ist.
...
K
...
Einfach
...
STRING 15
...
Order/OrderInfo/OfferNo
...
Bestellnummer
...
Bestellnummer aus der Handwerkssoftware
...
K
...
Einfach
...
STRING 15
...
Order/OrderInfo/PartNo
...
Auftragsbestätigungsnummer
...
Bestellnummer aus dem Großhandels-System
...
K
...
Einfach
...
STRING 15
...
Order/OrderInfo/OrderConfNo
...
Lieferwoche
...
Maximaler Wert: 53
Hinweis: Es darf nur Lieferwoche und Lieferjahr oder Lieferdatum übertragen werden.
...
K
...
Einfach
...
INTEGER
...
Order/OrderInfo/DeliveryWeek
...
Lieferjahr
...
Angabe des Lieferjahrs zur Lieferwoche. Maximal vier Ziffern.
Hinweis: Wenn eine Lieferwoche übertragen wird, muss auch das Lieferjahr übertragen werden.
...
K
...
Einfach
...
INTEGER
...
Order/OrderInfo/DeliveryYear
...
Lieferdatum
...
Hinweis: Es darf nur Lieferwoche und Lieferjahr oder Lieferdatum übertragen werden.
...
K
...
Einfach
...
DATE
...
Order/OrderInfo/DeliveryDate
...
Versandart
...
Es sind nur die Werte „Lieferung“ oder „Abholung“ erlaubt
...
M
...
Einfach
...
STRING 30
...
Order/OrderInfo/ModeOfShipment
...
Währung
...
Verwendet werden die Währungen entsprechend der Codeliste der ISO 4217
...
K
...
Einfach
...
STRING 3
...
Order/OrderInfo/Cur
...
Zusätzlicher Text
...
Reiner Hinweistext z. B. für den Fahrer
...
K
...
Einfach
...
STRING 100
...
Order/OrderInfo/ZusatzText
...
Kommission
...
K
...
Einfach
...
STRING 80
...
Order/OrderInfo/Kommission
...
Lieferantendaten
...
Struktur zur Abbildung der Lieferantendaten
...
K
...
Einfach
...
-
...
Order/SupplierInfo
...
Lieferantennummer
...
Lieferantennummer beim Handwerker
gestartet werden.
Artikelsuche
Über diese Funktion wird die Artikelsuche im Großhandelsshop oder in Open Datapool aufgerufen. Hierzu wird der Suchbegriff als Parameter übertragen.
Für den Prozess wurden folgende Prozessschritte definiert.
a) Starten der Suche aus der Handwerkssoftware in einem Browserfenster
Beim Aufruf der Plattform soll eine automatische Anmeldung erfolgen, falls diese erforderlich ist. Hierfür können bei der Anfrage die Parameter „Kundennummer“, „Benutzername“ und „Passwort“ übertragen werden.
Bei der Übertragung der Parameter muss die POST Variante (komplexere Implementierung aber unbegrenzte Parameterlänge) möglich sein. Die GET Variante wird aufgrund der nicht ausreichenden Länge der Parameter nicht unterstützt.
Beim Aufruf der Plattform muss im HTTP-Header der Content "text/html" angegeben werden. Weiterhin muss der Zeichensatz angegeben werden, um eine eindeutige Interpretation zu ermöglichen. Für die Formulardaten muss der enctype "multipart/form-data" angegeben werden. Die gleichen Festlegungen gelten auch bei der späteren Rückübertragung zur Hook-URL.
Der Zeichensatz der xml Struktur für den Warenkorb soll in der xml Deklaration angegeben werden. Wird nichts angegeben, so wird utf-8 genutzt. Es kann in jeder Anfrage nur eine Artikelliste übermittelt werden.
Für die Übertragung wird die Nutzung von HTTPS empfohlen, grundsätzlich soll aber auch HTTP möglich sein. Das Protokoll wird von der Plattform vorgegeben.
Die Rück-Kommunikation zur Handwerkssoftware erfolgt über eine HOOK-URL. Diese wird als Parameter beim Aufruf der Plattform übertragen.
Zusätzlich kann der Parameter „Target“ angegeben werden. Hier wird das Target angegeben, welches durch die Handwerkssoftware überwacht wird, um den Abschluss der Rück-Kommunikation festzustellen. Das Target muss, nach Abschluss der Rück-Kommunikation, durch den Shop aktualisiert werden. Wird der Parameter nicht übertragen, wird „TOP“ als Standard-Target genutzt.
Die Festlegung, welche Aktion in der Plattform aufgerufen werden soll, erfolgt über den Aktionsparameter ("AS“).
Zur Angabe, ob eine mehrfache Übertragung an die HookURL vom aufrufenden System unterstützt wird, kan der Parameter “multipleResult“ mit “true” verwendet werden. Ist der Parameter nicht vorhanden, wird die Mehrfachübertragung nicht unterstützt.
Um dem Shop mitzuteilen wie lange eine Übertragung an den HoohkURL möglich ist kann der Parameter “hookURLTimeout“ übergeben werden. Diese gibt an (Sekunden), wie lange eine Hook-URL initial oder nach der letzten Übertragung aktiv bleibt und eine Übertragung möglich ist.
Falls beim Aufruf Fehler auftreten, werden diese im Browserfenster angezeigt. Das genaue Fehlerhandling obliegt der einzelnen Plattform und wird hier nicht weiter betrachtet.
Hinweis: Der Parameter Hook-Url muss in jedem Fall mitgesendet werden, da nur dann eine Rückübertragung möglich ist.
Die Übertragung des Suchbegriffs erfolgt im Parameter „searchterm“.
In Parameter „searchterm“ können mehrere Begriffe, getrennt durch Leerzeichen, angegeben werden.
Die Anwendung des Suchstrings erfolgt durch die Suchengine des empfangenden Systems entsprechend der dort vorhandenen Logik. Die konkrete Suchlogik wird durch den Aufruf nicht beeinflusst.
Als Ergebnis des Aufrufs wird das Suchergebnis angezeigt.
a) Aktionen im aufgerufenen System
Dieser Schritt wird für den Prozess als Blackbox betrachtet, da die möglichen Aktionen innerhalb der einzelnen aufgerufenen Systeme unterschiedlich sein können.
b) Übernahme der Artikel
Die Übertragung der Artikel erfolgt in den im Kapitel „Dateninhalte“ beschriebenen Datenstrukturen. Der übertragene Warenkorb muss dem Schema „Warenkorb_empfangen_2-5.xsd“ entsprechen.
Die Übernahme der Daten erfolgt als Übertragung eines Formulars an die HOOK-URL analog der OCI Schnittstelle.
c) Schließen des Systems
Nach Abschluss der Verarbeitung kann das Browserfenster geschlossen werden und der Prozess ist abgeschlossen. Die Steuerung obligt der Handwerkssoftware und wird nicht durch den Shop vorgegeben. So ist eine mehrfache Übertragung an eine HOOK-URL möglich.
Heatinglabel senden
Über diese Funktion soll die Übergabe einer Artikelliste aus der Handwerkssoftware in eine Plattform zur Berechnung des ErP-Labels realisiert werden.
Für den Prozess wurden folgende Prozessschritte abgestimmt.
a) Starten der Plattform aus der Handwerkssoftware in einem Browserfenster
Beim Aufruf der Plattform soll eine automatische Anmeldung erfolgen, falls diese erforderlich ist. Hierfür können bei der Anfrage die Parameter „Kundennummer“, „Benutzername“ und „Passwort“ übertragen werden.
Bei der Übertragung der Parameter muss die POST Variante (komplexere Implementierung aber unbegrenzte Parameterlänge) möglich sein. Die GET Variante wird auf Grund der nicht ausreichenden Länge der Parameter nicht unterstützt.
Beim Aufruf der Plattform muss im HTTP-Header der Content "text/html" angegeben werden. Weiterhin muss der Zeichensatz angegeben werden, um eine eindeutige Interpretation zu ermöglichen. Für die Formulardaten muss der enctype "multipart/form-data" angegeben werden. Die gleichen Festlegungen gelten auch bei der späteren Rückübertragung zur Hook-URL.
Der Zeichensatz der xml Struktur für den Warenkorb soll in der xml Deklaration angegeben werden. Wird nichts angegeben, so wird utf-8 genutzt. Es kann in jeder Anfrage nur eine Artikelliste übermittelt werden.
Für die Übertragung wird die Nutzung von HTTPS empfohlen, grundsätzlich soll aber auch HTTP möglich sein. Das Protokoll wird von der Plattform vorgegeben.
Die Rück-Kommunikation zur Handwerkssoftware erfolgt über eine HOOK-URL. Diese wird als Parameter beim Aufruf der Plattform übertragen.
Zusätzlich kann der Parameter „Target“ angegeben werden. Hier wird das Target angegeben, welches durch die Handwerkssoftware überwacht wird, um den Abschluss der Rück-Kommunikation festzustellen. Das Target muss, nach Abschluss der Rück-Kommunikation, durch den Shop aktualisiert werden. Wird der Parameter nicht übertragen, wird „TOP“ als Standard-Target genutzt.
Die Festlegung, welche Aktion in der Plattform aufgerufen werden soll, erfolgt über einen Aktionsparameter.
Falls beim Aufruf Fehler auftreten, werden diese im Browserfenster angezeigt. Das genaue Fehlerhandling obliegt der einzelnen Plattform und wird hier nicht weiter betrachtet.
Hinweis: Der Parameter Hook-Url muss in jedem Fall mitgesendet werden, da nur dann eine Rückübertragung möglich ist.
Die Übertragung der Artikelliste erfolgt im Parameter „heatinglabel“ in den im Kapitel „Dateninhalte Heatinglabel“ beschriebenen Datenstrukturen. Die übertragene Artikelliste muss dem Schema „heatinglabel_senden.xsd“ entsprechen.
Bei der Verarbeitung der Artikelliste in der Plattform müssen folgende Punkte gegeben sein:
Es dürfen keine Positionen „verschluckt“ werden (bei der Verarbeitung entfallen) bzw. es muss eine entsprechende Fehlermeldung angezeigt werden.
Übertragene Positionsnummern müssen erhalten bleiben (RefItems).
b) Bearbeitung des Artikelliste
Dieser Schritt wird für den Prozess als Blackbox betrachtet.
Folgende Festlegungen wurden allerdings getroffen:
Das manuelle Verändern der Artikelliste soll in der Plattform möglich sein.
Hinzugefügte Positionen müssen bei der Rückübertragung mit einem entsprechenden Status versehen werden.
Beim Bearbeiten der Artikelliste müssen die übertragenen Positionsnummern erhalten bleiben.
c) Rückübertragung der Berechnungsergebnisse und der Artikelliste
Innerhalb der Plattform kann die Rückübertragung der Berechnungsergebnisse, des ErP-Labels, des Datenblatts und der Artikelliste an die HOOK-URL gestartet werden.
Die Rückübertragung der Artikelliste erfolgt in den im Kapitel „Dateninhalte Heatinglabel“ beschriebenen Datenstrukturen. Die übertragene Artikelliste muss dem Schema „heatinglabel_empfangen.xsd“ entsprechen.
Logininformationen
Über diese Funktion wird am Shop System angefragt, welche Logininformationen erforderlich sind.
Bei der Anfrage wird nur der Parameter Aktionscode = „LI“ für Logininformationen übertragen. Als Antwort wird folgende XML Struktur erwartet:
<Logininformationen>
<Kundennummer_erforderlich>false</Kundennummer_erforderlich>
<Benutzername_erforderlich>true</Benutzername_erforderlich>
<Passwort_erforderlich>true</Passwort_erforderlich>
</Logininformationen>
Erlaubte Werte sind true / false.
Schnittstellenversion
Über diese Funktion wird am Shop angefragt, welche Versionen der Schnittstelle unterstützt werden.
Bei der Anfrage wird nur der Parameter Aktionscode = „SV“ für Schnittstellenversion übertragen. Als Antwort wird folgende XML Struktur erwartet:
<Schnittstellenversionen>
<Version>1.3</Version>
<Version>2.0</Version>
<Version>2.1</Version>
<Version>2.2</Version>
<Version>2.3</Version>
</Schnittstellenversionen>
Erlaubte Werte sind „1.3“, „2.0“, „2.1“, „2.2“ und „2.3“.
Parameterdefinition
Innerhalb des Aufrufs der Funktionen können folgende Parameter übertragen werden:
Anfrage-parameter | Beschreibung | Muss / Kann | Format | HTTP Parameter |
Kundennummer | Kundennummer des Anwenders beim angefragten Unternehmen | Kann | STRING 50 | kndnr |
Benutzername | Benutzername des Anwenders beim angefragten Unternehmen | Kann | STRING 50 | name_kunde |
Passwort | Passwort des Anwenders beim angefragten Unternehmen | Kann | STRING 50 | pw_kunde |
Aktionscode | Gibt an, welche Aktion aufgerufen wird. Möglich sind hier z. B. „WKS“ -> „Warenkorb Senden“ (Handwerkssoftware zum GH_Shop) „WKE“ -> „Warenkorb Empfangen“ (Handwerkssoftware vom GH_Shop) „ADL“ -> „Artikeldeeplink“ „LI“ -> „Logininformationen“ „SV“ -> „Schnittstellenversion“ „HLS“ -> „Heating Label“ „AS“ -> „Artikelsuche“ | Muss | Codeliste Aktionen | action |
Warenkorb | Parameter zur Übertragung des Warenkorbs. Kann nur in Verbindung mit der Aktion WKS Warenkorb Senden genutzt werden | Kann | STRING | warenkorb |
HOOK-URL | Angabe der Rücksprungadresse | Kann | STRING 256 | hookurl |
GH-Nummer | Angabe der Großhandelsartikelnummer zu der Daten angezeigt werden sollen. Kann nur in Verbindung mit der Aktion ADL Artikeldeeplink genutzt werden. | Kann | STRING 35 | ghnummer |
Version | Angabe welche Version der Schnittstelle genutzt wird. Konstant „2.3“ | Kann | STRING 5 | Version |
Target | Angabe des Frames, in der die Aktualisierung nach dem Abschluss der Rück-Kommunikation durch den Shop erfolgt. | Kann | STRIG 50 | Target |
Heatinglabel | Parameter zur Übertragung der Artikelliste. Kann nur in Verbindung mit der Aktion HLS Heatinglabel Senden genutzt werden | Kann | STRING | heatinglabel |
Suchbegriff | Parameter zur Übertragung des Suchbegriffs. Kann nur in Verbindung mit der Aktion „AS“ „Artikelsuche“ genutzt werden | Kann | STRING | searchterm |
Mehrfachrückgabe | Angabe, ob die HookUrl mehrfach aus der Suche aufgerufen werden kann. | Kann | Boolesan | multipleResult |
HookUrl Timeout | Angabe, wie lange eine Hook-URL initial oder nach der letzten Übertragung aktiv bleibt und eine Übertragung möglich ist. Angabe ist in Sekunden | Kann | Integer | hookURLTimeout |
1 Datentypen
Folgende skalare Datentypen werden verwendet:
Name | Beschreibung/Format | Beispiel |
STRING | PCDATA | Freizeithemd Charlie |
INTEGER | Ganzzahlige Zahl mit optionalem Vorzeichen. Keine Brüche. Keine Fließkommazahlen. Es ist kein Trennzeichen zum Abgrenzen von 1000er-Stellen erlaubt. | 1; 58502; -13 |
DEZIMAL | Fließkommazahl in 64-bit IEEE Standard 488. Dezimaltrennzeichen ist der Punkt. Es ist kein Trennzeichen zum Abgrenzen von 1000er-Stellen erlaubt. | .314159265358979E+1 |
BOOLEAN | Die Werte "true" oder "false" können angegeben werden. | true oder false |
DATE | Datum im ISO 8601 Format (YYYY-MM-DD) (siehe http://www.w3.org/TR/NOTE-datetime) | 2009-11-26 |
TIME | Zeit im ISO 8601 Format (HH:MM:SS) ohne Zeitzone (siehe http://www.w3.org/TR/NOTE-datetime) | 16:17:55 |
Dateninhalte
Dateninhalte Warenkorb
Dateninhalt | Beschreibung | Muss / Kann | Einfach / Mehrfach | Format | Referenz XML | ||||||||
Kopfebene | |||||||||||||
Warenkorb | Struktur zur Abbildung des Warenkorbs | M | Einfach | - | Warenkorb | ||||||||
Warenkorb Info | Struktur zur Abbildung der Warenkorb-Informationen | M | Einfach | - | WarenkorbInfo | ||||||||
Nachrichten Datum | M | Einfach | DATE | WarenkorbInfo/Date | |||||||||
Nachrichten Uhrzeit | M | Einfach | TIME | WarenkorbInfo/Time | |||||||||
Rückgabekennzeichen | Nur die Werte "Warenkorbrückgabe" und "Warenkorbrückgabe mit Bestellung" sind möglich. Hinweis: Das Rückgabekennzeichen ist für die Sendung des Warenkorbs an das Shop-System nicht relevant und kann nicht übertragen werden. | M / - | Einfach | STRING | WarenkorbInfo/RueckgabeKZ | ||||||||
Version | Angabe der Schnittstellenversion Konstant „2.5.1“ | M | Einfach | STRING 10 | WarenkorbInfo/Version | ||||||||
Bestellung | Struktur zur Abbildung der Bestellung | M | Einfach | - | Order | ||||||||
Belegreferenz | Referenz auf Belege. Pro Referenz werden die folgenden Angaben übertragen:
| K | Mehrfach | - | Order/Referenz | ||||||||
Belegnummer | M | Einfach | STRING 15 | Order/Referenz/DocumentNumber | |||||||||
Belegdatum | M | Einfach | Date | Order/Referenz/DocumentDate | |||||||||
Belegart | M | Einfach | Codeliste Belegart | Order/Referenz/DocumentType | |||||||||
Bestellinformationen | Struktur zur Abbildung der Bestellinformationen | K | Einfach | - | Order/OrderInfo | ||||||||
Lieferwoche | Maximaler Wert: 53 Hinweis: Es darf nur Lieferwoche und Lieferjahr oder Lieferdatum übertragen werden. | K | Einfach | INTEGER | Order/OrderInfo/DeliveryWeek | ||||||||
Lieferjahr | Angabe des Lieferjahrs zur Lieferwoche. Maximal vier Ziffern. Hinweis: Wenn eine Lieferwoche übertragen wird, muss auch das Lieferjahr übertragen werden. | K | Einfach | INTEGER | Order/OrderInfo/DeliveryYear | ||||||||
Lieferdatum | Hinweis: Es darf nur Lieferwoche und Lieferjahr oder Lieferdatum übertragen werden. | K | Einfach | DATE | Order/OrderInfo/DeliveryDate | ||||||||
Versandart | Es sind nur die Werte „Lieferung“ oder „Abholung“ erlaubt | M | Einfach | STRING 30 | Order/OrderInfo/ModeOfShipment | ||||||||
Währung | Verwendet werden die Währungen entsprechend der Codeliste der ISO 4217 | K | Einfach | STRING 3 | Order/OrderInfo/Cur | ||||||||
Zusätzlicher Text | Reiner Hinweistext z. B. für den Fahrer | K | Einfach | STRING 100 | Order/OrderInfo/ZusatzText | ||||||||
Kommission | K | Einfach | STRING 80 | Order/OrderInfo/Kommission | |||||||||
Lieferantendaten | Struktur zur Abbildung der Lieferantendaten | K | Einfach | - | Order/SupplierInfo | ||||||||
Lieferantennummer | Lieferantennummer beim Handwerker | K | Einfach | STRING 40 | Order/SupplierInfo/IDNo | ||||||||
Lieferantenadresse | Struktur zur Abbildung der Lieferantenadresse | K | Einfach | - | Order/SupplierInfo/Address/ | ||||||||
Lieferantenadresse / Name1 | Die Angabe „Name der Lieferadresse“ kann mit bis zu 3 * 40 Zeichen erfolgen. Die Angabe „Straße und Hausnummer“ kann mit bis zu 3 * 40 Zeichen erfolgen. In Summe dürfen maximal 4 * 40 Zeichen verwendet werden. Die Informationen müssen in den ODX-Belegen und in der IDS-Connect Schnittstelle immer in den korrekten Feldern übertragen werden, sodass eine automatische Verarbeitung möglich ist. | K | Einfach | STRING 40 | Order/SupplierInfo/Address/Name1 | ||||||||
Lieferantenadresse / Name2 | K | Einfach | STRING 40 | Order/SupplierInfo/Address/Name2 | |||||||||
Lieferantenadresse / Name3 | K | Einfach | STRING 40 | Order/SupplierInfo/Address/Name3 | |||||||||
|
|
|
|
| |||||||||
Lieferantenadresse / Straße1 | K | Einfach | STRING 40 | Order/SupplierInfo/Address/Street1 | |||||||||
Lieferantenadresse / Straße2 | K | Einfach | STRING 40 | Order/SupplierInfo/Address/Street2 | |||||||||
Lieferantenadresse / Straße3 | K | Einfach | STRING 40 | Order/SupplierInfo/ | IDNoAddress/Street3 | ||||||||
Lieferantenadresse Struktur zur Abbildung der Lieferantenadresse/ PLZ | K | Einfach | STRING 9 | Order/SupplierInfo/Address/PCode | |||||||||
Lieferantenadresse / Ort | K | Einfach- | STRING 40 | Order/SupplierInfo/Address/City | |||||||||
Lieferantenadresse / Name1Land | K | Einfach | STRING 40 | Order/SupplierInfo/Address/Name1Country | |||||||||
Lieferantenadresse / Name2ILN | K | Einfach | STRING 4020 | Order/SupplierInfo/Address/Name2ILN | |||||||||
Lieferantenadresse / Name3Ansprechpartner | K | Einfach | STRING 40 | Order/SupplierInfo/Address/Name3Contact | |||||||||
Lieferantenadresse / Name4Telefonnummer | K | Einfach | STRING 4020 | Order/SupplierInfo/Address/Name4Phone | |||||||||
Lieferantenadresse / StraßeFaxnummer | K | Einfach | STRING 4020 | Order/SupplierInfo/Address/StreetFax | |||||||||
Lieferantenadresse / PLZEmail-Adresse | K | Einfach | STRING 20256 | Order/SupplierInfo/Address/PCodeLieferantenadresse / OrtEmail | |||||||||
Kundendaten | Struktur zur Abbildung der Kundendaten | K | Einfach | STRING 40- | Order/SupplierInfo/Address/CityLieferantenadresse / LandCustomerInfo | ||||||||
Kundennummer | Kundennummer des Handwerkers beim Lieferanten | K | Einfach | STRING 40 | Order/SupplierInfo/Address/CountryLieferantenadresse / ILNCustomerInfo/IDNo | ||||||||
Kundenadresse | Struktur zur Abbildung der Kundenadresse | K | Einfach | STRING 20- | Order/SupplierInfoCustomerInfo/Address/ILN | Lieferantenadresse / Ansprechpartner | K | Einfach | STRING 40 | Order/SupplierInfo/Address/Contact | Lieferantenadresse / Telefonnummer | ||
Kundenadresse / Name1 | Die Angabe „Name der Lieferadresse“ kann mit bis zu 3 * 40 Zeichen erfolgen. Die Angabe „Straße und Hausnummer“ kann mit bis zu 3 * 40 Zeichen erfolgen. In Summe dürfen maximal 4 * 40 Zeichen verwendet werden. Die Informationen müssen in den ODX-Belegen und in der IDS-Connect Schnittstelle immer in den korrekten Feldern übertragen werden, sodass eine automatische Verarbeitung möglich ist. | K | Einfach | STRING 2040 | Order/SupplierInfoCustomerInfo/Address/PhoneName1 | ||||||||
Lieferantenadresse Kundenadresse / FaxnummerName2 | K | Einfach | STRING 2040 | Order/SupplierInfoCustomerInfo/Address/FaxName2 | |||||||||
Lieferantenadresse Kundenadresse / Email-AdresseName3 | K | Einfach | STRING 25640 | Order/SupplierInfoCustomerInfo/Address/Email | |||||||||
Kundendaten | Struktur zur Abbildung der Kundendaten | K | Einfach | - | Order/CustomerInfo | ||||||||
Kundennummer | Kundennummer des Handwerkers beim LieferantenName3 | ||||||||||||
|
|
|
|
| IDNo
| ||||||||
Kundenadresse | Struktur zur Abbildung der Kundenadresse/ Straße1 | K | Einfach | -STRING 40 | Order/CustomerInfo/Address/Street1 | ||||||||
Kundenadresse / | Name1Straße2 | K | Einfach | STRING 40 | Order/CustomerInfo/Address/ | Name1Street2 | |||||||
Kundenadresse / | Name2Straße3 | K | Einfach | STRING 40 | Order/CustomerInfo/Address/ | Name2Street3 | |||||||
Kundenadresse / Name3PLZ | K | Einfach | STRING 409 | Order/CustomerInfo/Address/Name3PCode | |||||||||
Kundenadresse / Name4Ort | K | Einfach | STRING 40 | Order/CustomerInfo/Address/Name4City | |||||||||
Kundenadresse / StraßeLand | K | Einfach | STRING 40 | Order/CustomerInfo/Address/StreetCountry | |||||||||
Kundenadresse / PLZILN | K | Einfach | STRING 20 | Order/CustomerInfo/Address/PCodeILN | |||||||||
Kundenadresse / OrtAnsprechpartner | K | Einfach | STRING 40 | Order/CustomerInfo/Address/CityContact | |||||||||
Kundenadresse / LandTelefonnummer | K | Einfach | STRING 4020 | Order/CustomerInfo/Address/CountryPhone | |||||||||
Kundenadresse / ILNFaxnummer | K | Einfach | STRING 20 | Order/CustomerInfo/Address/ILNFax | |||||||||
Kundenadresse / AnsprechpartnerEmail-Adresse | K | Einfach | STRING 40256 | Order/CustomerInfo/Address/ContactKundenadresse / Telefonnummer/Email | |||||||||
Lieferdaten | Struktur zur Abbildung der Lieferadresse bzw. Abholadresse abhängig von der Versandart | K | Einfach | - | Order/DeliveryPlaceInfo | ||||||||
Lieferadresse | Struktur zur Abbildung der Liefer- oder Abholadresse abhängig von der Versandart Hinweis: Die Lieferadresse sollte nur angegeben werden, wenn diese von der Kundenadresse (bei der Versandart „Lieferung“) oder von der Lieferantenadresse (bei der Versandart „Lieferung“) abweicht. | K | Einfach | STRING 20- | Order/CustomerInfoDeliveryPlaceInfo/Address/Phone | ||||||||
Kundenadresse Lieferadresse / Faxnummer | K | Einfach | STRING 20 | Order/CustomerInfo/Address/Fax | Kundenadresse / Email-Adresse | K | Einfach | STRING 256 | Order/CustomerInfo/Address/Email | ||||
Lieferdaten | Struktur zur Abbildung der Lieferadresse bzw. Abholadresse abhängig von der Versandart | K | Einfach | - | Order/DeliveryPlaceInfo | ||||||||
Lieferadresse | Struktur zur Abbildung der Liefer- oder Abholadresse abhängig von der Versandart Hinweis: Die Lieferadresse sollte nur angegeben werden, wenn diese von der Kundenadresse (bei der Versandart „Lieferung“) oder von der Lieferantenadresse (bei der Versandart „Lieferung“) abweicht. | K | Einfach | -Name1 | Die Angabe „Name der Lieferadresse“ kann mit bis zu 3 * 40 Zeichen erfolgen. Die Angabe „Straße und Hausnummer“ kann mit bis zu 3 * 40 Zeichen erfolgen. In Summe dürfen maximal 4 * 40 Zeichen verwendet werden. Die Informationen müssen in den ODX-Belegen und in der IDS-Connect Schnittstelle immer in den korrekten Feldern übertragen werden, sodass eine automatische Verarbeitung möglich ist. | K | Einfach | STRING 40 | Order/DeliveryPlaceInfo/Address/Name1 | ||||
Lieferadresse / Name2 | K | Einfach | STRING 40 | Order/DeliveryPlaceInfo/Address/Name2 | |||||||||
Lieferadresse / Name1Name3 | K | Einfach | STRING 40 | Order/DeliveryPlaceInfo/Address/Name1Name3 | |||||||||
| Name2
|
|
|
|
| Name2
| |||||||
Lieferadresse / | Name3Straße1 | K | Einfach | STRING 40 | Order/DeliveryPlaceInfo/Address/ | Name3Street1 | |||||||
Lieferadresse / | Name4Straße2 | K | Einfach | STRING 40 | Order/DeliveryPlaceInfo/Address/ | Name4Street2 | |||||||
Lieferadresse / | StraßeStraße3 | K | Einfach | STRING 40 | Order/DeliveryPlaceInfo/Address/ | StreetStreet3 | |||||||
Lieferadresse / PLZ | K | Einfach | STRING 209 | Order/DeliveryPlaceInfo/Address/PCode | |||||||||
Lieferadresse / Ort | K | Einfach | STRING 40 | Order/DeliveryPlaceInfo/Address/City | |||||||||
Lieferadresse / Land | K | Einfach | STRING 40K | Einfach | STRING 40 | Order/DeliveryPlaceInfo/Address/Country | |||||||
Lieferadresse / Geo-Latitude | Breitengrad -90.0 bis 90.0 Grad | k | Einfach | DEZIMAL 2,8 | Order/DeliveryPlaceInfo/Address/GeoLat | ||||||||
Lieferadresse / Geo-Longitute | Längengrad -180.0 bis 180.0 Grad | k | Einfach | DEZIMAL 2,8 | Order/DeliveryPlaceInfo/Address/ | CountryGeoLong | |||||||
Lieferadresse / ILN | K | Einfach | STRING 20 | Order/DeliveryPlaceInfo/Address/ILN | |||||||||
Lieferadresse / Ansprechpartner | K | Einfach | STRING 40 | Order/DeliveryPlaceInfo/Address/Contact | |||||||||
Lieferadresse / Telefonnummer | K | Einfach | STRING 20 | Order/DeliveryPlaceInfo/Address/Phone | |||||||||
Lieferadresse / Faxnummer | K | Einfach | STRING 20 | Order/DeliveryPlaceInfo/Address/Fax | |||||||||
Lieferadresse / E-Mail-Adresse | K | Einfach | STRING 256 | Order/DeliveryPlaceInfo/Address/Email | |||||||||
Position | |||||||||||||
Warenkorbposition | Struktur für die Warenkorbpositionen | M | Mehrfach | - | Order/OrderItem | ||||||||
Positionskennzeichen | „normal“ = Normalposition „alternate“ = Alternativposition „provis“ = Bedarfsposition | K | Einfach | STRING | Order/OrderItem/ItemChara | ||||||||
Referenzenangaben | Struktur für die Positionsnummer des Handwerkers und des Großhändlers | K | Einfach | - | Order/OrderItem/RefItems | ||||||||
Positionsnummer des Handwerkers | Darf bei der Verarbeitung im Großhandelssystem nicht verändert oder gelöscht werden. | K | Einfach | STRING 35 | Order/OrderItem/RefItems/Customer | ||||||||
Unterpositionsnummer des Handwerkers | Darf bei der Verarbeitung im Großhandelssystem nicht verändert oder gelöscht werden. | K | Einfach | STRING 35 | Order/OrderItem/RefItems/CustomerSubNo | ||||||||
Positionsnummer des Großhändlers | Darf bei der Verarbeitung in der Handwerkssoftware nicht verändert oder gelöscht werden. | K | Einfach | STRING 35 | Order/OrderItem/RefItems/Supplier | ||||||||
Unterpositionsnummer des Großhändlers | Darf bei der Verarbeitung in der Handwerkssoftware nicht verändert oder gelöscht werden. | K | Einfach | STRING 35 | Order/OrderItem/RefItems/SupplierSubNo | ||||||||
GTIN (EAN) | K | Einfach | DEZIMAL 13,0 | Order/OrderItem/EAN | |||||||||
HerstellerID | Identifikation des Herstellers | K | Einfach | STRING 40 | Order/OrderItem/ManufacturerID | ||||||||
HerstellerID Typ | Typ der Identifikation des Herstellers (z. B. DUNS, GLN, ...) | K | Einfach | STRING 40 | Order/OrderItem/ManufacturerIDType | ||||||||
Artikelnummer des Lieferanten | Großhändlernummer des Artikels | M | Einfach | STRING 15 | Order/OrderItem/ArtNo | ||||||||
Anfrage- / Angebots-Menge | M | Einfach | DEZIMAL 13,2 | Order/OrderItem/Qty | |||||||||
Anfrage- / Angebots-Mengeneinheit | Erlaubt sind die Werte der Codeliste Mengeneinheiten (siehe Anhang) | M | Einfach | STRING 4 | Order/OrderItem/QU | ||||||||
Positions- oder Artikelkurztext | K | Einfach | STRING 100 | Order/OrderItem/Kurztext/ | |||||||||
Positions- oder Artikellangtext | K | Einfach | STRING | Order/OrderItem/Langtext/ | |||||||||
Angebotspreis | Brutto-, Listenpreis Hinweis: Für die Übertragung zur Handwerkssoftware Muss, für die Übertragung zum Shop-System Kann. | M / K | Einfach | DEZIMAL 10,4 | Order/OrderItem/OfferPrice | ||||||||
Nettopreis | Einkaufspreis des Kunden. Beinhaltet Rabatte bzw. Rohstoffanteile und bezieht sich immer auf die Anfragemenge und Mengeneinheit. Hinweis: Für die Übertragung zur Handwerkssoftware Muss, für die Übertragung zum Shop-System Kann. | M / K | Einfach | DEZIMAL 10,4 | Order/OrderItem/NetPrice | ||||||||
Preisbasis | Preis bezieht sich auf "n" Einheiten der Anfrage- / Angebots-Mengeneinheit. Hinweis: Für die Übertragung zur Handwerkssoftware Muss, für die Übertragung zum Shop-System Kann. | M / K | Einfach | DEZIMAL 10,2 | Order/OrderItem/PriceBasis | ||||||||
Mehrwertsteuer | Angabe in % Hinweis: Für die Übertragung zur Handwerkssoftware Muss, für die Übertragung zum Shop-System Kann. | M / K | Einfach | DEZIMAL 5,2 | Order/OrderItem/VAT | ||||||||
Technische Klärung erforderlich | Yes / No | K | Einfach | STRING 3 | Order/OrderItem/TechnClarification | ||||||||
Wichtiger Hinweis | Das Feld dient zur Übertragung wichtiger Hinweise, die dem Nutzer zur Anzeige gebracht werden müssen. | K | Einfach | STRING | Order/OrderItem/Hinweis | ||||||||
Fehlercode | Erlaubt sind die Werte der Codeliste Fehlercodes (siehe Anhang). | K | Einfach | INTEGER | Order/OrderItem/Fehlercode | ||||||||
Fehlertext | Fehlerbeschreibung zur Position; vom Großhändler-System ausgegeben. | K | Einfach | STRING 256 | Order/OrderItem/Fehlertext | ||||||||
Prozentualer Zuschlag | Prozentualer Zuschlag der Position. Rabatte werden als negative Zuschläge übertragen. | K | Einfach | DEZIMAL 10,4 | Order/OrderItem/Zuschlag | ||||||||
Rohstoffanteil | Struktur zur Abbildung der Rohstoffanteile für NE-Metalle. | K | Mehrfach | - | Order/OrderItem/Rohstoffanteil | ||||||||
Rohstoff | Angabe des Rohstoffs, zu dem Daten übertragen werden sollen (siehe Anhang). Erlaubt sind die Werte der Codeliste Rohstoffe (siehe Anhang). | K | Einfach | STRING 3 | Order/OrderItem/Rohstoffanteil/Rohstoff | ||||||||
Gewichtsanteilswert | Angabe des Gewichtsanteils (siehe Anhang). | K | Einfach | DEZIMAL 10,4 | Order/OrderItem/Rohstoffanteil/Gewichtsanteilswert | ||||||||
Gewichtsanteilseinheit | Angabe der Gewichtsanteilseinheit (siehe Anhang). Erlaubt sind die Werte der Codeliste Mengeneinheiten (siehe Anhang).). | K | Einfach | STRING 3 | Order/OrderItem/Rohstoffanteil/Gewichtsanteilseinheit | ||||||||
Basiswert | Angabe des Basiswerts, auf den sich der Gewichtsanteil bezieht (siehe Anhang). | K | Einfach | DEZIMAL 10,4 | Order/OrderItem/Rohstoffanteil/Basiswert | ||||||||
Basiseinheit | Angabe der Basiseinheit, auf die sich der Gewichtsanteil bezieht (siehe Anhang). Erlaubt sind die Werte der Codeliste Mengeneinheiten (siehe Anhang). | K | Einfach | STRING 3 | Order/OrderItem/Rohstoffanteil/Basiseinheit | ||||||||
Basis Notierung | K | EinfachSTRING 3 | DEZIMAL 10,4 | Order/OrderItem/Rohstoffanteil/GewichtsanteilseinheitBasisnotierung | Basiswert | ||||||||
Aktuelle Notierung | Beinhaltet die Rohstoffnotierung, mit der der Nettopreis berechnet wurde; muss nicht der aktuellen Rohstoffnotierung entsprechen, da ggf. für Kontingente fixiert. | K | Einfach | DEZIMAL 10,4 | Order/OrderItem/Rohstoffanteil/BasiswertNotierungAktuell | ||||||||
BasiseinheitKennzeichen „Diverser Artikel“ | Angabe der Basiseinheit, auf die sich der Gewichtsanteil bezieht (siehe Anhang).Erlaubt sind die Werte der Codeliste Mengeneinheiten (siehe Anhang)ob es sich bei dem Artikel um einen Diversen Artikel handelt. | K | Einfach | BOOLEAN | Order/OrderItem/Divers | ||||||||
Summe Rohstoffzuschläge | Summe aller Rohstoffzuschläge bezogen auf die angefragte Menge und die aktuell Notierung. | K | Einfach | STRING 3DEZIMAL 10,4 | Order/OrderItem/ | Rohstoffanteil/BasiseinheitBasis NotierungSumMaterialSurcharges | |||||||
skontofähiger Betrag | Angabe des skontofähiger Betrags bezogen auf die angefragte Menge inkl. aller Zuschläge und Rabatte. | K | Einfach | DEZIMAL 10,4 | Order/OrderItem/ | Rohstoffanteil/BasisnotierungAktuelle Notierung | Beinhaltet die Rohstoffnotierung, mit der der Nettopreis berechnet wurde; muss nicht der aktuellen Rohstoffnotierung entsprechen, da ggf. für Kontingente fixiert. | K | Einfach | DEZIMAL 10,4DiscountableAmount | |||
Belegreferenz | Referenz auf Belege. Pro Referenz werden die folgenden Angaben übertragen:
| K | Mehrfach | - | Order/OrderItem/ | Rohstoffanteil/NotierungAktuellKennzeichen „Diverser Artikel“ | Angabe, ob es sich bei dem Artikel um einen Diversen Artikel handelt. | KReferenz | |||||
Belegnummer | M | Einfach | BOOLEANSTRING 15 | Order/OrderItem/Referenz/ | DiversDocumentNumber | ||||||||
Summe Rohstoffzuschläge | Summe aller Rohstoffzuschläge bezogen auf die angefragte Menge und die aktuell Notierung. | K | Einfach | DEZIMAL 10,4Belegposition | M | Einfach | STRING 10 | Order/OrderItem/SumMaterialSurcharges | skontofähiger Betrag | Angabe des skontofähiger Betrags bezogen auf die angefragte Menge inkl. aller Zuschläge und Rabatte. | K | Einfach | DEZIMAL 10,4/Refrenz/LineNumber |
Belegdatum | M | Einfach | Date | Order/OrderItem/Referenz/DocumentDate | |||||||||
Belegart | M | Einfach | Codeliste Belegart | Order/OrderItem/Referenz/DiscountableAmountDocumentType | |||||||||
Schema und Beispiel Datenstruktur Warenkorb senden
...
Code | Beschreibung |
AL | Aluminium |
PB | Blei |
CR | Chrom |
AU | Gold |
CD | Kadmium |
CU | Kupfer |
MG | Magnesium |
NI | Nickel |
PL | Platin |
AG | Silber |
W | Wolfram |
ZN | Zink |
SN | Zinn |
MS | Messing |
MK | MK Kupfer |
Belegart
Code | Beschreibung |
220 | Bestellung |
231 | Bestätigung (Auftrag) |
310 | Angebot |
315 | Vertrag |
Anlagenfunktion
Code | Beschreibung |
warmwater | Warmwasser |
heating | Heizung |
combination | Kombi |
...
Dateninhalt | Beispiel |
Anfrage- / Angebotsmenge (AM) | 50 |
Anfrage- / Angebots-Mengeneinheit (AME) | „MTR“ für Meter |
Angebotspreis (AP) | 10000 |
Nettopreis (NP) | 522 |
Preisbasis (PB) | 1000 |
Rohstoff (R) | „CU“ für Kupfer |
Gewichtsanteilswert (GAW) | 96 |
Gewichtsanteilseinheit (GAE) | „KGM“ für Kilogramm |
Basiswert (BW) | 100 |
Basiseinheit (BE) | „MTR“ für Meter |
Basis Rohstoffnotierung pro 100 Kilogramm (BN) | 150 |
Aktuelle Rohstoffnotierung pro 100 Kilogramm (AN) | 300 |
Rabatt (R) | 10,00% |
Summe Rohstoffzuschläge | 72 € |
skontofähiger Betrag | 450 € |
Berechnung
Kupferzuschlag (KZ) = AM * (GAW / BW) * (AN - BN)
...