> ## Documentation Index
> Fetch the complete documentation index at: https://dokumentation.websale.de/llms.txt
> Use this file to discover all available pages before exploring further.

# WS-Gutscheindaten (from-Shop)

> Daten der im Gutschein-Generator erzeugten Gutscheine aus dem Shop abholen, mit allen Parametern und einem Beispiel.

Über diese Schnittstelle holen externe Systeme die Daten der Gutscheine ab, die mit dem Gutschein-Generator im Online-Servicebereich erzeugt wurden.

Sie liefert nicht, welche Gutscheine im Shop eingelöst wurden. Diese Information steht in den Bestelldaten. Wer Einlösungen auswerten will, braucht also die [WS-Bestelldaten](https://dokumentation.websale.de/v8s/schnittstellen/bestellungen/ws-bestelldaten.md), nicht diese Schnittstelle.

| Eigenschaft | Wert |
| - | - |
| Übertragungsrichtung | WEBSALE Shop → Warenwirtschaft (Data-from-Shop) |
| Übertragungsart | SOAP |
| Format | XML |

Abgeholt werden die Daten über [SOAP-from-Shop](https://dokumentation.websale.de/v8s/schnittstellen/uebertragung/soap-from-shop.md). Lässt sich in Ihrem System kein SOAP umsetzen, geht es alternativ über den [WSOM-from-Shop](https://dokumentation.websale.de/v8s/schnittstellen/uebertragung/wsom-from-shop.md), die nicht mehr empfohlene Vorgängerversion.

## Parameter

| Parameter | Beschreibung | Pflichtfeld |
| - | - | - |
| `VoucherNumber` | Die Gutscheinnummer | ja |
| `ChargeId` | Chargen-ID des Gutscheins | ja |
| `Currency` | Währung | ja |
| `Amount` | Betrag oder Prozentsatz | ja |
| `AmountType` | `0` für einen absoluten Betrag (Standard), `1` für einen Prozentsatz | ja |
| `Type` | Gutscheintyp: `0` Restbetrag wiederverwendbar, `1` Restbetrag verfällt, `2` Universalgutschein, `3` Universalgutschein kundenspezifisch, `4` Universalgutschein nur für Neukunden | ja |
| `Type2` | `1` für Werbegutschein, `2` für Kaufgutschein | ja |
| `UsedAmount` | Bereits eingelöster Betrag | nein |
| `State` | `1` für aktiv, `0` für nicht aktiv. Standard ist aktiv. | nein |
| `MinOrderValue` | Mindestbestellwert für das Einlösen | nein |
| `Subshop` | Subshop, in dem der Gutschein gilt. Leer bedeutet: alle Subshops. | nein |
| `Categories` | Kommagetrennte Liste der Kategorieindizes, für die der Gutschein gilt | nein |
| `Products` | Kommagetrennte Liste der Produkte, für die der Gutschein gilt | nein |
| `ProductsType` | `0`: `Products` enthält Produktindizes. `1`: `Products` enthält Produktnummern. | nein |
| `BasketProducts` | Kommagetrennte Liste der Produktnummern, die beim Einlösen automatisch in den Warenkorb gelegt werden | nein |
| `VATIndex` | Mehrwertsteuerkennung: ein in der `shop.config` unter `VATRates` konfigurierter Wert, `-1` für Standard oder `0` für keine Mehrwertsteuer. Standard ist `-1`. | nein |
| `ValidFrom` | Gültig ab, im Format `YYYY-MM-DD` | nein |
| `ValidUntil` | Gültig bis, im Format `YYYY-MM-DD` | nein |
| `IsTemplate` | `0` für einen normalen Gutschein (Standard), `1` für eine Gutschein-Vorlage zum Newsletter-Versand | nein |
| `ValidFromDays` | Nur bei Vorlagen: gültig ab so vielen Tagen nach dem Newsletter-Versand | nein |
| `ValidUntilDays` | Nur bei Vorlagen: gültig bis so viele Tage nach dem Newsletter-Versand | nein |

Beachten Sie das Datumsformat: Hier gilt `YYYY-MM-DD`, beim Import über [WS-SFTP-Gutscheindaten (to-Shop)](https://dokumentation.websale.de/v8s/schnittstellen/marketing-seo-und-portale/ws-sftp-gutscheindaten-to-shop.md) dagegen `YYYYMMDD`.

## Beispiel

```xml theme={"theme":{"light":"github-light","dark":"github-dark"},"languages":{"custom":["/languages/websale.json"]}}
<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>
```

## Verwandte Themen

* Wegweiser: [Marketing, SEO und externe Portale](https://dokumentation.websale.de/v8s/schnittstellen/marketing-seo-und-portale.md)
* Wegweiser: [WS-SFTP-Gutscheindaten (to-Shop)](https://dokumentation.websale.de/v8s/schnittstellen/marketing-seo-und-portale/ws-sftp-gutscheindaten-to-shop.md)
* Wegweiser: [SOAP-from-Shop](https://dokumentation.websale.de/v8s/schnittstellen/uebertragung/soap-from-shop.md)


## Related topics

- [WS-SFTP-Gutscheindaten (to-Shop)](https://dokumentation.websale.de/v8s/schnittstellen/marketing-seo-und-portale/ws-sftp-gutscheindaten-to-shop.md)
- [SOAP-from-Shop](https://dokumentation.websale.de/v8s/schnittstellen/uebertragung/soap-from-shop.md)
- [Marketing, SEO und externe Portale](https://dokumentation.websale.de/v8s/schnittstellen/marketing-seo-und-portale.md)
- [WSOM-from-Shop](https://dokumentation.websale.de/v8s/schnittstellen/uebertragung/wsom-from-shop.md)
- [SFTP-REST-to-Shop](https://dokumentation.websale.de/v8s/schnittstellen/uebertragung/sftp-rest-to-shop.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.