Allgemeines

Mit Hilfe dieser Schnittstelle können externe Systeme die Daten von Gutscheinen abrufen, die mit dem WEBSALE Gutscheingenerator im Online-Servicebereich 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.

Diese Dokumentation beschreibt das Format und den Inhalt von Gutscheindaten, welche von einem Shop abgeholt werden können.

Transfer der Gutscheine

Die nachfolgend beschriebenen Gutscheindaten werden via SOAP übertragen. Die Übertragung wird in der separaten Dokumentation „SOAP-from-Shop“ beschrieben:

SOAP-from-Shop (DE) (empfohlen)

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

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

Beschreibung der Parameter

Parameter	Beschreibung	Pflichtfeld

Parameter	Beschreibung	Pflichtfeld
Amount	Betrag oder Prozentsatz des Gutscheins	ja
AmountType	0: Amount enthält einen absoluten Betrag (Default) 1: Amount enthält einen Prozentsatz	ja
BasketProducts	Die Nummern der Produkte, die automatisch in den Warenkorb gelegt werden sollen, wenn dieser Gutschein eingelöst wird (kommagetrennte Liste).	nein
Categories	Kategorieindizes, für die der Gutschein gültig ist (kommagetrennte Liste).	nein
ChargeId	Die Chargen-ID des Gutscheins	ja
Currency	Die Währung	ja
IsTemplate	0: Normaler Gutschein (Default) 1: Gutschein-Vorlage für Newsletter-Versand	nein
MinOrderValue	Ein Mindestbestellwert für das Einlösen des Gutscheins	nein
Products	Produktindizes oder Produktnummern, für die der Gutschein gültig ist (kommagetrennte Liste).	nein
ProductsType	0: „Products“ enthält Produktindizes 1: „Products“ enthält Produktnummern	nein
State	Der Status des Gutscheins, folgende zwei Werte sind möglich: 1: Aktiv 0: Nicht aktiv Standardmäßig ist ein Gutschein aktiv	nein
Subshop	Subshop, für den der Gutschein gelten soll. Ist dieses Feld leer, so kann der Gutschein in allen Subshops eingelöst werden	nein
Type	Der Typ der Gutscheine. Folgende Typen werden unterstützt: 0: Restbetrag kann wiederverwendet werden 1: Restbetrag verfällt 2: Universalgutschein 3: Universalgutschein (kundenspezifisch) 4: Universalgutschein (nur für Neukunden)	ja
Type2	Werbegutschein/Kaufgutschein 1: Werbegutschein 2: Kaufgutschein	ja
UsedAmount	Der bereits eingelöste Betrag des Gutscheins	nein
ValidFrom	Datum, ab dem der Gutschein gültig ist, im Format „YYYY-MM-DD“	nein
ValidFromDays	Nur bei Gutschein-Vorlagen: Gültig erst ab “ValidFromDays” Tag(en) nach dem Versand des Newsletters	nein
ValidUntil	Datum, bis zu dem der Gutschein gültig ist, im Format „YYYY-MM-DD“	nein
ValidUntilDays	Nur bei Gutschein-Vorlagen: Gültig erst in “ValidUntilDays“ Tag(en) nach dem Newsletter-Versand	nein
VATIndex	Die MwSt-Kennung der Gutscheine. Dies kann entweder einer der in der shop.config unter "<VATRates>" konfigurierten Werte sein oder einer der Spezialwerte "-1" oder "0". "-1" bedeutet "Standard", für den Gutschein wird in diesem Fall die unter DeliveryVATRate konfigurierte Kennung verwendet. "0" steht für "Keine Mehrwertsteuer". Der Standard-Wert ist „-1“	nein
VoucherNumber	Die Gutscheinnummer	ja

Beispiel

<Amount>5.00</Amount>
<AmountType>0</AmountType>
<ChargeId>Test-Charge</ChargeId>
<Currency>EUR</Currency>
<State>0</State>
<Type>0</Type>
<Type2>2</Type2>
<UsedAmount>0.00</UsedAmount>
<ValidFrom/>
<ValidUntil>2013-06-03</ValidUntil>
<VATIndex>-1</VATIndex>
<VoucherNumber>FSIZ-HG1Y-UTKR-G16B</VoucherNumber>