WS-SFTP-Gutscheindaten (to-Shop)

Mit diesen Importdateien legen Sie Gutscheine aus Ihrem System heraus an, ändern sie oder löschen sie wieder. Zwei Dateien decken alles ab: voucherupdate für Anlegen und Ändern, voucherdelete für das Löschen.

Eigenschaft	Wert
Übertragungsrichtung	Warenwirtschaft → WEBSALE Shop (Data-to-Shop)
Übertragungsart	Dateien per SFTP, Import per REST oder SOAP
Dateiformate	CSV beziehungsweise DAT

Die Dateien übertragen Sie per SFTP und stoßen den Import anschließend über SFTP-REST-to-Shop oder SFTP-SOAP-to-Shop an. Bestandskunden können alternativ den WSPManager verwenden.

voucherupdate: anlegen und ändern

Pflichtfelder

Name	Bedeutung
`Number`	Eindeutige Gutscheinnummer, maximal 200 Zeichen
`ChargeId`	Chargen-ID, nötig zum Bearbeiten und Anzeigen im Online-Servicebereich
`Currency`	Währung des Gutscheins
`Type`	Gutscheintyp, siehe Tabelle unten
`Type2`	`1` für Werbegutschein, `2` für Kaufgutschein
`Amount`	Betrag oder Prozentsatz

Die Gutscheinnummer darf im Prinzip beliebige Zeichen enthalten. Vermeiden Sie trotzdem Umlaute und andere Zeichen außerhalb des ASCII-Codes: Weicht die Zeichensatz-Kodierung im Shop von der Kodierung der Gutscheindaten ab, lassen sich solche Gutscheine nicht einlösen.

Gutscheintypen

`Type`	Bedeutung
0	Restbetrag kann wiederverwendet werden
1	Restbetrag verfällt
2	Universalgutschein
3	Universalgutschein, kundenspezifisch, jeder Kunde kann ihn nur einmal verwenden
4	Universalgutschein, nur für Neukunden
5	Restbetrag kann wiederverwendet werden, nur für Neukunden
6	Restbetrag verfällt, nur für Neukunden
7	Individueller Mehrfachgutschein: ein Universalgutschein mit automatischer Kundenbindung. Sobald ein Kunde ihn eingelöst hat, kann nur noch dieser Kunde ihn einlösen, das aber beliebig oft.

Betrag, Rabatt und Grenzen

Name	Bedeutung	Pflichtfeld
`AmountType`	`0` für einen absoluten Betrag (Standard), `1` für einen Prozentsatz, `2` für einen prozentualen und gedeckelten Wert	nein
`UsedAmount`	Bereits eingelöster Betrag	nein
`MinOrderValue`	Mindestbestellwert, ab dem der Gutschein eingelöst werden kann	nein
`MaxUseCount`	Maximale Anzahl Einlösungen, nur für Universalgutscheine. Fehlt das Feld oder ist es leer, ist der Gutschein beliebig oft einlösbar.	nein
`MaxDiscountValue`	Nur bei prozentualem Rabatt: maximaler einlösbarer Wert	nein
`State`	`1` für aktiv, `0` für nicht aktiv. Standard ist aktiv.	nein
`ValidFrom`	Gültig ab, im Format `YYYYMMDD`	nein
`ValidUntil`	Gültig bis, im Format `YYYYMMDD`	nein

AmountType mit dem Wert 2 ist ein Sonderfall: Er lässt sich nur für Set-Unterartikel verwenden, deren Produktnummern oder Produktindizes im Feld CatProdFilter stehen müssen. Die Gesamtsumme der Position wird dann unabhängig von der Menge auf den in Amount angegebenen Betrag gedeckelt. Ein normaler Maximalbetrag lässt sich bei diesem Typ nicht angeben.

Mehrere Währungen

Arbeitet ein Gutschein mit mehreren Währungen, treten vier Felder an die Stelle ihrer einfachen Varianten: AmountMultiCurrency, UsedAmountMultiCurrency, MinOrderValueMultiCurrency und MaxDiscountValueMultiCurrency. Das Format ist bei allen gleich:

<g><c>EUR</c><a>10.00</a></g><g><c>GBP</c><a>8.00</a></g>

Gültigkeitsbereich einschränken

Name	Bedeutung
`Subshop`	Kommagetrennte Liste der Subshops, in denen der Gutschein gilt. Leer bedeutet: alle Subshops.
`CustomerFilter`	Einschränkung auf bestimmte Kunden
`CatProdFilter`	Einschränkung auf bestimmte Produkte oder Kategorien
`CatProdFilterSetBehavior`	`0`: Das Oberprodukt entscheidet, ob der Gutschein für einen Setartikel gilt. `1`: Die Unterprodukte entscheiden.

