Handbuch

Alle Einstellungen

Erzeugt aus der Konfigurationsdatei des Plugins. Beschriftungen und Hilfetexte stehen wörtlich so im Shopware-Admin.

Diese Referenz entsteht aus der Konfigurationsdatei des Plugins. Beschriftungen, Auswahlwerte und Hilfetexte stehen wörtlich so im Shopware-Admin - auch dort, wo eine Formulierung sperrig ist.

Allgemeine Einstellungen

Plugin aktivieren

status · bool · Standard: true

Soll das Plugin für diesen Verkaufskanal aktiviert werden?

Vorgehensweisen aktivieren

procedureStatus · bool · Standard: true

Soll der Kunde eine gewünschte Vorgehensweise pro Produkt auswählen? Die Vorgehensweisen können unter Einstellungen -> Erweiterungen -> Vorgehensweisen für Rücksendungen konfiguriert werden.

Checkliste aktivieren

checklistStatus · bool · Standard: false

Muss der Kunde aktiv eine Checkliste bestätigen, bevor er eine Rücksendung anlegen kann? Alle Fragen dieser Checkliste sind verpflichtend und müssen abgehakt werden. Die Checkliste wird innerhalb eines modalen Fensters beim Klick auf "Rücksendung anlegen" angezeigt. Die einzelnen Fragen der Checkliste können Sie in den Shopware Einstellungen pflegen.

Label API Fehlermeldungen ausgeben

outputLabelApiError · bool · Standard: true

Soll die Fehlermeldung der DHL/UPS API für den Kunden in der Storefront angezeigt werden, falls ein Label nicht erzeugt werden konnte? Alternativ wird dem Kunden nur eine Standard Fehlermeldung angezeigt. Die Fehlermeldungen können dann in den Logs eingesehen werden.

Hinweis auf Dokument geben

provideDocumentNote · bool · Standard: true

Soll dem Kunden ein Hinweis auf das Rücksende-Dokument gegeben werden (in einem modalen Fenster), falls er ein Label ausdrucken möchte, bevor er sich das Dokument angezeigt hat? Der Hinweis wird nur 1x angezeigt.

Suche nach Bestellungen aktivieren

orderSearchStatus · bool · Standard: false

Soll dem Kunden ein Formular angezeigt werden, mit dem er über den Namen und seine Email Adresse und/oder Postleitzahl nach Bestellungen suchen kann?

Bestellungen - Bedingungen

Gültige Bestellstatus

validOrderState · component

Eine Rücksendung kann nur für Bestellungen mit diesem Status angelegt werden. Sollte KEIN Bestellstatus definiert sein, dann gelten ALLE Bestellstatus als gültig.

Gültige Kundengruppen

validCustomerGroup · component

Eine Rücksendung kann nur für Bestellungen von diesen Kundengruppen angelegt werden. Sollte KEINE Kundengruppe definiert sein, dann gelten ALLE Kundengruppen als gültig.

Gültige Länder

validCountry · component

Eine Rücksendung kann nur angelegt werden, wenn die Rechnungs- oder Lieferanschrift der Bestellung in einem dieser Länder liegt. Sollte KEIN Land definiert sein, dann gelten ALLE Länder als gültig.

Produkte - Bedingungen

Individuelle Bedingungen für Produkte aktivieren

productRestrictionStatus · bool · Standard: false

Möchten Sie individuelle Bedingungen für Produkte aktivieren? Geben Sie dazu in das unten stehende Feld die entsprechende Twig Syntax an.

Twig Syntax

productRestrictionTwig · textarea

Nutzen Sie Twig Syntax, um einzelne Produkte zu prüfen und zu validieren. Das angegebene Twig wird für jedes Produkt der Bestellung durchlaufen. Dabei können Sie auf die Variable {{ lineItem }} zugreifen. Das entspricht dem Datensatz aus der Datenbank Tabelle "order_line_item". Über {{ lineItem.product }} können Sie auf das Produkt und über {{ lineItem.order }} können Sie auf die Bestellung zugreifen. Wenn Sie ein Produkt von einer Rücksendung ausschließen möchten, dann müssen Sie die Variable "isValid" auf false setzen. Beispiel: {% if lineItem.product and lineItem.product.productNumber == 'abc-12345' %}{% set isValid = false %}{% endif %}

SEO Einstellungen

SEO Url

seoUrl · text · Standard: ruecksendung

Hier können Sie eine SEO Url für Ihr Rücksende-Formular (z.B. für Gäste) aktivieren. Diese Url leitet dann automatisch auf die Plugin Url weiter. Beispiel: ruecksendung

Frist zum Anlegen einer Rücksendung

Frist aktivieren

deadlineStatus · bool · Standard: false

Wenn diese Option aktiviert ist, dann ist das Anlegen von Rücksendungen nur in einem definierten Zeitraum verfügbar. Sie können somit z.B. definieren, dass Rücksendungen maximal 21 Tage nach Versand angelegt werden können.

Angabe der Frist

deadlineType · single-select · Standard: period

Auswahl: Zeitraum (in Tagen) · Zeitpunkt (als Datum)

Wie wünschen Sie die Angabe der Frist? Als variablen Zeitraum (in Tagen) oder einen festen Zeitpunkt (als Datum)?

Zeitraum (in Tagen) oder Zeitpunkt (als Datum)

deadlineDaysDate · text · Standard: 30

Zeitraum (in Tagen) oder Zeitpunkt (als Datum). Hinweis: den Zeitpunkt bitte im englischen Format als YYYY-MM-DD angeben - also z.B. 2021-12-31 für den 31. Dezember 2021.

Lieferstatus

deadlineOrderDeliveryStatus · component · Standard: 298a58594abe4909b218c7a629727d43

Der Lieferstatus der Bestellung zur Prüfung der Frist. Hinweis: eine Rücksendung kann nur angelegt werden, wenn dieser Lieferstatus bereits gesetzt wurde und wenn der Lieferstatus vor maximal x Tagen gesetzt wurde.

Email an Kunde bei neuer Rücksendung

Kunde per Email beim Anlegen einer Rücksendung informieren

sendEmailToCustomerOnCreate · single-select · Standard: yesStorefront

Auswahl: Nein · Ja, wenn in der Storefront angelegt · Ja, wenn in der Administration angelegt · Ja, immer

Soll der Kunde per Email informiert werden, sobald eine neue Rücksendung angelegt wurde?

Anhänge senden

sendEmailToCustomerOnCreateAttachments · single-select · Standard: document

Auswahl: Keine Anhänge · Rücksendedokument anhängen · Rücksendedokument und Label anhängen

Sollen bei der Email, die der Kunde erhält auch Anhänge mitgesendet werden? Label werden nur gesendet, wenn diese aktiviert und verfügbar sind.

Email an Adminstrator bei neuer Rücksendung

Email aktivieren

emailStatus · bool · Standard: false

Möchten Sie eine Email erhalten, wenn eine neue Rücksendung angelegt wurde?

Email Adresse

emailAddress · text

Der Empfänger der Email.

Betreff

emailSubject · text · Standard: Rücksendung angelegt

Der Betreff der Email.

Inhalt

emailContent · textarea

Der Inhalt der Email.

DHL Label Einstellungen

DHL Label aktivieren

dhlLabelStatus · bool · Standard: false

Soll dem Kunden automatisch ein DHL Label erzeugt werden?

DHL Label als QR Code aktivieren

dhlQrCodeStatus · bool · Standard: false

Soll dem Kunden zusätzlich ein QR Code erzeugt werden?

Label speichern

dhlLabelSaveStatus · bool · Standard: true

Soll das DHL Label intern in der Datenbank zwischen gespeichert werden - oder bei jeder Anfrage neu über die Schnittstelle angefragt werden? Diese Option sollte nur zu Testzwecken deaktiviert werden.

Mehrere Labels aktivieren

dhlLabelMultipleStatus · bool · Standard: false

Darf der Kunde mehrere Labels für mehrere Pakete erstellen? Der Kunde wird nach dem Download des ersten Labels darauf hingewiesen, dass er bis zu fünf weitere Labels erzeugen kann.

Protokoll aktivieren

dhlLabelLogStatus · bool · Standard: false

Sollen Anfragen an die Schnittstelle und Antworten von der Schnittstelle protokolliert werden?

Warenwert Minimum

dhlLabelMinValue · int · Standard: 0

Wenn die Summe aller retournierten Produkte (in Euro und Netto) kleiner ist, als der angegebene Wert dieser Plugin Konfiguration, dann wird dem Kunden kein Label zur Verfügung gestellt. Stattdessen erscheint zusätzlich ein konfigurierbarer (über Textbausteine) Hinweis.

Gültige Kundengruppen

dhlLabelValidCustomerGroup · component

Das DHL Label wird nur für Kunden dieser Kundengruppen angezeigt. Sollte KEINE Kundengruppe definiert sein, dann gelten ALLE Kundengruppen als gültig.

DHL Geschäftskundenportal - Zugangsdaten

dvsnReturnShipmentConfigDhlInfo

dvsnReturnShipmentConfigDhlInfo · component

UPS Label Einstellungen

UPS Label aktivieren

upsLabelStatus · bool · Standard: false

Soll dem Kunden automatisch ein UPS Label erzeugt werden? Das ist nur für Kunden innerhalb von Deutschland möglich.

Label speichern

upsLabelSaveStatus · bool · Standard: true

Soll das UPS Label intern in der Datenbank zwischen gespeichert werden - oder bei jeder Anfrage neu über die Schnittstelle angefragt werden? Diese Option sollte nur zu Testzwecken deaktiviert werden.

Mehrere Labels aktivieren

upsLabelMultipleStatus · bool · Standard: false

Darf der Kunde mehrere Labels für mehrere Pakete erstellen? Der Kunde wird nach dem Download des ersten Labels darauf hingewiesen, dass er bis zu fünf weitere Labels erzeugen kann.

Protokoll aktivieren

upsLabelLogStatus · bool · Standard: false

Sollen Anfragen an die Schnittstelle und Antworten von der Schnittstelle protokolliert werden?

Gültige Kundengruppen

upsLabelValidCustomerGroup · component

Das UPS Label wird nur für Kunden dieser Kundengruppen angezeigt. Sollte KEINE Kundengruppe definiert sein, dann gelten ALLE Kundengruppen als gültig.

UPS Label - Zugangsdaten

dvsnReturnShipmentConfigUpsInfo

dvsnReturnShipmentConfigUpsInfo · component

Frist zur Erstellung eines Labels

Frist aktivieren

labelDeadlineStatus · bool · Standard: false

Wenn diese Option aktiviert ist, dann ist die Erzeugung eines Retouren Labels (DHL oder UPS) nur in einem definierten Zeitraum verfügbar. Sie können somit z.B. definieren, dass Labels maximal 21 Tage nach Versand erzeugt werden können.

Angabe der Frist

labelDeadlineType · single-select · Standard: period

Auswahl: Zeitraum (in Tagen) · Zeitpunkt (als Datum)

Wie wünschen Sie die Angabe der Frist? Als variablen Zeitraum (in Tagen) oder einen festen Zeitpunkt (als Datum)?

Zeitraum (in Tagen) oder Zeitpunkt (als Datum)

labelDeadlineDaysDate · text · Standard: 30

Zeitraum (in Tagen) oder Zeitpunkt (als Datum). Hinweis: den Zeitpunkt bitte im englischen Format als YYYY-MM-DD angeben - also z.B. 2021-12-31 für den 31. Dezember 2021.

Lieferstatus

labelDeadlineOrderDeliveryStatus · component · Standard: 298a58594abe4909b218c7a629727d43

Der Lieferstatus der Bestellung zur Prüfung der Frist. Hinweis: eine Rücksendung kann nur angelegt werden, wenn dieser Lieferstatus bereits gesetzt wurde und wenn der Lieferstatus vor maximal x Tagen gesetzt wurde.