# Shopware (prebuilt connector)

## Description

**Shopware** is an integrated tool for marketing and creating online shops.

## API documentation

API documentation for Shopware (used to build this connector) can be found via the link below:

<https://developers.shopware.com/developers-guide/rest-api/>

## Authentication&#x20;

When adding connector instances for Shopware, the following authentication methods are supported:

* [OAuth 2 (client credentials)](#oauth-2-authorisation-code)

### OAuth 2 (client credentials)

{% tabs %}
{% tab title="Credentials" %}
When a user chooses to [add a connector instance](/product-documentation/connectors-and-instances/working-with-instances/adding-an-instance.md) using **OAuth 2 (client credentials)** authentication, the credentials below are prompted:

<table><thead><tr><th>Credential</th><th data-type="checkbox">Required?</th><th>Notes</th></tr></thead><tbody><tr><td><code>Username</code></td><td>true</td><td>Your Shopware admin username.</td></tr><tr><td><code>Password</code></td><td>true</td><td>Your Shopware admin password.</td></tr><tr><td><code>Scope</code></td><td>true</td><td>The required scope to define what access permissions should be given to Patchworks. Typically set to <code>write</code>.</td></tr><tr><td><code>Client ID</code></td><td>true</td><td>Always set to <code>administration</code>.</td></tr><tr><td><code>Client Secret</code></td><td>true</td><td>This is the <code>secret access key</code> that's generated when you add an integration to Shopware (so in this case, when you add a Patchworks integration). </td></tr><tr><td><code>Store URL</code></td><td>true</td><td>The URL used to access your Shopware store without the https// element. For example: <a href="https://patchworks-vkhliupko.shopware-demo.net/pwa-beauty"><code>https://patchworks-vkhliupko.shopware-demo.net/pwa-beauty</code></a> would be entered as <a href="https://patchworks-vkhliupko.shopware-demo.net/pwa-beauty"><code>patchworks-vkhliupko.shopware-demo.net/pwa-beauty</code></a></td></tr><tr><td><code>Grant type</code></td><td>true</td><td>Set to <code>password</code>.</td></tr><tr><td><code>Response authentication token key</code></td><td>true</td><td>Set to <code>access_token.</code></td></tr></tbody></table>
{% endtab %}

{% tab title="Obtaining credentials" %}
**Username & password**

Provided when you create a Shopware account.

**Client secret**

When you add an integration to Shopware, a **secret access key** is created - this is your **client secret**.

![](/files/4wUoInzHwP8Y8I47deta)
{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.wearepatchworks.com/product-documentation/connectors-and-instances/patchworks-connectors/shopware-prebuilt-connector.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.