Format und Inhalt - WS-Anfragedaten (DE)
- René Meyer
- Rainer Biedermann
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:
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 |
|---|---|---|---|
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 |
|---|---|---|---|
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:
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 |
|---|---|---|---|
Name | x | Â | Technische ID des Eingabefeldes |
Descr | x |  | Spachabhängige Bezeichnung des Eingabefeldes |
Value | Â | 4000 | Wert des Eingabefeldes |
Beispiel:
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 |
|---|---|---|---|
Name | x | Â | Technische ID des Eingabefeldes |
Descr | x |  | Spachabhängige Bezeichnung des Eingabefeldes |
Value | Â | 4000 | Wert des Eingabefeldes |
Beispiel:
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 |
|---|---|---|---|
Name | x | Â | Technische ID des Eingabefeldes |
Descr | x |  | Spachabhängige Bezeichnung des Eingabefeldes |
Value | Â | 4000 | Wert des Eingabefeldes |
Beispiel:
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 |
|---|---|---|---|
UploadID | x | 64 | UploadID |
FileName | x | Â | Name der Upload-Datei |
Beispiel: