Skip to main content

Shopware 5

How connect Shopware 5 to adtribute.

Daniel Busch avatar
Written by Daniel Busch
Updated over 5 months ago

You need to follow these steps for each shop you wish to connect:

Create New Shopware 5 Connection

  1. Go to the Adribute app.

  2. Navigate to "Connections".

  3. Click on "Create Connection" in the top right corner.

  4. Search for the Shopware 5 connection and select it.

  5. Fill in your Shopware URL, which simply is your Store URL, e.g. https://adtribute.shop.com/

    1. If your store is not hosted by your customer-facing URL, please use the URL which your domain is hosted on. You can find your domains here: "Configuration" > "Basic settings" > "Shop settings" > "Shops", then use the according domain.

Now you need your User ID and API Key from Shopware.

Retrieve User ID and API Key from Shopware

You have to create an API user with the right permissions. First, you have to create a Role with the needed permissions.

Create Role and grant Permissions:

  1. Open Shopware.

  2. Navigate to "Settings" > "User administration" > "Roles".

  3. Cick on "Add role".

  4. Name it "adtribute" and create it.

  5. Now, go to the "Ressources & permissions" tab.

  6. Select the "adtribute" role in the dropdown and select the following permissions:

    • article (read)

    • order (read)

  7. Save the role with those permissions and proceed.

Create API user:

  1. Now, within the "User administration" Tab go to "User Management".

  2. Click on "Add user".

  3. Name the user "adtribute"

  4. Enable API access (click checkmark).

  5. Select the "adtribute" role.

  6. The rest of the settings like password and email, you can simply fill out as you wish and save for yourself.

  7. Copy the generated API Key (save it on your device) and save the user.

  8. Paste the API Key in the according field in adtribute.

  9. For the User ID fill in the name for the User you have created in Shopware.

Complete Connection

After you have filled out the URL and User ID and pasted the API Key (and saved the User in Shopware) just click on "Next". It will load for a short bit and tell you on the bottom right if the Connection was successful and show up within your Connections.

You have to repeat those steps for every Shopware store, you wish to connect.

Did this answer your question?