Manual

Every setting

Generated from the configuration file of the plugin. Labels and help texts read exactly like this in the Shopware admin.

This reference is generated from the configuration file of the plugin, so labels, options and help texts read exactly like this in the Shopware admin. Three help texts and two card titles carry the German wording in the English field of the plugin as well; they are marked translated here and rendered in English on this page, while the plugin itself stays untouched.

Default settings

Activate plugin

status · bool · default: true

Enables the plugin for the current sales channel.

Activate procedures

procedureStatus · bool · default: true

Should the customer select a desired procedure?

Activate checklist

checklistStatus · bool · default: false

Does the customer have to actively confirm a checklist before creating a return? All questions in this checklist are mandatory and must be checked off. The checklist is displayed within a modal window when clicking on "Create return". You can maintain the individual questions of the checklist in the Shopware settings.

Output Label API error messages

outputLabelApiError · bool · default: true

Should the DHL/UPS API error message be displayed for the customer in the storefront if a label could not be generated? Alternatively, only a standard error message is displayed to the customer. The error messages can then be viewed in the logs.

Provide note to print document

provideDocumentNote · bool · default: true

Should the customer be given a note on the return document if he wants to print out a label before he has displayed the document? The note is only displayed once.

Activate order search

orderSearchStatus · bool · default: false

Should the customer be able to search for an order with customer name and email address or zip code?

Orders - conditions translated here

Valid order states

validOrderState · component

A return shipment can only be created for orders with this status. If no order status is defined, ALL order statuses are valid.

Valid customer groups

validCustomerGroup · component

A return shipment can only be created for orders from this customer group. If no customer group is defined, ALL customer groups are considered valid.

Valid countries

validCountry · component

A return shipment can only be created if either the billing or shipping address of the order is in one of these countries. If no country is defined, ALL countries are considered valid.

Products - conditions translated here

Enable custom conditions for products

productRestrictionStatus · bool · default: false

Do you want to enable custom conditions for products? Enter the appropriate Twig syntax in the field below.

Twig Syntax

productRestrictionTwig · textarea

Use Twig syntax to check and validate individual products. The Twig you enter runs for every product of the order. You can access the variable {{ lineItem }}, which corresponds to the record from the database table "order_line_item". Through {{ lineItem.product }} you reach the product and through {{ lineItem.order }} the order. To exclude a product from a return shipment you have to set the variable "isValid" to false. Example: {% if lineItem.product and lineItem.product.productNumber == 'abc-12345' %}{% set isValid = false %}{% endif %} translated here

SEO settings

SEO Url

seoUrl · text · default: ruecksendung

Here you can activate an SEO Url for your return form (e.g. for guests). This Url will then automatically redirect to the Plugin Url. Example: return-url

Deadline settings

Activate valid period

deadlineStatus · bool · default: false

If this option is activated, the creation of returns is only available in a defined period of time. For example, you can define that returns can be created for a maximum of 21 days after shipping.

Specification of the deadline

deadlineType · single-select · default: period

Options: Period (in days) · Date (as date)

How do you want the deadline to be specified? As a variable period (in days) or a fixed time (as a date)

Period (in days) or date (as date)

deadlineDaysDate · text · default: 30

Period (in days) or time (as date). Note: please specify the date in English format as YYYY-MM-DD - e.g. 2021-12-31 for December 31, 2021.

Order delivery status

deadlineOrderDeliveryStatus · component · default: 298a58594abe4909b218c7a629727d43

The delivery status of the order to check the deadline. Note: a return can only be created if this delivery status has already been set. In addition, the delivery status may be a maximum of x days old - depending on the period specified.

Email to customer when creating a new return shipment

Inform customer by email when creating a return shipment

sendEmailToCustomerOnCreate · single-select · default: yesStorefront

Options: No · Yes, in the storefront · Yes, in the administration · Yes, always

Should the customer be informed by email as soon as a new return shipment has been created?

Send attachments

sendEmailToCustomerOnCreateAttachments · single-select · default: document

Options: No attachments · Attach return document · Attach return document and label

Should attachments also be sent with the email that the customer receives? Labels are only sent if they are activated and available.

Email to administrator when creating a new return shipment

Activate email

emailStatus · bool · default: false

Would you like to receive an email when a new return has been created?

Email address

emailAddress · text

The recipient of the email.

Subject

emailSubject · text · default: Rücksendung angelegt

The subject of the email.

Content

emailContent · textarea

The content of the email.

DHL label settings

Activate DHL label

dhlLabelStatus · bool · default: false

Should a DHL label be automatically generated for the customer?

Activate QR code DHL label

dhlQrCodeStatus · bool · default: false

Should the customer be shown a QR code for download in addition to the standard DHL label?

Save label

dhlLabelSaveStatus · bool · default: true

Should the DHL label be stored temporarily - or should it be requested anew via the interface with every request? You should only activate this option for test purposes.

Activate multiple labels

dhlLabelMultipleStatus · bool · default: false

Can the customer create multiple labels for multiple packages? The customer is informed after downloading the first label that he can create up to five more labels.

Activate log

dhlLabelLogStatus · bool · default: false

Should requests to the interface and responses from the interface be logged? translated here

Minimum value of goods

dhlLabelMinValue · int · default: 0

If the sum of all returned articles (in Euro and net) is smaller than the specified value of this plugin configuration, then no label is provided to the customer. Instead, a configurable (via text modules) note appears additionally.

Valid customer groups

dhlLabelValidCustomerGroup · component

The DHL label is only displayed for customers in these customer groups. If no customer group is defined, ALL customer groups are valid.

DHL business customer portal - credentials

dvsnReturnShipmentConfigDhlInfo

dvsnReturnShipmentConfigDhlInfo · component

UPS label settings

Activate UPS label

upsLabelStatus · bool · default: false

Should a UPS label be automatically generated for the customer? This is only possible for customers within Germany.

Save label

upsLabelSaveStatus · bool · default: true

Should the UPS label be stored temporarily - or should it be requested anew via the interface with every request? You should only activate this option for test purposes.

Activate multiple labels

upsLabelMultipleStatus · bool · default: false

Can the customer create multiple labels for multiple packages? The customer is informed after downloading the first label that he can create up to five more labels.

Activate log

upsLabelLogStatus · bool · default: false

Should requests to the interface and responses from the interface be logged? translated here

Valid customer groups

upsLabelValidCustomerGroup · component

The UPS label is only displayed for customers in these customer groups. If no customer group is defined, ALL customer groups are valid.

UPS label - credentials

dvsnReturnShipmentConfigUpsInfo

dvsnReturnShipmentConfigUpsInfo · component

Label deadline settings

Activate valid period

labelDeadlineStatus · bool · default: false

If this option is activated, the creation of a return label (DHL or UPS) is only available in a defined period. For example, you can define that labels can be generated a maximum of 21 days after shipment.

Specification of the deadline

labelDeadlineType · single-select · default: period

Options: Period (in days) · Date (as date)

How do you want the deadline to be specified? As a variable period (in days) or a fixed time (as a date)

Period (in days) or date (as date)

labelDeadlineDaysDate · text · default: 30

Period (in days) or time (as date). Note: please specify the date in English format as YYYY-MM-DD - e.g. 2021-12-31 for December 31, 2021.

Order delivery status

labelDeadlineOrderDeliveryStatus · component · default: 298a58594abe4909b218c7a629727d43

The delivery status of the order to check the deadline. Note: a return can only be created if this delivery status has already been set. In addition, the delivery status may be a maximum of x days old - depending on the period specified.