Allgemeines

Diese Dokumentation beschreibt das Format und den Inhalt von Anfragen, die vom Kunden über ein Shop-Formular abgesendet wurden.

In WEBSALE Shops wird als universelles Formularprogramm INQUIRY4 verwendet, mit dem auf einfache Art beliebige Anfrage-Formulare betrieben werden können. INQUIRY4 bearbeitet, kontrolliert und sendet die Eingaben per E-Mail an einen Formularempfänger. Zudem werden die Anfragen in einem XML-Format für ERP-Systeme bereitgestellt.

Eine ausführliche Beschreibung von INQUIRY4 finden Sie in der separaten Dokumentation:

Formulare mit INQUIRY4

Transfer der Anfragen

Die nachfolgend beschriebenen Anfragedaten werden via SOAP vom Shop abgeholt. Die Übertragung wird in der separaten Dokumentation „SOAP-from-Shop“ beschrieben:

SOAP-from-Shop (empfohlen)

Wenn auf Ihrem System kein SOAP implementiert werden kann, können Sie alternativ auch mit dem WEBSALE-OrderManager (WSOM) Anfragedaten exportieren. Siehe separate Dokumentation „WSOM-from-Shop“:

WSOM-from-Shop (Vorgängerversion - nicht mehr empfohlen)

Beschreibung der Sektionen und Parameter

Eingabefelder

Für jedes Formular können beliebige Eingabefelder abgefragt werden. Der Designer bestimmt dabei,

welche Eingabefelder abgefragt werden,
welche Eingabefelder Pflichtfelder sind und
welche Eingabefelder optional sind.

Für jedes Eingabefeld werden 3 Parameter in einer Sektion <Item>....<Item> ausgegeben.

Die Parameter lauten:

Name: Technische ID (sprachunabhängig) des Eingabefeldes
Descr: Spachabhängige Bezeichnung des Eingabefeldes
Value: Wert des Eingabefeldes

Beispiel:

<Item>
  <Name>LastName</Name>
  <Descr>Nachname</Descr>
  <Value>Müller</Value>
</Item>

Es können auch mehrzeilige Werte mit der maximalen Länge von 4000 Zeichen übergeben werden.

<Item>
  <Name>Remark</Name>
  <Descr>Wünsche und Anmerkungen</Descr>
  <Value>
    ... Zeile 1
    ... Zeile 2
    ... Zeile 3
  </Value>
</Item>

Ein Designer kann für jedes Eingabefeld die maximale Eingabelänge bestimmen, für die das ERP-System die Daten verarbeiten kann.

Außerdem kann eingestellt werden, ob leere Eingabefelder in den XML-Daten übergeben oder weggelassen werden.

Sektion: Header (Allgemeine Informationen)

Diese Sektion ist stets vorhanden.

Parameter	Muss-Feld	Max. Länge <>255 Zeichen	Bemerkung

Parameter	Muss-Feld	Max. Länge <>255 Zeichen	Bemerkung
FormatID	X	32	Kennung des Datenformats
Generator	X	32	Kennung des erzeugenden Programms
Copyright(c)	X		Copyright von WEBSALE für dieses Datenformat
Remark	X		Unveränderlicher Wert
Referer		128	Aufruf-Referenz, woher die Anfrage aufgerufen wurde
Subreferer		128	Sub-Aufruf-Referenz, woher die Anfrage aufgerufen wurde

Beispiel:

<Header>
  <FormatID>INQUIRY-4</FormatID>
  <Generator>INQUIRY-4</Generator>
  <Copyrightc>WEBSALE AG, www.websale.de</Copyrightc>
  <Remark>This File-Format is protected by international copyright laws.</Remark>
  <Remark>Use only with expressed written allowance of WEBSALE AG.</Remark>
  <Referer></Referer>
  <SubReferer></SubReferer>
</Header>

Sektion: ID (Kopfdaten einer Anfrage)

Diese Sektion ist stets vorhanden.

Parameter	Muss-Feld	Max. Länge <>255 Zeichen	Bemerkung

