> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/shopware.md).

# Shopware

Connect to a Shopware shop's Admin API to manage products, orders, deliveries, and customers.

## Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Shopware  | Credentials    |

### Shopware

Connect to a Shopware shop's Admin API with an Integration's Access Key ID and Secret Access Key (Admin > Settings > System > Integrations) to manage products, orders, deliveries, and customers. The Integration must be granted the 'Administrator' role, or a custom access role with the privileges this connection needs.

#### Set up in Shopware

1. Prepare the Shopware account or service that the workflow will access. Grant access to the required resources and operations.
2. **Shop URL:** The origin (scheme and host) of your Shopware shop, e.g. '<https://your-shop.example.com>'. The Admin API is exposed under its /api path automatically.
3. **Access Key ID:** The Access Key ID of a Shopware Integration. Create one under Admin > Settings > System > Integrations; grant it the 'Administrator' role, or a custom access role with the privileges this connection needs.
4. **Secret Access Key:** The Secret Access Key shown once when the Integration was created.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **Shopware**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field     | Required | What to enter                                                                                                                                                                                                                                              |
| ----------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Shop URL          | Yes      | The origin (scheme and host) of your Shopware shop, e.g. '<https://your-shop.example.com>'. The Admin API is exposed under its /api path automatically. [Provider instructions](https://docs.shopware.com/en/shopware-6-en/settings/system/integrationen). |
| Access Key ID     | Yes      | The Access Key ID of a Shopware Integration. Create one under Admin > Settings > System > Integrations; grant it the 'Administrator' role, or a custom access role with the privileges this connection needs.                                              |
| Secret Access Key | Yes      | The Secret Access Key shown once when the Integration was created.                                                                                                                                                                                         |

### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

## Use an action

1. Add the required **Shopware** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

## Actions

### Create Product

Add a new product to your Shopware catalog with a name, SKU, price, and stock.

#### Inputs

| Field                | Type            | Required | Description                                                                                                                                           |
| -------------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| Name                 | string          | Yes      | The name of the product as it will appear in your catalog.                                                                                            |
| Product Number (SKU) | string          | Yes      | A unique SKU or product number for this product.                                                                                                      |
| Price                | number          | Yes      | The product's gross (tax-included) selling price.                                                                                                     |
| Stock                | integer         | Yes      | The initial number of units in stock. Default: 0.                                                                                                     |
| Tax Rate             | select (string) | No       | The tax rate applied to this product. Uses the shop's standard tax rate when left blank. Options load from the selected connection.                   |
| Active               | boolean         | No       | Whether the product is visible in your storefront. Default: true.                                                                                     |
| Sales Channel        | select (string) | No       | The storefront the product is made visible in. Uses the shop's first active sales channel when left blank. Options load from the selected connection. |
| Description          | textarea        | No       | Optional description shown on the product detail page.                                                                                                |

#### Outputs

| Field          | Type   | Description                                |
| -------------- | ------ | ------------------------------------------ |
| Product ID     | string | Unique ID of the created product.          |
| Product Number | string | SKU/product number of the created product. |
| Name           | string | Name of the created product.               |

### Update Stock

Set a product's available stock to a new value.

#### Inputs

| Field   | Type            | Required | Description                                                                   |
| ------- | --------------- | -------- | ----------------------------------------------------------------------------- |
| Product | select (string) | Yes      | The product whose stock to update. Options load from the selected connection. |
| Stock   | integer         | Yes      | Set a product's available stock to a new value.                               |

#### Outputs

| Field      | Type    | Description                    |
| ---------- | ------- | ------------------------------ |
| Product ID | string  | ID of the updated product.     |
| Stock      | integer | The product's new stock level. |

### Search Products

Find products in your catalog by name or SKU.

#### Inputs

| Field           | Type    | Required | Description                                                   |
| --------------- | ------- | -------- | ------------------------------------------------------------- |
| Search          | string  | No       | Find products by name or SKU.                                 |
| Max results     | integer | No       | Maximum number of products to return (1-100). Defaults to 25. |
| Page (advanced) | integer | No       | Page number to fetch. Leave blank for the first page.         |

#### Outputs

| Field         | Type          | Description                                       |
| ------------- | ------------- | ------------------------------------------------- |
| Products      | object\_array | The matching products.                            |
| Total matches | integer       | Total number of products matching the search.     |
| Next page     | integer       | Page number for the next page of results, if any. |

### Search Orders

Find orders by number, customer email, or order status to triage and report on orders.

#### Inputs

| Field                     | Type            | Required | Description                                                                                                                                                   |
| ------------------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Search                    | string          | No       | Find orders by a free-text query.                                                                                                                             |
| Order number (advanced)   | string          | No       | Find the exact order with this order number.                                                                                                                  |
| Customer email (advanced) | string          | No       | Find orders placed by this customer's email address.                                                                                                          |
| Order status              | select (string) | No       | Find orders in this order status (the order's workflow state, not its delivery/fulfillment state). Available values: Open, In Progress, Completed, Cancelled. |
| Max results               | integer         | No       | Maximum number of orders to return (1-100). Defaults to 25.                                                                                                   |
| Page (advanced)           | integer         | No       | Page number to fetch. Leave blank for the first page.                                                                                                         |

#### Outputs

| Field         | Type          | Description                                       |
| ------------- | ------------- | ------------------------------------------------- |
| Orders        | object\_array | The matching orders.                              |
| Total matches | integer       | Total number of orders matching the search.       |
| Next page     | integer       | Page number for the next page of results, if any. |

### Update Order Delivery

Record tracking codes on an existing order's delivery when it ships.

#### Inputs

| Field           | Type            | Required | Description                                                                                                                                             |
| --------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Order ID        | string          | Yes      | The order whose delivery to update.                                                                                                                     |
| Tracking Codes  | string          | No       | One or more tracking codes for this shipment, separated by commas.                                                                                      |
| Shipping Method | select (string) | No       | Override the shipping method for this delivery. Reuses the order's existing shipping method when left blank. Options load from the selected connection. |

#### Outputs

| Field          | Type   | Description                                      |
| -------------- | ------ | ------------------------------------------------ |
| Delivery ID    | string | Unique ID of the updated delivery.               |
| Order ID       | string | ID of the order the delivery belongs to.         |
| Tracking Codes | object | Tracking codes recorded on the updated delivery. |

### Create Customer

Add a new customer with a billing address to your shop.

#### Inputs

| Field          | Type            | Required | Description                                                                                                                                                       |
| -------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Email          | string          | Yes      | The customer's email address.                                                                                                                                     |
| First Name     | string          | Yes      | The customer's first name.                                                                                                                                        |
| Last Name      | string          | Yes      | The customer's last name.                                                                                                                                         |
| Street         | string          | Yes      | Street and house number for the billing address.                                                                                                                  |
| City           | string          | Yes      | City for the billing address.                                                                                                                                     |
| Country        | select (string) | Yes      | Country for the billing address. Options load from the selected connection.                                                                                       |
| Zip Code       | string          | No       | Postal code for the billing address.                                                                                                                              |
| Sales Channel  | select (string) | No       | The sales channel this customer is registered under. Uses the shop's first active sales channel when left blank. Options load from the selected connection.       |
| Customer Group | select (string) | No       | The customer group this customer belongs to. Uses the selected sales channel's default customer group when left blank. Options load from the selected connection. |

#### Outputs

| Field           | Type   | Description                              |
| --------------- | ------ | ---------------------------------------- |
| Customer ID     | string | Unique ID of the created customer.       |
| Customer Number | string | Customer number of the created customer. |
| Email           | string | Email of the created customer.           |

### Delete Product

Permanently delete a product from your Shopware catalog.

#### Inputs

| Field   | Type            | Required | Description                                                                   |
| ------- | --------------- | -------- | ----------------------------------------------------------------------------- |
| Product | select (string) | Yes      | The product to permanently delete. Options load from the selected connection. |

#### Outputs

| Field      | Type    | Description                      |
| ---------- | ------- | -------------------------------- |
| Product ID | string  | ID of the deleted product.       |
| Deleted    | boolean | Whether the product was deleted. |

### Delete Customer

Permanently delete a customer from your shop.

#### Inputs

| Field       | Type   | Required | Description                         |
| ----------- | ------ | -------- | ----------------------------------- |
| Customer ID | string | Yes      | The customer to permanently delete. |

#### Outputs

| Field       | Type    | Description                       |
| ----------- | ------- | --------------------------------- |
| Customer ID | string  | ID of the deleted customer.       |
| Deleted     | boolean | Whether the customer was deleted. |

### Search Customers

Find customers in your shop by name, email, or customer number.

#### Inputs

| Field            | Type    | Required | Description                                                    |
| ---------------- | ------- | -------- | -------------------------------------------------------------- |
| Search           | string  | No       | Find customers by name, email, or customer number.             |
| Email (advanced) | string  | No       | Find the exact customer with this email address.               |
| Max results      | integer | No       | Maximum number of customers to return (1-100). Defaults to 25. |
| Page (advanced)  | integer | No       | Page number to fetch. Leave blank for the first page.          |

#### Outputs

| Field         | Type          | Description                                       |
| ------------- | ------------- | ------------------------------------------------- |
| Customers     | object\_array | The matching customers.                           |
| Total matches | integer       | Total number of customers matching the search.    |
| Next page     | integer       | Page number for the next page of results, if any. |

## Triggers

A trigger starts a workflow when its configured event occurs. Configure the event and filters before enabling the trigger.

### New Order

Fires when a new order is placed in the shop.

#### Event inputs

| Field        | Type     | Required | Description                                   |
| ------------ | -------- | -------- | --------------------------------------------- |
| Order ID     | string   | Yes      | The new order's unique identifier. Default: . |
| Order number | string   | Yes      | The new order's number. Default: .            |
| Total amount | number   | No       | The order's gross total.                      |
| Order date   | datetime | No       | The order's creation timestamp.               |

#### Outputs

| Field        | Type     | Description                        |
| ------------ | -------- | ---------------------------------- |
| Order ID     | string   | The new order's unique identifier. |
| Order number | string   | The new order's number.            |
| Total amount | number   | The order's gross total.           |
| Order date   | datetime | The order's creation timestamp.    |

### New Customer

Fires when a new customer registers in the shop.

#### Event inputs

| Field       | Type   | Required | Description                                  |
| ----------- | ------ | -------- | -------------------------------------------- |
| Customer ID | string | Yes      | The new customer's unique id. Default: .     |
| Email       | string | Yes      | The new customer's email address. Default: . |
| First name  | string | No       | The new customer's first name.               |
| Last name   | string | No       | The new customer's last name.                |

#### Outputs

| Field       | Type   | Description                       |
| ----------- | ------ | --------------------------------- |
| Customer ID | string | The new customer's unique id.     |
| Email       | string | The new customer's email address. |
| First name  | string | The new customer's first name.    |
| Last name   | string | The new customer's last name.     |

## Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/shopware.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
