Manual
What stays after the update, and what you check right afterwards.
The plugin is rebuilt from the ground up: a menu of its own, a page per return shipment, a new design in the shop, mails through flows and 16 cards in the configuration. The update takes over return shipments, reasons, procedures, statuses, credentials and settings. After the update the dashboard first opens the window “Much is new”; this page shows what is taken over, what you should check afterwards and what is gone.
In the adminExtensions › My extensions › plugin of the return shipments › Update
Before the update
What you should do before the update
Shop and administration of the return shipments are completely rebuilt; after the update the pages for customers show the design “Modern”. The update itself runs without your help and takes the data over, but some things change for team and customers at once.
So beforehand:
- Test the update in a copy of the shop first, for example a staging environment, especially when your theme changes templates or styles of the return shipment pages. Removed or renamed templates of the storefront show up there.
- Note the roles that work with return shipments and have no administrator rights: they need a new permission after the update.
- Note the statuses of your own that you created next to the delivered ones or renamed: they need type, colour, steps and mail afterwards.
- Check plugins or customisations of your own that use classes of the return shipments: they are renamed and resorted.
What the update takes over
What does the update take over, and what changes with it?
The window “Much is new” sums up what is taken over and what is new. The chapter Setting it up shows the buttons of the window; the table below names every part one by one.
After the update the design “Modern” is active in every shop. The former look is called “Standard” and can be chosen again in the setup assistant or in the configuration, also per sales channel.
Under “More that is new” stands what comes with it: a menu of its own, a page per return shipment, order login without a customer account, labels per parcel, b-stock, mails from flows and the configuration in 16 cards.
| Before the update | after the update |
|---|---|
| return shipments, reasons, procedures, statuses, credentials, settings | stay; no setting is renamed, the values stay |
| comment of the shop | becomes a message to the customer |
| private comment | becomes an internal note; the comment of the customer stays |
| position marked as “put back” | becomes a checked product “Into stock” with “No compensation”, without raising the stock once more |
| approval | every return shipment from before counts as approved at the time it was created |
| reason and procedure at the positions | get the reference to the entry of the list where the text matches exactly one name |
| delivered procedures | get their compensation as long as their name is unchanged; your own and renamed ones start without compensation |
| conditions | the five new ones are added when the list is empty |
| stored labels of DHL and UPS | are deleted; shipping and shipment number stay (next section) |
| logos of DHL and UPS | are created once and entered in the configuration |
What happens to the labels of old return shipments?
The update does not take over the stored label files, it deletes them. Beforehand it reads from them which shipping the return shipment has; the shipment number stays at the return shipment, and tracking keeps working. When a customer needs the label again, he creates a new one on the page of his return shipment.
The page of the return shipment then shows the buttons to create one, for DHL with a QR code and as a label to print.
A chargeable label that was paid stays paid: the link to the order of the label stays, and the customer creates the label without buying again.
The chapter Labels shows how labels come about and what they can cost.
Which settings and functions are gone?
What no longer exists has a successor. The chapter Setting it up shows where the former general settings are now.
| so far | now |
|---|---|
| operator mail with address, subject, text and switch | the flows to the team, to the address of the basic information of Shopware; the update does not take over the old values |
| “Inform customers by mail on creation”, also only for storefront or administration | the flow “Return shipments - Return shipment created - Customer” and in the admin the tick “Inform the customer by mail” |
| search for orders with name and email address or postal code | the login to the order with order number and email address or postal code |
| at DHL customer number (EKP), procedure and participation | no longer needed; the DHL label needs the return receiver |
| switch “May create label” at the status | the status no longer decides about labels, approval and the rules of the label do |
dhlLabelSaveStatus, upsLabelSaveStatus | deleted |
Check right after the update
Why do staff no longer see the menu of the return shipments?
Roles without administrator rights need the new permission Use return shipments (full access) after the update, otherwise the menu is missing for them. Administrators need nothing. The chapter Setting it up shows how to grant it.
The window “Much is new” says it in red, with the way to the permission.
In the role the permission stands in the card “Additional permissions” in the group Return shipments. It opens the whole menu, the tabs at order, product and customer and creating in the admin.
What becomes of statuses of your own, and what do you set?
When the shop had exactly the four delivered statuses unchanged (“Return shipment open”, “Return shipment in progress”, “Return shipment declined”, “Return shipment completed”), they get short names, type, colour, steps and hint and keep their IDs; “Received” is added. Statuses of your own or changed ones stay as they are and become grey open statuses without a mail.
A status of your own, here “Waiting for a spare part”, stands grey as “Open” and sends no mail.
The delivered ones keep their meaning by their ID, also when renamed: “declined” becomes the type “Declined” and is not in the steps, “completed” becomes “Completed”.
“in progress”, “declined” and “completed” get “Send mail to the customer”.
So open every status of your own and set type, colour, steps and mail, as described in the chapter Reasons, procedures, statuses. The update sets the text for the customer only in languages in which the status still has its delivered name and no text.
Which mails go out newly after the update?
Every mail now comes from a flow, and the update switches on the same flows as a new installation. Only “Return shipments - Return shipment created - Customer” stays off when the old setting “Inform customers on creation” was “No” for all sales channels. The mails to the team go to the address of the basic information of Shopware.
New for customers: a mail on every change to a status with “Send mail to the customer” and one for every new label.
New for the team: a mail for every new return shipment and every message of a customer; it replaces the operator mail.
Your template “Return shipment created” to the customer stays as it is. When you changed it, it lacks the sentence for return shipments that wait for approval; add it by hand if needed. The chapter Emails shows everything about flows and templates.
Uninstalling
What does uninstalling delete, and what stays?
On uninstalling, Shopware asks for the switch Remove all app data permanently. Without it everything stays, and a later installation finds the data again; it overwrites neither templates nor number range nor document settings. With it the plugin deletes its data.
- 1
Open Extensions › My extensions and choose Uninstall at the plugin of the return shipments.
- 2
Leave Remove all app data permanently off when you want to keep the data. Switched on, the plugin deletes everything the card “Uninstall” of the configuration names.
- 3
Confirm with Uninstall.
Deleted with the switch:
- every return shipment with positions, messages, history, labels, checks, refunds and replacements
- reasons, procedures, statuses, conditions and checklist, the offers of b-stock and the product hints
- the credentials of DHL and UPS, the custom field “Exclude from return shipments”, the number range and the document type “Return shipments”
- every setting of the plugin
Common questions
Are return shipments lost in the update?
No. Return shipments, reasons, procedures, statuses, credentials and settings stay. Comments become messages or internal notes; the update deletes only the stored label files, the shipment number stays.
Why do staff no longer see the menu after the update?
Roles without administrator rights need the new permission “Use return shipments (full access)” under Settings, System, Users & permissions, Roles, “Additional permissions”.
Do customers get more mails after the update?
Yes, as soon as the flows run: on a change to a status with “Send mail to the customer” and for every new label. The team gets mails for every new return shipment and every message of a customer. Check the flows right after the update.
What happens to the labels of old return shipments?
The update deletes the label files; shipping and shipment number stay. When the customer still needs the label, he creates a new one on the page of his return shipment, a paid chargeable one without buying again.
Can I keep the former look in the shop?
Yes. It is called “Standard” now and can be chosen in the first step of the setup assistant or in the configuration in the card “Pages for customers”, also per sales channel.
What happens to my own statuses?
They stay as they are and become grey open statuses without a mail to the customer. Set type, colour, steps and mail right after the update.
Do my changed mail templates stay?
Yes. The update only creates templates that are missing and changes none that exists.
What does uninstalling delete?
Only with “Remove all app data permanently” the plugin deletes its data: return shipments, lists, credentials, the custom field, the number range and the settings. Mail templates, flows, logos and files of the customers stay.
More chapters