SOAP-from-Shop (DE)

Allgemeines

Diese Dokumentation beschreibt den SOAP-basierten Abruf von

  • Bestellungen

  • Anfragen (INQUIRY4)

  • Adressdatenänderungen

  • Gutscheindaten

vom WEBSALE-Shopsystem.

Ausschließlich verschlüsselter Abruf

Der Webservice muss über SSL aufgerufen werden. Unverschlüsselte Verbindungen werden abgelehnt.

UTF-8 Codierung

Alle Daten werden im UTF-8 Format übergeben.

Abruf von Bestellungen

Der Abruf von Bestellungen erfolgt in zwei Schritten:

  1. Senden des Request durch das externe System

  2. Übergabe der angeforderten Daten vom WEBSALE-System

Voraussetzung

Das externe System muss

  • bei jedem Aufruf die ShopID und das Passwort übergeben

  • die zuletzt empfangene Bestellnummer speichern.

Senden des Request durch das externe System (Schritt 1, „GetOrders“)

Erster Abruf

Beim ersten Abruf von Bestellungen liegt dem abholenden externen System noch keine letzte Bestellnummer vor. In diesem Fall erfolgt der Request mit Datum+Uhrzeit, ab dem die im Shopsystem gespeicherten Bestellungen übermittelt werden sollen. Der Parameter „SkipFirstMatch“ wird auf „false“ gesetzt.

Laufender Betrieb

Bei dieser Anfrage übergibt das externe System die zuletzt gespeicherte (zuletzt empfangene) Bestellnummer, bei der die Übertragung beginnen soll. Optional kann auch die maximal gewünschte Anzahl Bestellungen angeben werden.

Liegen im WEBSALE-System mehr Bestellungen vor, als vom externen System angefordert wurden, so muss das externe System das GetOrders-Verfahren wiederholen, bis alle vorliegenden Bestellungen übertragen wurden. Das externe System speichert die zuletzt empfangene Bestellnummer und führt den nächsten Request mit dieser durch. Der Parameter „SkipFirstMatch“ wird dabei auf „true“ gesetzt.

Einzelne Bestellung abrufen

Hierzu wird die Bestellnummer und die maximale Zahl der zu sendenden Bestellungen mit „1“ übergeben. Der Parameter „SkipFirstMatch“ wird auf „false“ gesetzt.

Hinweis

Enthält ein Request sowohl eine Bestellnummer als auch Datum+Uhrzeit, so wird die Bestellnummer verwendet und Datum+Uhrzeit werden ignoriert.

Tabelle der Parameter

Parameter

Beschreibung

Pflichtfeld

Parameter

Beschreibung

Pflichtfeld

ShopID

Die Shop-ID

ja

Password

Das Passwort für die SOAP-Schnittstelle. Das Passwort erhalten Sie von der WEBSALE AG.

ja

SubshopIDs

Eine kommagetrennte Liste mit SubshopIDs, für die die Bestellungen abgerufen werden sollen. Ist die Liste leer oder fehlt der Parameter komplett, so werden die Aufträge aller Subshops gesendet.

Server-seitig können die SubshopIDs ebenfalls eingeschränkt sein. In diesem Fall bricht die Übertragung mit einem Fehler ab, wenn in der SubshopID-Liste Subshops angegeben werden, die nicht freigeschaltet sind.

nein

Date

Datum im Format YYYY-MM-DD, bei dem die Übertragung beginnen soll.

ja, wenn OrderNumber fehlt

Time

Uhrzeit im Format HH:MM:SS, bei dem die Übertragung beginnen soll.

nein

MaxOrderCount

Die maximale Anzahl von Bestellungen, die gesendet werden sollen (Default-Wert: 100, Maximum: 1000).

nein

MsgID

Optional kann das externe System eine MsgID mitgeben, die vom WEBSALE-System in der Antwort zurückgegeben wird. Für die Verarbeitung des Requests hat die MsgID keine Bedeutung.

nein

OrderNumber

Bestellnummer, bei der die Übertragung beginnen soll.

