Manual
Setting it up in nine steps, before the first return arrives.
After installation the dashboard of the return shipments opens a setup assistant. In nine steps you decide how the pages for customers look, who may send back and until when, what the form asks, whether photos belong to it, whether you approve first, which labels there are, which mails run and whether you sell b-stock. Every step saves with “Next”, for all sales channels.
In the adminOrders › Return shipments › side menu System › Setup assistant
Before you start
Install the plugin and find the menu “Return shipments”
The plugin comes from the Shopware Store and is installed and activated like any plugin. Afterwards the main menu shows Return shipments under Orders. It opens the dashboard; every page has the same side menu on the left with the groups Overview, Return shipments, Product hints, Processes, Shipping and System.
- 1
Open Extensions › My extensions, install the return shipments plugin and activate it.
- 2
Open Orders › Return shipments. The dashboard is the first entry of the side menu.
- 3
As long as there is no return shipment, every task is done, and “Latest return shipments” says how the first one comes about: in the shop by the customer or in the admin with Create return shipment.
One permission for everyone who works with return shipments
Administrators need nothing more. Roles without administrator rights get a permission of their own: it opens the whole menu of the return shipments, the tabs “Return shipments” at order, product and customer, and creating in the admin. Without it the menu entry is missing.
- 1
Open Settings › System › Users & permissions, choose the role under Roles and stay in the tab General.
- 2
In the card Additional permissions, group Return shipments, switch on Use return shipments (full access) and save.
When the assistant opens
The assistant opens on the first visit of the dashboard
The first time the dashboard opens, the assistant starts by itself, as long as it is neither finished nor skipped. If there are return shipments already, after an update for example, the window “Much is new” comes first.
The intro says what the nine steps set. It saves for all sales channels; everything can be changed later in the configuration, also per sales channel.
Let's go starts with step 1.
Start without assistant closes the window; afterwards the assistant no longer opens by itself. The cross at the top right only means “later”: the next time the dashboard opens, the intro comes back.
Later you open the assistant at any time through the side menu System › Setup assistant, also from another page; it then opens on the dashboard.
After an update “Much is new” comes first
In shops that already have return shipments, the dashboard opens a window with what has changed before the assistant. What exactly is taken over and what you should check afterwards is in the chapter Update.
Return shipments, reasons, procedures, statuses, credentials and settings are taken over.
From the update on, the pages for customers show the design “Modern”. The former look is called “Standard” and can be chosen again in the first step of the assistant, also per sales channel.
Roles without administrator rights only see the menu again with the permission Use return shipments (full access); the window says so in red.
Start setup assistant opens the assistant at step 1, without the intro. Close ends the window; the assistant then no longer opens by itself.
The nine steps of the assistant
1. Design: how the pages for customers look
The list in the customer account, the form and the page of each return shipment come in two designs. Way and fields are the same in both; switching is possible at any time, also per sales channel. The chapter Designs shows both side by side.
Modern is the default: a coloured head with a gradient, steps that show the customer the state of the return shipment, and cards with symbols, in the colours of the theme.
Standard looks like the other account pages of Shopware: plain boxes and tables without a coloured head.
2. Conditions: which orders can go back
An order offers a return shipment in the shop only when it meets all three. Without a choice each means: all. More in the chapter Who may return.
Order states: with none switched on, every state applies. Otherwise only orders in one of the states switched on can go back, for example only “In progress” and “Done”. It is checked when the order is opened and when the return shipment is sent.
Customer groups: only customers of the customer groups switched on create return shipments, for example not the dealers.
Countries: the billing or the delivery address is in one of the countries chosen; one of the two is enough.
In the admin a return shipment can be created for any order, also when a condition does not fit; a notice then says so. Requirements for single products are in the configuration in the card “Requirements for products (Twig)”.
3. Deadline: until when customers create a return shipment
Without a deadline a return shipment is always possible. With a deadline the time starts when the first delivery reaches the delivery status chosen, usually “Shipped”, not with the order. Everything on the deadline and on the deadline of its own for labels is in the chapter Deadlines.
Activate valid period: when on, a return shipment is possible only once the first delivery has reached the delivery status, and only until the end of the deadline. By default the deadline is off.
Period (in days): every order has a deadline of its own, for example 30 days after shipping. Date (as date): a fixed last day for every order, for example for a promotion at the end of the year.
Order delivery status and Days: from which status of the first delivery the deadline counts and how many days it runs. With a date, the last day stands here; it applies until the end of that day.
4. Form: what the customer states per product
Per product the customer chooses pieces and reason. You switch two parts of the form on or off here. Below, the step shows which reasons, procedures and questions of the checklist exist already.
Ask for the procedure: per product the customer chooses what he wishes for, for example a credit or a replacement delivery; at the check it preselects the compensation. On by default.
Have the checklist confirmed: before sending, the customer confirms every question of the checklist in the section “Confirmation”. Off by default.
Already created: without a reason no return shipment can be created. You maintain reasons, procedures and checklist under Processes, per reason also with photos and comment required; the chapter Lists shows how.
5. Photos and files: the damage in the picture right away
Whether the customer attaches photos or files per product is decided by the reason: none, optional or required. The step shows this for every reason and switches on files at messages.
At products, per reason: the mark at every reason says whether it shows a field for photos and files. You change it at the reason under Processes › Reasons; largest file and allowed file types are in the configuration in the card “Photos and files”.
Allow files at messages: customer and shop add up to three photos or files to every message. Off by default.
6. Approval: check first, then return document and label
With the manual approval a new return shipment waits until your team approves it in the admin; until then the customer sees that it is being checked. The chapter Approval shows how approving works.
Never is the default: every return shipment gets return document and label right away.
Always: every new return shipment from the shop and the store API waits for “Approve” in the admin; then the mail “Return shipment approved” goes to the customer.
Only when a condition applies: only return shipments one of the conditions below applies to wait: a rule of the Rule Builder, certain reasons, procedures or shipping ways.
One condition met is enough; it is checked once on creation. Further conditions, for example from which return shipment of a customer on, are in the configuration in the card “Manual approval”.
7. Shipping and labels: DHL, UPS or shipping it yourself
Here you choose which labels customers can get when they create a return shipment; “Own shipping” is always possible. A label needs credentials. The chapters DHL label and UPS label show how to enter them.
DHL: return label with a QR code. The customer prints the label or shows the QR code at a DHL branch, where it is printed. With DHL the step also switches on the QR code.
UPS: return label to print, handed in at a UPS Access Point.
No label without credentials: one record per country of the delivery address under Shipping › DHL or UPS. Customer groups, minimum value, deadline and chargeable label are in the configuration.
8. Mails: which flows are running already
Every mail of the return shipments comes from a flow. The step shows the flows of the shop and whether they are active; they are switched on and off in the Flow Builder. The chapter Emails shows templates and recipients.
The plugin brings ten flows, nine of them active: to the customer on creation, on approval, on a change of status, with every label, on a message of the shop and on the refund, to the team on a new return shipment and on a message of the customer.
“Return shipments - Products checked - Team” is off by default. If your team wants a mail after every check, switch the flow on in the Flow Builder.
Whether the customer gets a mail for a change of status is set at the status under Processes › Statuses. This step saves nothing.
9. B-stock: sell returns next to the new goods
Checked return shipments can be sold again with a condition and a price of their own; the shop then shows a box “B-stock” in the buy box. The chapter B-stock shows how offers come about.
Offer b-stock in the shop: the box stands below the new goods as soon as there is an offer. Off: no b-stock in the shop, existing offers stay stored. Off by default.
Leave b-stock out of promotions: when on, discounts of promotions do not apply to b-stock, which is cheaper already.
Offers come from the check: a product gets the choice “As b-stock” under “Resell”, then “Create b-stock” at the return shipment creates the offer.
Finish completes the assistant.
Done: what the assistant suggests afterwards
At the end the assistant shows where to go on. From now on the dashboard shows what there is to do with the return shipments.
To the dashboard: open tasks, return shipments by status and the key figures of the period.
Check the reasons: the reasons are the first question of the form; per reason photos or a comment can be required.
Adjust the statuses: the steps customer and team see, with colour, text for the customer and mail per status.
To the configuration: all settings in 16 cards, also per sales channel.
Only in the configuration
These settings are not asked by the assistant
The assistant asks what matters most. Some settings are only in the configuration, which you open through the side menu System › Settings. The chapter Every setting shows all 56 settings.
Where to find them in the configuration (Orders › Return shipments › side menu System › Settings):
Card General › Offer return shipmentsSwitches return shipments in this sales channel on or off. Off: no entry "Return shipments" in the customer account, no button at the order, and customers can create no return shipment, neither in the shop nor via the store API. The administration can still create return shipments, with a notice.
Card Requirements for orders › Allow a maximum of one return shipment per orderIf activated, a customer can create only one return shipment per order in the storefront. As soon as a return shipment exists for an order, no further one can be created there, regardless of the status of the existing return shipment and regardless of whether returnable products are still open. Return shipments created in the administration are not restricted by this.
Card Return document and emails › Attachments of the mail on creationWhat goes with the mail "return shipment created" to the customer; while the return shipment waits for the approval, it goes with the mail "return shipment approved" instead. Labels only when the carrier is switched on and the customer gets a label right now. When approving in the administration, the tick "Attach label" decides about the labels, preselected following this setting. Created in the administration, labels only come with their own mail.
Card Manual approval › Number of returns of the customerApplies when the customer has this many return shipments in the period below, the new one counted; with 3 from the third one on. Empty or 0: not checked.
Also only in the configuration:
- largest file in MB and allowed file types, card “Photos and files”
- a deadline of its own for labels, card “Deadline for labels”
- customer groups, minimum value, several labels per return shipment, logo and log of the requests, cards “DHL” and “UPS”
- “Open for long from days” and the thresholds of the product hints, card “Dashboard and product hints”
What became of the eight general settings
There used to be eight general settings on one card. Seven still exist, with clearer names in the card they belong to; the order search is gone. The stored values are kept.
| Before | Now |
|---|---|
| Activate plugin | card “General” › “Offer return shipments” |
| Activate procedures | card “Creating a return shipment” › “Ask for the procedure”, also in the assistant, step 4 |
| Activate checklist | card “Creating a return shipment” › “Have the checklist confirmed”, also in the assistant, step 4 |
| Output Label API error messages | card “Labels” › “Show the error message of the carrier” |
| Provide note to print document | card “Return document and emails” › “Remind of the return document before the label” |
| Show notice on the product page of a chargeable label | card “Labels”, same name |
| Number in the subject line of the return document | card “Return document and emails”, same name |
| Activate order search | gone; guests log in to the order with order number and email address or postal code |
Afterwards
What comes after the assistant
The return shipments are running now. Customers find them in the customer account under “Return shipments”, guests through the login to the order. These chapters lead on:
- Lists: adjust reasons, procedures, statuses, conditions and checklist.
- DHL label and UPS label: enter and check the credentials per country and sales channel.
- Emails: flows, templates and recipients.
- How the customer gets in: link the page “Returns” for guests, in the footer for example.
- Every setting: every field of the configuration.
Common questions
How long does it take to set up the return shipments?
The setup assistant has nine steps and shows in each what applies right now; the defaults suit most shops. If you take them, you are done in a few minutes. For labels the credentials of DHL or UPS come afterwards.
Does the assistant save only at the end?
No. Every step saves its settings with “Next”, for all sales channels. If you end the assistant halfway, you keep what has been saved by then.
Does the assistant apply to all sales channels?
Yes. It saves for “All Sales Channels”. Values that a single sales channel has of its own in the configuration stay there.
Can I open the assistant again later?
Yes, through the side menu “System”, “Setup assistant”, also from another page. It then opens on the dashboard and shows the current settings.
Which permission does an admin user need?
Roles without administrator rights need the permission “Use return shipments (full access)” under “Additional permissions”. Without it the menu of the return shipments is missing. Administrators do not need it.
Do I need anything else for return labels?
Yes. The assistant switches on DHL or UPS, but a label needs credentials: one record per country of the delivery address under “Shipping”, “DHL” or “UPS”.
What does the assistant not ask?
For example “Offer return shipments”, “Allow a maximum of one return shipment per order”, the attachments of the mail on creation, size and types of files, the number of returns of a customer for the approval, the deadline for labels, minimum values, logos and the log of the requests. Everything is in the configuration, described on shop-retoure.de/en/manual/settings/.
More chapters