Shopware 6
By connecting a Shopware 6 web store to Returnless, you can easily set up a return form for your Shopware web store. Returns that are created can then be easily, automatically processed. The connection also makes it possible to process coupons and refunds.
The Shopware 6 integration has these features:
| Feature | Available |
|---|---|
| Search order | ✅ |
| Create coupon | ✅ |
| Create refund | ✅ * |
| Create gift card | ❌ |
| Create return | ✅ ** |
| Return importer | ❌ |
* Refunds are only available with a Shopware Rise or higher subscription plan. Please consult with your payment service provider (PSP) if they support the native Shopware refund feature.
These PSP's have confirmed that they support this feature: Adyen and Pay (plugin v1.6.9 or higher).
Mollie (plugin v4.15.0 or higher) claims to have implemented a working solution, but so far we have not been able to confirm this.
These PSP's have confirmed that they are working on supporting this feature: MultiSafePay.
** Creating returns is only available with a Shopware Rise or higher subscription plan.
Installation
The connection is set up via the Shopware 6 REST API. There is no need to install a Shopware extension.
Detailed technical information
Returnless is built on top of the core functionalities of Shopware, using their API. Therefore, no customizations or complex integrations are necessary. And the integration will be very future proof.
We use these functionalities of Shopware:
- Search sales orders, items and products for the order which the consumer is searching for in the form (so we will not collect all your order data, only the order that is being requested by your customer).
- Generate discount coupons from the Returnless panel (which can be promoted by offering free returns for example). For this we use the Promotion Discount in Shopware.
- Create refunds from the Returnless panel to do a (partial) refund of an order. This refund will do two things:
- We will create a refund of the order, with the amount that you specified in Returnless (based on the items returned). This will create a negative / credit amount on the order in Shopware. Based on your Payment Service Provider (PSP) this will also trigger the real money refund to your customer.
- If you use shopware 6.4.12 or higher, we can also assign the refund to the specific order items in Shopware. This way you know which part of the refund was for which item in the order.
- Please note: Shopware currently does not offer a "real" returns endpoint and therefor we can not restock any items at this moment. If this becomes available in the future we will of course extend this in our software. Best practice at this moment would be to open the order in Shopware, go to the item you want to restock and update the stock directly in Shopware. A link to the Shopware order page is available in Returnless.
Creating permissions on Shopware
The first step to preparing the integration is to create a role and permissions for the integration to interract with your Shopware account.
To do so, in your Shopware Panel:
- Go to Settings > System > Users and Permissions.
- Choose create role.
- Name the role Returnless.
- In the general tab, assign the following permissions:
| Category | Permission | Rights |
|---|---|---|
| Catalogs | Categories | View |
| Catalogs | Dynamic Product groups | View |
| Catalogs | Manufacturers | View |
| Catalogs | Products | View |
| Catalogs | Properties | View |
| Content | Media | View |
| Customers | Customers | View |
| Orders | Orders | View |
| Orders | Refunds | View, Edit, Create, Delete, All |
| Settings | Countries | View |
| Settings | Delivery Times | View |
| Settings | Payment Methods | View |
| Settings | Tax | View |
- In the detailed privileges tabs:
| Permissions | Rights |
|---|---|
| acl_role | read |
| acl_user_role | read |
| document | read |
| document_type | read |
| integration | read |
| promotion | create |
| promotion_discount | create |
| promotion_persona_rule | create |
| promotion_sales_channel | create |
| rule | create |
| rule_condition | create |
| state_machine | read |
| state_machine_history | read |
| state_machine_transition | read |
| tax_provider | read |
- Press save to save the role.
Permissions for the create refund action (Shopware Rise edition only)
Please make sure you've installed and enabled the Shopware Commercial extension.
| Permissions | Rights |
|---|---|
| order_return | read, create, delete, update |
| order_return_line_item | read, create, delete, update |
| order_return_line_item_reason | read, create, delete, update |
| order_return_line_item_reason_translation | read, create, delete, update |
| order_line_item | read, update |
In case the create refund action fails with these permissions, apply the 'admin' role as a workaround.
Creating an integration on Shopware
Before integrating to returnless, you need to create an integration within the Shopware backend. To do this, we will be following this documentation
- Go to Settings > System > Integrations in your Shopware Panel
- Click on Create integration
- Use the previously created returnless role.
- You will be given an Access Key ID as well as an Access Secret, save these two as you will need them for next step.
Setting up the integration on Returnless
To create a new integration between Returnless and Shopware 6, follow these steps:
- Login to your return panel
- Navigate to the Settings > Integrations page where you will find the E-commerce platform section.
- To add a new integration, select the Add new integration button.
- Select the Shopware 6 integration. A modal will open with further instructions to finish the installation. In the model, you will be asked for a Base URL. This URL is the URL of the shop (example: www.mywebsite.com ).
Once the integration is activated, Returnless will verify the that it has all the necessary permissions.
Activating the integration
To activate the integration, you will need to enable the integration in a return form. Follow these steps:
- Login to your Return panel
- Navigate to Settings > Return forms and open the applicable return form.
- Go to the Integrations tab and select the Shopware 6 which you've added in the previous step.
Settings
- Login to your return panel
- Navigate to the Settings > Integrations page where you will find the E-commerce platform section.
- Click the Settings button at the appropiate Shopware 6 integration. Here you will find the settings for the integration.
Attributes
Here you can decide which custom attributes you would like displayed. If the value is empty, all attributes will be shown. Else, enter a comma separated list of custom attribute keys to filter them for display.