User Guide for UnoPim Shopware 6 Connector

UnoPim Shopware 6 Connector enables the user to easily connect their Shopware store(s) with UnoPim product information management platform.

It centralizes the management of product data. Users have the ability to connect several Shopware stores to export products, categories, category fields, and variations.

Additionally, they can export SEO information.This connector allows for precise control over data exports by using store instance and channel filters.

It also enables the mapping of custom fields and the export of products from UnoPim to your Shopware 6 stores.

With its support for various languages, the connector ensures that your data remains consistent.

Apart from this. the UnoPim Shopify Connector is also available which enables to connect Shopify with UnoPim.

• Users have the ability to export categories, products, and configurable items from UnoPim to Shopware 6.
• During the export process, users can choose to add SEO information along with the products.
• Users can select specific data to export based on the Shopware 6 store and the product export channel.
• Users can align product attributes between Shopware 6 and UnoPim.
• The UnoPim connector for Shopware 6 supports multiple languages.
• User can add multiple Shopware 6 store credentials in the connector.
• A Dedicated job is included in the connector to Export Tags to Shopware 6.

Download and extract the extension package.

Merge the packages folder into the root directory of your UnoPim project.

Install the Bulk API at Shopware End

On your Shopware Instance, Go to “My Extensions” and then “Upload Extension” and add the zip file provided for shopware bulk API.

Register the Package Provider

Open the config/app.php file and add the following line under the providers array:

• Webkul\Shopware\Providers\ShopwareServiceProvider::class,

Open the composer.json file and add the following line under the psr-4 section:

• “Webkul\Shopware\”: “packages/Webkul/Shopware/src”,

Run Setup Commands

Execute the following commands to complete the setup:

composer dump-autoload

php artisan shopware-package:install

php artisan optimize:clear

After the installation, user needs to upload the extension at their Shopware 6 store to be successfully be able to perform the jobs between UnoPim and Shopware 6.

Initially, user logs on to their Shopware 6 store backend and navigates to Extension > My Extensions as per the below image,

Next, User taps on Upload Extension button and uploads the extension zip file. Once that is done, the user is able to view the extension in the list and clicks on the install icon to install it.

After successfull installation, the extension will be visible for user to enable or disable as per below image,

Admin generates API keys from the Admin backend. For this, the admin navigates to Setting> System > Integration as per the below image,

Now, tap on Integration and then click on Add Integration to create new API Keys,

After clicking on Add Integrtaion, a pop up is displayed, in which API Name and Role is to be entered,

Copy the Access Key ID and Secret Access Key and then tap on Save Integration.

Once the UnoPim Shopware 6 Connector is installed, it will be visible on the left hand side of UnoPim as per below image,

Next, user taps on Shopware to start setting up the credentials and configure the connector. They navigate to Shopware>Credentials>Create.

Next, Tap on the Save button to save the credentials. The User can add as many credentials as they want. It is as below,

Once added, the User proceeds to configure the added credentials. They can Edit or Delete credentials accordingly. For editing, they tap on the Edit icon,

Here, User can enable or disable the Status of the credential as well as perform Currency Mapping. They can also set the Media Folder ID in which media will be exported in Shopware 6.

To get the Media Folder ID, users logs on their Shopware 6 store backend and then naviagate to Content > Media and the required media folder. Next, they get the folder ID from URL as per below,

User will also map the locales from the Locale Mapping option in this section as per the image below,

For the next step, User proceeds for mapping of attributes between fields in Shopware 6 and UnoPim fields.

For mapping, they tap on Attribute Mapping. Here, several fields are available for mapping.

User can map the Shopware Field with the UnoPim field as well as set the Default value for the mapping.

• Name – The product’s title or name shown in the store.
• Tax ID – Identifies the tax class applied to the product.
• Product Number – A unique identifier (SKU) for the product.
• Net Price – The product price excluding taxes.
• Gross Price – The product price including taxes.
• Stock Quantity – The available number of product units in inventory.
• Delivery Time – The expected time it takes to deliver the product.
• Unit ID – The unit type for the product (e.g., piece, kg, liter).
• Manufacturer ID – ID linking the product to its manufacturer.
• Sales Channel Visibility – Controls product visibility across different sales channels.
• List Price (Net) – Original price before any discount (excluding tax).
• List Price (Gross) – Original price before any discount (including tax).
• Purchase Price (Net) – Price the store pays for the product, excluding tax.
• Purchase Price (Gross) – Price the store pays for the product, including tax.
• Regulation Price (Net) – Discounted or adjusted price without tax.
• Regulation Price (Gross) – Discounted or adjusted price including tax.

More Fields