ja, wenn Date/Time fehlt

SkipFirstMatch

„true“: Die Übertragung beginnt mit der darauf folgenden Bestellung.

„false“: Die Übertragung beginnt ab der übergebenen Bestellnummer bzw. Datum+Uhrzeit

ja

Beispiele GetOrders-Requests:

a) Max. 100 Bestellungen abrufen, die seit dem 11.05.2013 um 11:00 eingegangen sind:

<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:ns="http://www.websale.de/"> <SOAP-ENV:Body> <ns:GetOrders> <request> <ShopID>testshop</ShopID> <Password>123456</Password> <Date>2013-05-11</Date> <Time>11:00:00</Time> <SkipFirstMatch>false</SkipFirstMatch> </request> </ns:GetOrders> </SOAP-ENV:Body> </SOAP-ENV:Envelope>

b) Max. 10 Bestellungen abrufen, die nach der Bestellung mit der OrderNumber „3744567“ eingegangen sind:

<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:ns="http://www.websale.de/"> <SOAP-ENV:Body> <ns:GetOrders> <request> <ShopID>testshop</ShopID> <Password>123456</Password> <OrderNumber>3744567</OrderNumber> <MaxOrderCount>10</MaxOrderCount> <SkipFirstMatch>true</SkipFirstMatch> </request> </ns:GetOrders> </SOAP-ENV:Body> </SOAP-ENV:Envelope>

Senden der Bestellungen durch WEBSALE (Schritt 2, „GetOrdersResponse“)

Tabelle der Parameter

Parameter

Beschreibung

Pflichtfeld

Parameter

Beschreibung

Pflichtfeld

OrderData

Die eigentlichen Daten der Bestellung im XML-Format. Das Format und der Inhalt der Bestelldaten ist in der separaten Dokumentation „Bestelldaten“ beschrieben:

WS-Bestelldaten

ja, innerhalb von „Order“

Date

Datum der Bestellungen im Format YYYY-MM-DD

ja, innerhalb von „Order“

Time

Uhrzeit der Bestellung im Format HH:MM:SS

ja, innerhalb von „Order“

Finished

„true“: Alle vorliegenden Bestellungen wurden gesendet.
„false“: Es liegen noch Bestellungen vor. In diesem Fall muss ein erneuter Request erfolgen.

ja

OrderNumber

Bestellnummer

ja, innerhalb von „Order“

MsgID

Die vom externen System im Request übergebene MsgID

nein

Order

Enthält die Unterelemente „Date“, „Time“, „OrderNumber“ und „OrderData“

nein

OrderCount

Die Anzahl der gesendeten Bestellungen

ja

Orders

Enthält für jede der gesendeten Bestellungen ein „Order“-Unterelement

ja

SubshopIDs

Wenn in dem Request das SubshopIDs-Feld gefüllt war oder in der Shop-Konfiguration das Abholen von Bestelldaten auf bestimmte Subshops eingeschränkt ist, dann wird hier eine kommagetrennte Liste der SubshopIDs zurückgegeben, für die Bestelldaten abgerufen werden können.

nein

Beispiel für eine Antwort auf einen GetOrders-Request:

<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:ns="http://www.websale.de/"> <SOAP-ENV:Body> <ns:GetOrdersResponse> <response> <Finished>true</Finished> <MsgID></MsgID> <OrderCount>2</OrderCount> <Orders> <Order> <OrderNumber>132499966231815</OrderNumber> <Date>2013-05-10</Date> <Time>16:27:42</Time> <OrderData> &lt;xmlorderv2&gt;&#xD;&#xA;&#xD;&#xA; &lt;Header&gt;&#xD;&#xA; &lt;FormatID&gt;WEBSALE-8&lt;/FormatID&gt;&#xD;&#xA; &lt;VersionNumber&gt;8&lt;/VersionNumber&gt;&#xD;&#xA; &lt;Generator&gt;WEBSALE 8&lt;/Generator&gt;&#xD;&#xA; &lt;Copyright&gt;&lt;ProductDiscount&gt;0.00&lt;/ProductDiscount&gt;&#xD;&#xA; ... &lt;Total&gt;20.00&lt;/Total&gt;&#xD;&#xA; &lt;Total_DValue&gt;20,00 EUR&lt;/Total_DValue&gt;&#xD;&#xA; &lt;Total_DName&gt;Summe&lt;/Total_DName&gt;&#xD;&#xA; &lt;/Item&gt;&#xD;&#xA;&lt;/OrderList&gt;&#xD;&#xA;&#xD;&#xA; &lt;/xmlorderv2&gt;&#xD;&#xA; </OrderData> </Order> <Order> ... </Order> </Orders> </response> </ns:GetOrdersResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>

Format und Inhalt der Bestelldaten

Das Format und der Inhalt wird in der separaten Dokumentation „Bestelldaten“ beschrieben:

WS-Bestelldaten

Abruf von Anfragen (Inquiries)

Analog zum Abruf von Bestellungen erfolgt der Abruf von Anfragen in zwei Schritten:

  1. Senden des Request durch das externe System

  2. Senden der angeforderten Daten durch das WEBSALE-System

Voraussetzung

Das externe System muss

  • bei jedem Aufruf die ShopID und das Passwort übergeben

  • die zuletzt empfangene Anfragenummer sowie das zuletzt empfangene Datum+Uhrzeit der Anfrage speichern

Senden des Request durch das externe System (Schritt 1, „GetInquiries“)

Erster Abruf

Beim ersten Abruf von Anfragen liegt dem externen System noch keine letzte Anfragenummer vor. In diesem Fall erfolgt der Request nur mit Datum+Uhrzeit, ab dem die Anfragen übermittelt werden sollen. Der Parameter „SkipFirstMatch“ wird auf „false“ gesetzt. Der nächste Request erfolgt dann mit den zuletzt gespeicherten Daten von Anfragenummer, Datum+Uhrzeit.

Laufender Betrieb

Bei dieser Anfrage übergibt das externe System die gespeicherte (zuletzt empfangene) Anfragenummer und das gespeicherte (zuletzt empfangene) Datum+Uhrzeit der Anfrage, ab der die Übertragung beginnen soll und optional, wie viele Anfragen maximal gesendet werden sollen.
Liegen im WEBSALE-System mehr Anfragen vor, als vom externen System angefordert wurden, so muss das externe System das Verfahren wiederholen, bis alle vorliegenden Anfragen übertragen wurden. Der Parameter „SkipFirstMatch“ wird auf „true“ gesetzt. Das externe System speichert die zuletzt empfangene Anfragenummer und das zuletzt empfangene Datum+Uhrzeit und führt den nächsten Request mit den gespeicherten Daten durch.

Einzelne Anfrage abrufen

Hierzu wird die Anfragenummer, Datum+Uhrzeit und die maximale Zahl der zu sendenden Anfragen mit „1“ übergeben. Der Parameter „SkipFirstMatch“ wird auf „false“ gesetzt.

Tabelle der Parameter

Parameter

Beschreibung

Pflichtfeld

Parameter

Beschreibung

Pflichtfeld

ShopID

Die Shop-ID

ja

Password

Das Passwort für die SOAP-Schnittstelle. Das Passwort erhalten Sie von der WEBSALE AG.

ja

Date

Datum im Format YYYY-MM-DD, bei dem die Übertragung beginnen soll.

ja

Time

Uhrzeit im Format HH:MM:SS, bei dem die Übertragung beginnen soll.

nein

InquiryNumber

Anfragenummer

nein

MaxInquiryCount

Die maximale Zahl von Anfragen die gesendet werden soll (Default-Wert: 100, Maximum: 1000).

nein

MsgID

Optional kann das externe System eine MsgID mitgeben, die vom WEBSALE-System in der Antwort zurückgeliefert wird. Für die Verarbeitung des Requests hat die MsgID keine Bedeutung.

nein

SkipFirstMatch

„true“: Die Übertragung beginnt mit der darauf folgenden Anfrage.
„false“: Die Übertragung beginnt ab der übergebenen Anfragenummer inkl. Datum+Uhrzeit

ja

Beispiel für einen GetInquiries-Request:

Senden der Anfragen durch WEBSALE (Schritt 2, „GetInquiriesResponse“)

Tabelle der Parameter

Parameter

Beschreibung

Pflichtfeld

Parameter

Beschreibung

Pflichtfeld

InquiryData

Die eigentlichen Daten der Anfrage im XML-Format. Das Format und der Inhalt der Anfragedaten ist in der separaten Dokumentation WS-Anfragedaten beschrieben.

ja, innerhalb von „Inquiry“

Date

Datum des Inquirys im Format YYYY-MM-DD

ja, innerhalb von „Inquiry“

Time

Uhrzeit des Inquirys im Format HH:MM:SS

ja, innerhalb von „Inquiry“

Finished

„true“: Alle vorliegenden Anfragen wurden gesendet.
„false“: Es liegen noch Anfragen vor. In diesem Fall muss ein erneuter Request erfolgen.

ja

InquiryNumber

Die InquiryNumber

ja, innerhalb von „Inquiry“

MsgID

Die vom externen System im Request übergebene MsgID

nein

Inquiry

Enthält die Unterelemente „Date“, „Time“, „InquiryNumber“ und „InquiryData“

nein

InquiryCount

Die Anzahl der geschickten Inquirys

ja

Inquiries

Enthält für jedes der geschickten Inquirys ein „Inquiry“-Unterelement

ja

Beispiel für eine Antwort auf einen GetInquiries-Request:

Format und Inhalt der Anfragedaten

Das Format und der Inhalt wird in der separaten Dokumentation „Anfragen (INQUIRY4)“ beschrieben:

WS-Anfragedaten

Abruf von Adressänderungen

Wenn ein Kunde im Shop bestellt, dann werden seine Adressdaten zusammen mit den anderen Bestelldaten übermittelt. Daher ist ein expliziter Abruf von Adressänderungen nicht unbedingt erforderlich.
Beim Abruf von Adressänderungen werden Änderungen an Adressen übermittelt, die Kunden vorgenommen, aber keine Bestellung ausgeführt haben.

Analog zum Abruf von Bestellungen erfolgt der Abruf von Adressänderungen in zwei Schritten:

  1. Senden des Request durch das externe System

  2. Senden der angeforderten Daten durch das WEBSALE-System

Voraussetzung

Das externe System muss

  • bei jedem Aufruf die ShopID und das Passwort übergeben

  • die Adressnummer sowie das zuletzt empfangene Datum+Uhrzeit der Adressänderung speichern

Senden des Request durch das externe System (Schritt 1, „GetAddresses“)

Erster Abruf

Beim ersten Abruf von Adressänderungen liegt dem externen System noch keine letzte Adressnummer vor. In diesem Fall erfolgt der Request nur mit Datum+Uhrzeit, ab dem die Adressänderungen übermittelt werden sollen. Der Parameter „SkipFirstMatch“ wird auf „false“ gesetzt. Der nächste Request erfolgt dann mit den zuletzt gespeicherten Daten von Adressnummer, Datum+Uhrzeit.

Laufender Betrieb

Bei dieser Anfrage übergibt das externe System die gespeicherte (zuletzt empfangene) Adressnummer und das gespeicherte (zuletzt empfangene) Datum+Uhrzeit der Adressänderung, ab der die Übertragung beginnen soll und optional, wie viele Adressänderungen maximal gesendet werden sollen.
Liegen im WEBSALE-System mehr Adressänderungen vor, als vom externen System angefordert wurden, so muss das externe System das Verfahren wiederholen, bis alle vorliegenden Adressänderungen übertragen wurden. Der Parameter „SkipFirstMatch“ wird auf „true“ gesetzt. Das externe System speichert die zuletzt empfangene Adressnummer und das zuletzt empfangene Datum+Uhrzeit und führt den nächsten Request mit den gespeicherten Daten durch.

