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

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

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“

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

K

Einfach

STRING 40

Order/SupplierInfo/IDNo

Lieferantenadresse

Struktur zur Abbildung der Lieferantenadresse

K

Einfach

-

Order/SupplierInfo/Address/

Lieferantenadresse / Name1

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 / Name4

K

Einfach

STRING 40

Order/SupplierInfo/Address/Name4

Lieferantenadresse / Straße

K

Einfach

STRING 40

Order/SupplierInfo/Address/Street

Lieferantenadresse / PLZ

K

Einfach

STRING 20

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

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 / Name4

K

Einfach

STRING 40

Order/CustomerInfo/Address/Name4

Kundenadresse / Straße

K

Einfach

STRING 40

Order/CustomerInfo/Address/Street

Kundenadresse / PLZ

K

Einfach

STRING 20

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

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 / Name4

K

Einfach

STRING 40

Order/DeliveryPlaceInfo/Address/Name4

Lieferadresse / Straße

K

Einfach

STRING 40

Order/DeliveryPlaceInfo/Address/Street

Lieferadresse / PLZ

K

Einfach

STRING 20

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 / 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 DEL-Notierung

K

Einfach

DEZIMAL 10,4

Order/OrderItem/Rohstoffanteil/Basisnotierung

Aktuelle DEL-Notierung

Beinhaltet die DEL-Notierung, mit der der Nettopreis berechnet wurde; muss nicht der aktuellen DEL-Notierung 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

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

PDF

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