...
Ä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 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.
...
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.
...
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.
...
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/Address/Street3 | |
Lieferantenadresse / PLZ | K | Einfach | STRING 9 | Order/SupplierInfo/Address/PCode | |
Lieferantenadresse / Ort | K | Einfach | STRING 40 | Order/SupplierInfo/Address/City | |
Lieferantenadresse / Land | K | Einfach | STRING 40 | Order/SupplierInfo/Address/Country | |
Lieferantenadresse / ILN | K | Einfach | STRING 20 | Order/SupplierInfo/Address/ILN | |
Lieferantenadresse / Ansprechpartner | K | Einfach | STRING 40 | Order/SupplierInfo/Address/Contact | |
Lieferantenadresse / Telefonnummer | K | Einfach | STRING 20 | Order/SupplierInfo/Address/Phone | |
Lieferantenadresse / Faxnummer | K | Einfach | STRING 20 | Order/SupplierInfo/Address/Fax | |
Lieferantenadresse / Email-Adresse | K | Einfach | STRING 256 | Order/SupplierInfo/Address/Email | |
Kundendaten | Struktur zur Abbildung der Kundendaten | K | Einfach | - | Order/CustomerInfo |
Kundennummer | Kundennummer des Handwerkers beim Lieferanten | K | Einfach | STRING 40 | Order/CustomerInfo/IDNo |
Kundenadresse | Struktur zur Abbildung der Kundenadresse | K | Einfach | - | Order/CustomerInfo/Address |
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 40 | Order/CustomerInfo/Address/Name1 |
Kundenadresse / Name2 | K | Einfach | STRING 40 | Order/CustomerInfo/Address/Name2 | |
Kundenadresse / Name3 | K | Einfach | STRING 40 | Order/CustomerInfo/Address/Name3 | |
|
|
|
|
| |
Kundenadresse / Straße1 | K | Einfach | STRING 40 | Order/CustomerInfo/Address/Street1 | |
Kundenadresse / Straße2 | K | Einfach | STRING 40 | Order/CustomerInfo/Address/Street2 | |
Kundenadresse / Straße3 | K | Einfach | STRING 40 | Order/CustomerInfo/Address/Street3 | |
Kundenadresse / PLZ | K | Einfach | STRING 9 | Order/CustomerInfo/Address/PCode | |
Kundenadresse / Ort | K | Einfach | STRING 40 | Order/CustomerInfo/Address/City | |
Kundenadresse / Land | K | Einfach | STRING 40 | Order/CustomerInfo/Address/Country | |
Kundenadresse / ILN | K | Einfach | STRING 20 | Order/CustomerInfo/Address/ILN | |
Kundenadresse / Ansprechpartner | K | Einfach | STRING 40 | Order/CustomerInfo/Address/Contact | |
Kundenadresse / Telefonnummer | K | Einfach | STRING 20 | Order/CustomerInfo/Address/Phone | |
Kundenadresse / 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 | - | Order/DeliveryPlaceInfo/Address |
Lieferadresse / 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 / Name3 | K | Einfach | STRING 40 | Order/DeliveryPlaceInfo/Address/Name3 | |
|
|
|
|
| |
Lieferadresse / Straße1 | K | Einfach | STRING 40 | Order/DeliveryPlaceInfo/Address/Street1 | |
Lieferadresse / Straße2 | K | Einfach | STRING 40 | Order/DeliveryPlaceInfo/Address/Street2 | |
Lieferadresse / Straße3 | K | Einfach | STRING 40 | Order/DeliveryPlaceInfo/Address/Street3 | |
Lieferadresse / PLZ | K | Einfach | STRING 9 | Order/DeliveryPlaceInfo/Address/PCode | |
Lieferadresse / Ort | K | Einfach | STRING 40 | Order/DeliveryPlaceInfo/Address/City | |
Lieferadresse / Land | K | 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 3,8 | Order/DeliveryPlaceInfo/Address/GeoLong |
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 |
14,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 | Einfach | DEZIMAL 10,4 | Order/OrderItem/Rohstoffanteil/Basisnotierung | |
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/NotierungAktuell |
Kennzeichen „Diverser Artikel“ | Angabe, 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 | DEZIMAL 10,4 | 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 | Order/OrderItem/DiscountableAmount |
Belegreferenz | Referenz auf Belege. Pro Referenz werden die folgenden Angaben übertragen:
| K | Mehrfach | - | Order/OrderItem/Referenz |
Belegnummer | M | Einfach | STRING 15 | Order/OrderItem/Referenz/DocumentNumber | |
Belegposition | M | Einfach | STRING 10 | Order/OrderItem/Refrenz/LineNumber | |
Belegdatum | M | Einfach | Date | Order/OrderItem/Referenz/DocumentDate | |
Belegart | M | Einfach | Codeliste Belegart | Order/OrderItem/Referenz/DocumentType |
Schema und Beispiel Datenstruktur Warenkorb senden
...
Dateninhalte Heatinglabel
Dateninhalt | Beschreibung | Muss / Kann | Einfach / Mehrfach | Format | Referenz XML |
Kopfebene | |||||
Anlagenfunktion | Funktion der Anlage „Heizung“, „Warmwasser“ oder „Kombi“ | K | Einfach | Codeliste Anlagenfunktion | Header/PackageFunction |
Anlagentyp | Typ der Anlagen | K | Einfach | Codeliste AnlagenTyp | Header/PackageType |
Lastprofil | Lastprofil für die Verbundanlage | K | Einfach | Codeliste Lastprofil | Header/LoadProfile |
Einbausituation | Angabe, ob der Speicher innen oder außen verbaut wird. | K | Einfach | Codeliste Einbausituation | Header/ModeOfUse |
Lieferant Verbundanlage | Angabe durch wen die Zusammenstellung der Verbundanlage erfolgt. Die Angabe wird bei er Generierung des Labels der Verbundanlage verwendet. Hinweis: Für die Übertragung zur Handwerkssoftware Muss, für die Übertragung zur Plattform Kann. | M / K | Einfach | String 35 | Header/PackageSupplier |
Solarverwendung | Angabe ob eine Solareinrichtung innerhalb einer Kombi Anlage für Heizung, Warmwasser oder für beides genutzt wird und in die Berechnung mit einbezogen wird / wurde. | K | Einfach | Codeliste Solarverwendung | Header/SolarDeviceUsage |
Struktur zur Übertragung der PDF Dateien Hinweis: Für die Übertragung zur Handwerkssoftware Muss, für die Übertragung zur Plattform Kann. | M / K | Mehrfach | Struktur | Header/PDF | |
PDF-Dateiname | Dateiname der PDF Datei | M | Einfach | String | Header/PDF/PDFName |
PDF-Datei | Datei | M | Einfach | Binary base64 | Header/PDF/PDFData |
PDF-Typ | Angabe um welches PDF Dokument es sich handelt. | M | Einfach | Codeliste PDFtyp | Header/PDF/PDFType |
Position (maximal 100 Positionen) | |||||
LieferantenID | Identifikation des Lieferanten in der Plattform Hinweis: Für die Übertragung zur Handwerkssoftware Muss, für die Übertragung zur Plattform kann. Zur Identifikation kann alternativ die Kombination LieferantenID und Produktnummer oder die GTIN genutzt werden. | M / K | Einfach | String 80 | Position/SupplierID |
Produktnummer | Identifikation des Produkts in der Plattform Hinweis: Für die Übertragung zur Handwerkssoftware Muss, für die Übertragung zur Plattform kann. Zur Identifikation kannalternativ die Kombination LieferantenID und Produktnummer oder die GTIN genutzt werden. | M / K | Einfach | String 80 | Position/Productnumber |
GTIN | Identifikation des Produkts in der Plattform Hinweis: Für die Übertragung zur Plattform kann. Zur Identifikation kann alternativ die Kombination LieferantenID und Produktnummer oder die GTIN genutzt werden. | K | Einfach | String 13 | Position/GTIN |
Baujahr von | Angabe ab wann ein Produkt hergestellt wurde. | K | Einfach | Datum | Position/ConstructionFrom |
Baujahr bis | Angabe bis wann ein Produkt hergestellt wurde. | K | Einfach | Datum | Position/ConstructionTo |
Kurztext | Beschreibung des Produkts Hinweis: Bei der Übertragung zur Handwerkssoftware wird der Kurztext für alle verwendeten Positionen übertragen. | K | Einfach | String 81 | Position/Shorttext |
Menge | Angabe der Menge in der das Produkt in der Verbundanlage verwendet wird. Bei der Verwendung von Kollektoren ist eine Angabe größer 1 möglich. Für alle anderen Produkttypen ist nur die Menge „1“ möglich. Hinweis: Bei der Übertragung zur Handwerkssoftware wird die Menge für alle verwendeten Positionen übertragen. | K | Einfach | Integer | Position/QTY |
Referenzenangaben | Struktur für die Positionsnummer des Handwerkers und des Großhändlers | K | Einfach | - | Position/RefItems |
Positionsnummer des anfragenden Systems | Wird bei der Verarbeitung in der Plattform nicht verändert oder gelöscht. | K | Einfach | STRING 35 | Position/RefItems/Customer |
Unterpositionsnummer des anfragenden Systems | Wird bei der Verarbeitung in der Plattform nicht verändert oder gelöscht. | K | Einfach | STRING 35 | Position/RefItems/CustomerSubNo |
Positionsnummer der Plattform | Wird bei der Verarbeitung in der Plattform nicht verändert oder gelöscht. | K | Einfach | STRING 35 | Position/RefItems/Supplier |
Unterpositionsnummer der Plattform | Wird bei der Verarbeitung in der Plattform nicht verändert oder gelöscht. | K | Einfach | STRING 35 | Position/RefItems/SupplierSubNo |
Produkttyp | Produkttyp der Position aus dem Datenpool Hinweis: Bei der Übertragung zur Handwerkssoftware wird der Produkttyp für alle verwendeten Positionen übertragen. Für die Übertragung zur Plattform ist das Element nicht möglich. | K / - | Einfach | Codeliste Produkttyp | Position/Producttype |
Status der Position | Angabe ob die Position nach dem Upload geändert wurde Hinweis: Für die Übertragung zur Handwerkssoftware Muss, für die Übertragung zur Plattform nicht möglich. | M / - | Einfach | Codeliste Status | Position/Status |
Schema Heatinglabel
View file | ||
---|---|---|
|
View file | ||
---|---|---|
|
Anhang
Codelisten
Aktioncodes
Code | Beschreibung |
WKE | Warenkorb Empfangen (Handwerkssoftware vom GH_Shop) |
WKS | Warenkorb Senden (Handwerkssoftware zum GH_Shop) |
ADL | Artikeldeeplink |
HLS | Artikelliste Heatinglabel Senden |
Mengeneinheiten
Code | Beschreibung |
CMQ | Kubik-Zentimeter |
CMK | Quadrat-Zentimeter |
CMT | Zentimeter |
DZN | Dutzend |
GRM | Gramm |
HLT | Hekto-Liter |
KGM | Kilogramm |
KTM | Kilometer |
LTR | Liter |
MMT | Millimeter |
MTK | Quadrat-Meter |
MTQ | Kubik-Meter |
MTR | Meter |
PCE | Stück |
PR | Paar |
SET | Satz |
TNE | Tonne |
Fehlercodes
Zusätzlich zu dem angegebenen Code könne weitere Fehlercodes frei genutzt werden.
Code | Beschreibung |
1 | Allgemeiner Fehler |
Rohstoffe
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 |
Anlagentyp
Code | Beschreibung |
heating-boiler | Heizung-Heizkessel |
heating-cogeneration | Heizung-Kraft-Wärme-Kopplung |
heating-heatpump | Heizung-Wärmepumpe |
heating-lowtemp-heatpump | Heizung-Niedertemperatur-Wärmepumpe |
combination-boiler | Kombi-Heizkessel |
combination-heatpump | Kombi-Wärmepumpe |
warmwater-conventional | Warmwasser-Konventionelle |
warmwater-heatpump | Warmwasser-Wärmepumpe |
Lastprofil
Code | Beschreibung |
M | M |
L | L |
XL | XL |
XXL | XXL |
Einbausituation
Code | Beschreibung |
Indoor | Innen |
Outdoor | Außen |
Produkttyp
Code | Beschreibung |
RHG-HK | Raumheizgeräte mit Heizkessel |
RHG-KWK | Raumheizgeräte mit Kraft-Wärme-Kopplung |
RHG-WP | Raumheizgeräte mit Wärmepumpe |
N-WP | Niedertemperatur-Wärmepumpen |
KHG-HK | Kombiheizgeräte mit Heizkessel |
KHG-WP | Kombiheizgeräte mit Wärmepumpe |
K-WWB | Konventionelle Warmwasserbereiter |
S-WWB | Solarbetriebene Warmwasserbereiter |
WWB-WP | Warmwasserbereiter mit Wärmepumpe |
WWS | Warmwasserspeicher |
TR | Temperaturregler |
SR | Solarregler |
TSR | Temperaturregler und Solarregler |
SE | Solareinrichtung |
KO | Kollektor |
PSO | Pumpe Solar |
SOLG | Solargruppe |
VBA-RHG-TR-S | Verbundanlage Raumheizgeräte Temperaturregelung und Solareinrichtung |
VBA-KHG-TR-S | Verbundanlage Kombiheizgerät Temperaturregelung und Solareinrichtung |
VBA-WWB-S | Verbundanlage Warmwasserbereiter mit Solareinrichtung |
Status
Code | Beschreibung |
NotUsed | Position nicht verwendet |
NotFound | Position nicht im Datenpool vorhanden |
Used | Position in der Verbundanlage verwendet |
New | Position wird verwendet und wurde über die Web-Oberfläche hinzugefügt. |
PDFtyp
Code | Beschreibung |
PackageLabelAndFiche | Datenblatt und ErP-Label der Verbundanlage |
Articlelist | Liste der in der Verbundanlage verwendeten Artikel |
PrimaryProductLabel | ErP-Label des Primärgeräts der Verbundanlage |
Solarverwendung
Code | Beschreibung |
both | Solaranlage wird für Warmwasser und Heizung verwendet |
water | Solaranlage wird für Warmwasser verwendet |
heating | Solaranlage wird für Heizung verwendet |
Beispiel Rohstoffangaben
50 Meter Ring Kabel.
Preis 10.000,00 € pro 1.000 Meter.
Kupfergewicht beträgt 96 Kilogramm pro 100 Meter.
Der Preis ist mit einem Kupferpreis von 150 € pro 100 Kilogramm kalkuliert.
Der aktuelle Kupferpreis beträgt 300 € pro 100 Kilogramm.
Der Rabatt entspricht 10%
Übertragene Daten:
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)
...