Einzelne Adressänderung abrufen

Hierzu wird die Adressnummer, Datum+Uhrzeit und die maximale Zahl der zu sendenden Adressänderungen mit „1“ übergeben. Der Parameter „SkipFirstMatch“ wird auf „false“ gesetzt.

Tabelle der Parameter

Parameter

Beschreibung

Pflichtfeld

Parameter

Beschreibung

Pflichtfeld

ShopID

Die Shop-ID

ja

Password

Das Passwort für die SOAP-Schnittstelle. Das Passwort erhalten Sie von der WEBSALE AG.

ja

Date

Datum im Format YYYY-MM-DD, bei dem die Übertragung beginnen soll.

ja

Time

Uhrzeit im Format HH:MM:SS, bei dem die Übertragung beginnen soll.

nein

AddressNumber

Adressnummer

nein

MaxAddressCount

Die maximale Zahl von Adressänderungen die gesendet werden sollen (Default-Wert: 100, Maximum: 1000).

nein

MsgID

Optional kann das externe System eine MsgID mitgeben, die vom WEBSALE-System in der Antwort zurückgegeben wird. Für die Verarbeitung des Requests hat die MsgID keine Bedeutung.

nein

SkipFirstMatch

„true“: Die Übertragung beginnt mit der darauf folgenden Adressänderung.

„false“: Die Übertragung beginnt ab der übergebenen Adressnummer inkl. Datum+Uhrzeit

ja

Beispiel für einen GetAddresses-Request:

Senden der Adressänderungen durch WEBSALE (Schritt 2, „GetAddressesResponse“)

Tabelle der Parameter

Parameter

Beschreibung

Pflichtfeld

Parameter

Beschreibung

Pflichtfeld

AddressData

Die eigentlichen Daten im XML-Format. Das Format und der Inhalt der Adressänderungen ist in der separaten Dokumentation „Adressdatenänderungen“ beschrieben:

Format und Inhalt - WS-Adressdatenänderungen (DE)

ja, innerhalb von „Address“

Date

Datum der Adressänderung im Format YYYY-MM-DD

ja, innerhalb von „Address“

Time

Uhrzeit der Adressänderung im Format HH:MM:SS

ja, innerhalb von „Address“

Finished

„true“: Alle vorliegenden Adressänderungen wurden gesendet.
„false“: Es liegen noch Adressänderungen vor. In diesem Fall muss ein erneuter Request erfolgen.

ja

AddressNumber

Die Adressnummer

ja, innerhalb von „Address“

MsgID

Die vom externen System im Request übergebene MsgID

nein

Address

Enthält die Unterelemente „Date“, „Time“, „AddressNumber“ und „AddressData“

nein

AddressCount

Die Anzahl der gesendeten Adressänderungen

ja

Addresses

Enthält für jede der gesendeten Adressänderungen ein „Address“-Unterelement

ja

Beispiel für eine Antwort auf einen GetAddresses-Request:

Format und Inhalt der Adressänderungen

Das Format und der Inhalt wird in der separaten Dokumentation „Adressdatenänderungen“ beschrieben:

Format und Inhalt - WS-Adressdatenänderungen (DE)

Abruf von Gutscheinen

Mithilfe dieser Schnittstelle können externe Systeme die Daten von Gutscheinen abrufen, die mit dem Gutscheingenerator der WEBSALE AG erzeugt wurden. Zweck der Schnittstelle ist es nicht, Daten über die im Shop eingelösten Gutscheine abzurufen; diese Daten werden zusammen mit den Bestelldaten übermittelt.

Der Abruf der Gutscheinen erfolgt analog zum Abruf von Bestellungen in zwei Schritten:

  1. Senden des Request durch das externe System

  2. Senden der angeforderten Daten durch das WEBSALE-System

Voraussetzung

Das externe System muss

  • bei jedem Aufruf die ShopID und das Passwort übergeben

  • die zuletzt empfangene Gutscheinnummer speichern