Parameter	Muss-Feld	Max. Länge <>255 Zeichen	Bemerkung
MallID	X		Die MallID eines Shops. Alle Produktivshops befinden sich in der Mall „websale“. Testshops befinden sich in der Mall „test“ und Partnershops in der Mall „partner“
ShopID	X		Eine eindeutige ID Ihres Shops.
INI	X		Name der Konfigurationsdatei
InquiryNumber	X	32	Eindeutige Anfragenummer. Kann zur eindeutigen Referenzierung verwendet werden. Analog einer Auftragsnummer.
Subject	X		Benennung/Name der Anfrage
Date	X	8	Datum der Anfrage im Format TT.MM.YYYY z.B. 29.01.2015
Time	X	8	Uhrzeit der Bestellung im Format HH:MM z.B. 19:02
IPAdress	X	15	IP-Adresse des Users
ExtIPAddress		15	IP-Adresse des Shops, falls Inquiry per „ExternInclude“ in den Shop integriert wurde
ExtIPAddressTime		21	Timestamp der externen IP-Adresse im Format YYYY-MM-DD / HH:MM:SS z.B. 2015-02-04 / 10:42:12
ExtSessionID		64	SessionID des Shops, falls Inquiry per „ExternInclude“ in den Shop integriert wurde

Beispiel:

<ID>
  <MallID>websale</MallID>
  <ShopID>mein_shop</ShopID>
  <SubShopID>deutsch</SubShopID>
  <INI>katalog.config</INI>
  <InquiryNumber>121373439353665</InquiryNumber>
  <Subject>Kontaktanfrage</Subject>
  <Date>2013-07-10</Date>
  <Time>08:55:00</Time>
  <IPAddress>212.204.107.127</IPAddress>
  <ExtIPAddress>217.86.230.240</ExtIPAddress>
  <ExtIPAddressTime>2013-07-10 / 08:50:43</ExtIPAddressTime>
  <ExtSessionID>eef151edbc8d681e083a362e262ab3d6</ExtSessionID>
</ID>

Sektion: CustomerAddress (Rechnungsadresse)

Diese Sektion ist vorhanden, wenn Daten der Rechnungsadresse abgefragt werden.

Für jedes Eingabefeld werden folgende Parameter übergeben:

Parameter	Muss-Feld	Max. Länge <>255 Zeichen	Bemerkung

Parameter	Muss-Feld	Max. Länge <>255 Zeichen	Bemerkung
Name	x		Technische ID des Eingabefeldes
Descr	x		Spachabhängige Bezeichnung des Eingabefeldes
Value		4000	Wert des Eingabefeldes

Beispiel:

<CustomerAddress>
  <Item>
    <Name>salutation</Name>
    <Descr>Anrede</Descr>
    <Value>Herr</Value>
  </Item>
  <Item>
    <Name>first_name</Name>
    <Descr>Vorname</Descr>
    <Value>Max</Value>
  </Item>
  <Item>
    <Name>last_name</Name>
    <Descr>Nachname</Descr>
    <Value>Muster</Value>
  </Item>
  <Item>
    <Name>street</Name>
    <Descr>Straße</Descr>
    <Value>Teststr. 5</Value>
  </Item>
  <Item>
    <Name>zip</Name>
    <Descr>PLZ</Descr>
    <Value>12345</Value>
  </Item>
  <Item>
    <Name>city</Name>
    <Descr>Ort</Descr>
    <Value>Testort</Value>
  </Item>
  <Item>
    <Name>country</Name>
    <Descr>Land</Descr>
    <Value>DEU</Value>
  </Item>
  <Item>
    <Name>email</Name>
    <Descr>E-Mail</Descr>
    <Value>max@websale.de</Value>
  </Item>
</CustomerAddress>

Sektion: DeliveryAddress (Lieferadresse)

Diese Sektion ist vorhanden, wenn Daten der Lieferadresse abgefragt werden.

Für jedes Eingabefeld werden folgende Parameter übergeben:

Parameter	Muss-Feld	Max. Länge <>255 Zeichen	Bemerkung

Parameter	Muss-Feld	Max. Länge <>255 Zeichen	Bemerkung
Name	x		Technische ID des Eingabefeldes
Descr	x		Spachabhängige Bezeichnung des Eingabefeldes
Value		4000	Wert des Eingabefeldes

Beispiel:

<DeliveryAddress>
  <Item>
    <Name>salutation</Name>
    <Descr>Anrede</Descr>
    <Value>Herr</Value>
  </Item>
  <Item>
    <Name>first_name</Name>
    <Descr>Vorname</Descr>
    <Value>Max</Value>
  </Item>
  <Item>
    <Name>last_name</Name>
    <Descr>Nachname</Descr>
    <Value>Muster</Value>
  </Item>
  <Item>
    <Name>street</Name>
    <Descr>Straße</Descr>
    <Value>Teststr. 7</Value>
  </Item>
  <Item>
    <Name>zip</Name>
    <Descr>PLZ</Descr>
    <Value>12345</Value>
  </Item>
  <Item>
    <Name>city</Name>
    <Descr>Ort</Descr>
    <Value>Testort</Value>
  </Item>
  <Item>
    <Name>country</Name>
    <Descr>Land</Descr>
    <Value>DEU</Value>
  </Item>
</DeliveryAddress>

Sektion: Inquiry (Anfrage)

Diese Sektion ist vorhanden, wenn mindestens eine Anfrage eingegeben wurde.

Für jedes Eingabefeld werden folgende Parameter übergeben:

Parameter	Muss-Feld	Max. Länge <>255 Zeichen	Bemerkung

Parameter	Muss-Feld	Max. Länge <>255 Zeichen	Bemerkung
Name	x		Technische ID des Eingabefeldes
Descr	x		Spachabhängige Bezeichnung des Eingabefeldes
Value		4000	Wert des Eingabefeldes

Beispiel:

<Inquiry>
  <Item>
    <Name>request</Name>
    <Descr>Wünsche und Anregungen</Descr>
    <Value>
      Zeile 1
      Zeile 2
      Zeile 3
      Zeile 4
      Zeile 5
    </Value>
  </Item>
</Inquiry>

Sektion: InquiryUpload (Datei-Upload)

Zu einer Anfrage kann der User ein oder mehrere Dateien zum Shopserver hochladen. Das ERP-System kann per SFTP auf die Upload-Dateien zugreifen. Zu jedem Upload wird eine eindeutige UploadID generiert, was einem Unterverzeichnis des SFTP-Accounts entspricht.

Beispiel:

Es werden 3 Dateien hochgeladen:

Datei1.jpg
Datei2.jpg
Datei3.jpg

Die UploadID sei „11AABBCC“

Verzeichnis-Struktur:

SFTP-Root
- 11AABBCC (UploadID)
  - Datei1.jpg
  - Datei2.jpg
  - Datei3.jpg

Parameter	Muss-Feld	Max. Länge <>255 Zeichen	Bemerkung

Parameter	Muss-Feld	Max. Länge <>255 Zeichen	Bemerkung
UploadID	x	64	UploadID
FileName	x		Name der Upload-Datei

Beispiel:

<InquiryUpload>
  <UploadID>11AABBCC</UploadID>
  <Item>
    <Filename>Datei1.jpg</Filename>
  </Item>
  <Item>
    <Filename>Datei2.jpg</Filename>
  </Item>
  <Item>
    <Filename>Datei3.jpg</Filename>
  </Item>
</InquiryUpload>

Gutenstetter Str. 2, 90449 Nürnberg, +49 (0)911-63 221-0, kontakt@websale.de, www.websale.de

Haftungsausschluss

^{Alle Inhalte werden von der WEBSALE AG ausschließlich zu allgemeinen Informationszwecken veröffentlicht. Für die Richtigkeit, Vollständigkeit und Aktualität der Inhalte können wir jedoch keine Gewähr übernehmen.}

Disclaimer

^{All content is published by WEBSALE AG for general information purposes only. However, we cannot guarantee the correctness, completeness and actuality of the contents.}

Format und Inhalt - WS-Anfragedaten (DE)

Allgemeines

Transfer der Anfragen

Beschreibung der Sektionen und Parameter

Eingabefelder

Sektion: Header (Allgemeine Informationen)

Sektion: ID (Kopfdaten einer Anfrage)

Sektion: CustomerAddress (Rechnungsadresse)

Sektion: DeliveryAddress (Lieferadresse)

Sektion: Inquiry (Anfrage)

Sektion: InquiryUpload (Datei-Upload)