Im CustomerFilter identifizieren Sie Kunden über den Userindex mit <i></i> oder über die Kundennummer mit <n></n>. Mit den negierten Tags <!i></!i> und <!n></!n> schließen Sie Kunden aus.

<i>123</i>                  Gutschein gilt nur für den Kunden mit Userindex 123
<n>abc</n><n>xyz</n>        Gutschein gilt nur für die Kundennummern abc und xyz
<!i>456</!i>                Gutschein gilt nicht für den Kunden mit Userindex 456

Sobald dieses Feld gefüllt ist, muss der Kunde im Shop angemeldet sein, um den Gutschein einzulösen. Das ist leicht zu übersehen und führt sonst dazu, dass der Gutschein für Gäste scheinbar grundlos nicht greift. Im CatProdFilter schränken Sie über Kategorieindizes <ci></ci>, Produktindizes <pi></pi> oder Produktnummern <pn></pn> ein. Je Gutschein lassen sich entweder <pi>- oder <pn>-Einträge verwenden, eine Mischung der beiden ist nicht möglich.

<ci>543</ci><ci>345</ci>    nur für die Kategorien 543 und 345
<pn>abc</pn><pn>xyz</pn>    nur für die Produkte mit den Nummern abc und xyz

Weitere Felder

Name	Bedeutung
`ChargeDescr`	Beschreibung der Charge, wie sie im Online-Servicebereich erscheint
`ChargeLabel`	Label des Gutscheins, das in den Bestelldaten mitläuft und sich für Auswertungen nutzen lässt. Mehrere Label als kommagetrennte Liste möglich.
`VATIndex`	Mehrwertsteuerkennung. Entweder einer der in der `shop.config` unter `VATRates` konfigurierten Werte oder `-1` für Standard beziehungsweise `0` für keine Mehrwertsteuer. Standard ist `-1`.
`VoucherProds`	Kommagetrennte Liste von Produktnummern, die beim Einlösen automatisch in den Warenkorb gelegt werden
`Pool`	`y` schreibt den Gutschein in den Gutschein-Pool. Er ist dann erst einlösbar, nachdem er über die SOAP-Gutschein-Schnittstelle aktiviert wurde.
`SpecialFeatures`	Tag-getrenntes Feld für kundenspezifische Spezialfeatures

Bei -1 verwendet der Gutschein die unter DeliveryVATRate konfigurierte Kennung. Ein bereits aktivierter Gutschein lässt sich nicht erneut in den Pool importieren.

Mehrfache Gutscheinnummern in einer Datei

Kommt dieselbe Gutscheinnummer mehrfach in einer Importdatei vor, überschreiben die späteren Datensätze normalerweise die früheren. Ist für Ihren Shop die Zusammenfassung der Subshop-Felder freigeschaltet, verhält sich der Import anders: Er prüft, ob die Daten der mehrfach vorkommenden Gutscheine bis auf das Feld Subshop identisch sind. Trifft das zu, fasst er die Subshop-Einträge zusammen. Gibt es Abweichungen, importiert er nur den ersten Datensatz und ignoriert alle weiteren.

voucherdelete: löschen

Name	Bedeutung	Pflichtfeld
`Number`	Eindeutige Gutscheinnummer	ja
`Pool`	`y` löscht den Gutschein aus dem Gutschein-Pool	nein

Beispieldateien

Zur Dokumentation gehören die Beispieldateien voucherupdate.dat und voucherdelete.dat. Sie erhalten sie von Ihrem WEBSALE-Ansprechpartner.

Schnittstellen

voucherupdate: anlegen und ändern

Pflichtfelder

Gutscheintypen

Betrag, Rabatt und Grenzen

Mehrere Währungen

Gültigkeitsbereich einschränken

Weitere Felder

Mehrfache Gutscheinnummern in einer Datei

voucherdelete: löschen

Beispieldateien

Verwandte Themen

​voucherupdate: anlegen und ändern

​Pflichtfelder

​Gutscheintypen

​Betrag, Rabatt und Grenzen

​Mehrere Währungen

​Gültigkeitsbereich einschränken

​Weitere Felder

​Mehrfache Gutscheinnummern in einer Datei

​voucherdelete: löschen

​Beispieldateien

​Verwandte Themen

voucherupdate: anlegen und ändern

Pflichtfelder

Gutscheintypen

Betrag, Rabatt und Grenzen

Mehrere Währungen

Gültigkeitsbereich einschränken

Weitere Felder

Mehrfache Gutscheinnummern in einer Datei

voucherdelete: löschen

Beispieldateien

Verwandte Themen