How to connect to Shopware

Create an API role

1. Go to Settings → System → Users & Permissions → Roles.

2. Select Create new role.

You can select All (View/Edit/Create/Delete) for these entities and save the role afterwards.

Create an API user

1. Navigate to Settings > System > Users & Permissions > Users and select “Create new user”.

2. Fill in the basic details and make sure Administrator (8) is not enabled (because users set as administrators have all permissions and no roles can be assigned).

3. Under Roles (10), select the role you created in the previous step.

Create integration

1. Go to Settings > System > Integrations.

2. Click Add integration.

3. Enter the Name.

4. Select the Role created in the previous step.

5. Copy and note down the Access key ID and Secret access key – they will be displayed only once. These keys will be used later for the Vault configuration.

Authorize the connection in Vault

How to find the shop domain

1. In the sidebar, go to Settings → System → Sales Channels.

2. Click the sales channel you’re interested in (e.g., “Storefront”).

3. In the channel’s detail view, switch to the “Domains” tab to see the domain entries.

Note:

Client ID and Client Secret are the Access key ID and Secret access key you obtained in the previous step when creating the integration.