Senden des Request durch das externe System (Schritt 1, „GetVouchers“)

Erster Abruf

Beim ersten Abholen von Gutscheinen liegt dem externen System noch keine letzte Gutscheinnummer vor. In diesem Fall erfolgt der Request nur mit Datum+Uhrzeit, ab dem die Gutscheine übermittelt werden sollen. Der Parameter „SkipFirstMatch“ wird auf „false“ gesetzt. Der nächste Request erfolgt dann mit der zuletzt gespeicherten Gutscheinnummer.

Laufender Betrieb

Bei dieser Anfrage übergibt das externe System die gespeicherte (zuletzt empfangene) Gutscheinnummer, ab der die Übertragung beginnen soll und optional, wie viele Gutscheine maximal gesendet werden sollen.
Liegen im WEBSALE-System mehr Gutscheine vor, als vom externen System angefordert wurden, so muss das externe System das Verfahren wiederholen, bis alle vorliegenden Gutscheine übertragen wurden. Der Parameter „SkipFirstMatch“ wird auf „true“ gesetzt. Das externe System speichert die zuletzt empfangene Gutscheinnummer und führt den nächsten Request mit dieser durch.

Einzelne Gutscheindaten abrufen

Hierzu wird die Gutscheinnummer und die maximale Zahl der zu sendenden Gutscheine mit „1“ übergeben. Der Parameter „SkipFirstMatch“ wird auf „false“ gesetzt.

Tabelle der Parameter

Parameter

Beschreibung

Pflichtfeld

Parameter

Beschreibung

Pflichtfeld

ShopID

Die Shop-ID

ja

Password

Das Passwort für die SOAP-Schnittstelle, Das Passwort erhalten Sie von der WEBSALE AG.

ja

Date

Datum im Format YYYY-MM-DD, bei dem die Übertragung beginnen soll.

nein

Time

Uhrzeit im Format HH:MM:SS, bei dem die Übertragung beginnen soll.

nein

VoucherNumber

Gutscheinnummer

nein

MaxVoucherCount

Die maximale Zahl der Gutscheine, die gesendet werden sollen (Default-Wert: 100, Maximum: 1000).

nein

MsgID

Optional kann das externe System eine MsgID mitgeben, die vom WEBSALE-System in der Antwort zurückgegeben wird. Für die Verarbeitung des Requests hat die MsgID keine Bedeutung.

nein

SkipFirstMatch

„true“: Die Übertragung beginnt mit dem darauf folgenden Gutschein.

„false“: Die Übertragung beginnt ab der übergebenen Gutscheinnummer

ja

Beispiel für einen GetVouchers-Request:

Den Gutschein „1234-1234-1234-1234“ abrufen und max. 99 Gutscheine, die danach generiert wurden.

Senden der Daten durch WEBSALE (Schritt 2, „GetVouchersResponse“)

Tabelle der Parameter

Parameter

Beschreibung

Pflichtfeld

Parameter

Beschreibung

Pflichtfeld

VoucherData

Die eigentlichen Daten des Gutscheins im XML-Format

ja, innerhalb von „Voucher“

Date

Datum der Generierung des Gutscheins im Format YYYY-MM-DD

ja, innerhalb von „Voucher“

Time

Uhrzeit der Generierung des Gutscheins im Format HH:MM:SS

ja, innerhalb von „Voucher“

Finished

„true“: Alle vorliegenden Gutscheine wurden gesendet.
„false“: Es liegen noch Gutscheine vor. In diesem Fall muss ein erneuter Request erfolgen.

ja

VoucherNumber

Gutscheinnummer

ja, innerhalb von „Voucher“

MsgID

Die vom externen System im Request übergebene MsgID

nein

Voucher

Enthält die Unterelemente „Date“, „Time“, „Number“ und „VoucherData“

nein

VoucherCount

Die Anzahl der gesendeten Gutscheine

ja

Vouchers

Enthält für jeden der gesendeten Gutscheine ein „Voucher“-Unterelement

ja

Beispiel für eine Antwort auf einen GetVouchers-Request:

Format und Inhalt der Gutscheindaten

Das Format und der Inhalt wird in der separaten Dokumentation „Gutscheindaten (from-Shop)“ beschrieben:

WS-Gutscheindaten (from-Shop)

Fehlerbehandlung

Tritt ein Fehler auf, so gibt die Schnittstelle einen „SOAP Fault“ zurück. Folgende Fehler können auftreten:

Fehlermeldung

Beschreibung

Fehlermeldung

Beschreibung

ES001 Fehlende ShopID oder Passwort

In dem Request fehlt der Parameter „ShopID“ oder der Parameter „Password“. Aus Sicherheitsgründen wird der Fehler nicht genau spezifiziert.

ES002 Ungültige ShopID oder ungültiges Passwort

Der Request enthielt zwar „ShopID“ und „Password“, aber es existiert kein passender Shop, das Passwort ist falsch oder die Schnittstelle ist für den Shop gar nicht freigeschaltet. Aus Sicherheitsgründen wird der Fehler nicht genau spezifiziert.

ES005 Fehler bei Server-Initialisierung

Bei der Initialisierung des SOAP-Servers trat ein Fehler auf. Versuchen Sie es später nochmal. Sofern der Fehler länger als 30 Minuten anhält, setzen Sie sich mit der WEBSALE AG in Verbindung.

ES007 SSL erforderlich

Der Aufruf des Programms muss über eine verschlüsselte Verbindung erfolgen. Ein Aufruf mit einer normalen “http”-URL ist nicht zulässig.

ES008 Falsche Shop-Version

Es wurde das SOAP-Interface für die V8-Version eines Shops aufgerufen, aber es existiert kein V8-Shop.

ES009 Fehlendes Pflichtfeld XYZ

Ein Pflichtfeld in dem Request fehlt oder ist leer.

ES010 Ungültige Datensatz-ID

In dem Request wurde eine Datensatz-ID (OrderNumber, InquiryNumber, AddressNumber oder VoucherNumber) übergeben, die im WEBSALE-System nicht existiert bzw. für das angegebene Datum nicht existiert.

ES011 Datum fehlt

Für die angeforderten Datensätze ist auch bei Angabe einer Datensatz-ID zusätzlich ein Datum erforderlich (Anfragen und Adressdatenänderungen).

ES012 Formatfehler

Ein Feld, für das ein bestimmtes Format vorgegeben ist (z. B. Date oder Time), hat einen falschen Aufbau.

ES013 Subshop nicht freigeschaltet

Im „SubshopIDs“-Feld war eine SubshopID angegeben, für die das Abholen von Bestelldaten nicht freigeschaltet ist.

ES014 Ungültiger MaxCount-Wert

Es können maximal 1000 Datensätze je SOAP-Call abgerufen werden, höhere Werte in einem Max***Count-Feld führen zu diesem Fehler, „0“ oder negative Werte sind ebenfalls unzulässig.

ES015 Ungültiger Request

Das SOAP-Framework konnte den eingehenden Request nicht verarbeiten.

ES016 Plugin-Fehler

Eine Bestellung konnte durch ein Konvertierungs-Plugin nicht bearbeitet werden.

Beispiel für einen „SOAP-Fault“:

WSDL-Beispieldateien

Für jede der beschriebenen Schnittstellen dieser Dokumentation finden Sie eine WSDL-Datei (order.wsdl, inquiry.wsdl, address.wsdl und voucher.wsdl) auf der untergeordneten Seite, die Sie nutzen können, um den Code zur Anbindung der Schnittstelle automatisiert zu erstellen. Voraussetzung dafür ist, dass es für die von Ihnen verwendete Programmiersprache ein passendes Tool gibt um die WSDLs einzulesen.

URL des SOAP-Servers

Für V8-Shops lauten die URLs des SOAP-Servers:

Bitte beachten Sie, dass sich diese URLs in Zukunft ändern können. Stellen Sie also sicher, dass sich diese ohne größeren Aufwand bei Ihnen ändern lassen.