• Free Shipping – Marks whether the product qualifies for free shipping.
• Pack Unit – Describes packaging type or quantity (e.g., pack of 6).
• Closeout Status – Indicates if the product is being phased out or discontinued.
• Meta Description – Short SEO description shown in search engine results.
• Description – Detailed description of the product.
• Keywords – SEO keywords to help customers find the product.
• Meta Title – Custom title for SEO and browser tabs.
• Mark as Top Seller – Tags the product as a best-seller.
• Release Date – Date when the product becomes available for sale.
• Reference Unit – The base unit for comparison in pricing (e.g., per 100g).
• Minimum Purchase Quantity – Smallest quantity a customer must buy.
• Maximum Purchase Quantity – Maximum quantity allowed per purchase.
• Product Length – Physical length of the product for shipping calculations.
• Purchase Unit – The unit customers buy the product in (e.g., 1 liter, 1 box).
• Length – May represent another dimension for product size.
• Height – Vertical dimension of the product for shipping purposes.

To get the Default Value of attributes from Shopware 6 end, User navigates to Settings. Let’s check below the process,

Tax ID

Now, for example, they require to set the default value of attribute Tax ID, they tap on Tax and click on required attribute. From here, they can the Default Value from the URL as seen in below image,

Delivery Time ID

To get Delivery Time ID, user navigates to Settings>Delivery Times and then tap on a particular delivery time attribute to get the ID as per image below,

Unit ID

To get Unit ID, user navigates to Settings>Scale Units and then tap on a particular unit attribute to get the ID as per image below,

Manufacturer ID

To get Manufacturer ID, user navigates to Catalogues>Manufacturer and then tap on a particular manufacturer to get the ID as per image below,

Sales Channel Visibility

To get Sales Channel Visibility default value, user navigates to Sales Channel and then taps on a particular Sales Channel to get the ID as per image below,

Apart from this, the connector also allows to map Additional Standard Attributes to system fields. Here User enters the Field Code and maps it to the type of attribute required in UnoPim.

Custom Field Mapping

In this section, Users add the Shopware Field Code and then can map them with UnoPim fields. It is visible in below image,

Custom Field in Shopware 6

Shopware 6 provides a flexible and powerful feature called “Custom Fields” that allows you to extend and customize the data structure of your store.

Custom Fields enable you to add additional data fields to various entities in Shopware, such as products, categories, customers, orders, etc.

This feature provides you with the ability to tailor your store to specific business requirements without modifying the core codebase.

How to create a custom field in Shopware 6 for Product.

In Shopware 6, you must carry out the subsequent actions to add a custom field to a product.

1. Create a custom field using the steps mentioned in the previous response.
2. Access the Shopware 6 administration and navigate to “Settings” -> “System” -> “Custom fields” -> “Product”.
3. Click on “Add field” to create a new custom field assignment.
4. Fill in the necessary details for the custom field assignment:
   • Entity: Choose “Product” from the dropdown menu.
   • Field: Select the custom field you created in the previous steps.
   • Position: Define the position of the custom field in the product details.
5. Save the custom field assignment.

Remember to clear the cache after making changes to ensure the changes take effect.

You can do this by navigating to “Settings” -> “System” -> “Caches & Indexes” and clicking on the “Clear cache” button.

With these steps, you have successfully assigned a custom field to a product in Shopware 6.

Visibility of custom field On Product pages.

On Shopware 6’s product detail page, the custom field needs to be displayed. In the “Custom fields” section of the corresponding product, you can add or modify values for the custom field.

You can do this by navigating to Catalogue > Products > Specification > Custom fields which is visible in image below,

Other Mapping

Under the Other Mapping section, Users map the following type of attributes,

• Attributes to be used as Image.
• Attribute to be used as Cover Image.
• Attributes to be used as Product Properties.
• Attributes to be used as Tags.
• Display in Listing Attributes.

Category Field Mapping

This section allows Users to do the mapping for Category Fields. Once the user taps on Category Field Mapping, they’ll be able to map the following Shopware fields with UnoPim Category fields,

• Name
• Description
• Meta Title
• Active
• Meta Description
• Keywords
• Visible

The UnoPim Shopware 6 Connector allows users to export the mapped data from UnoPim to their Shopware 6 store through dedicated export jobs.

To setup Export jobs, user navigates to Data Transfer>Exports as per the below image,

To create a new Export job, User taps on Create Export button situated on the top right corner. Next, they’ll fill out the export job Code and select the Type of Export Job from dropdown menu.

Additionally, for a Product Export Job, User has to set the following filters as per requirement,

• Shopware Credential – Select the required Shopware store credential.
• Channel – Select the Channel for exporting.
• Indexing Behaviour – Select the indexing behaviour as synchronous, asynchronous or disable indexing.

After filling out the details, tap on Save Export to create and save the export Job.

Now, once the User runs an Export Job, they are able to view the progress from the Job Tracker which is displayed as per below image.

From here, user can Download Log as well as Edit the Export Job as well.

Once the products are exported, the list is available to see at the Shopware 6 store end as well. Below is the list of exported products,

The following types of Export Job are available in the connector,

Let’s check below the list of export jobs for the connector and configurations available for them as well,

• Shopware Attribute Options

• Shopware Configurable Products

• Shopware Simple Products and Variants

So that is it for the UnoPim Shopware 6 Connector and its functionalities.

If you have any more queries or require further assistance, please email us on [email protected] or create a ticket.