> For the complete documentation index, see [llms.txt](https://docs.codegiganten.de/plugin-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.codegiganten.de/plugin-documentation/en/apps/search-intelligent-and-ai-optimized/data-protection.md).

# Data protection

Which data the plugin processes, which cookies and browser storage it uses, and what to look at in your own privacy policy.

This page describes factually what the plugin stores in your visitors' browsers and which data it transfers to our search system. It helps you to shape your privacy policy and your cookie banner accordingly.

{% hint style="warning" %}
This is not legal advice. Please have your privacy policy reviewed legally. Whether and which data processing agreement is required for your shop, please clarify with your legal advisor.
{% endhint %}

## Overview

| Topic                     | In short                                                                                                      |
| ------------------------- | ------------------------------------------------------------------------------------------------------------- |
| Cookie                    | One cookie for recognition, only after consent in the cookie banner                                           |
| Without consent           | No cookie. The search works, events of one session are kept together through a derived identifier             |
| Events                    | Clicks in the search, impressions, cart, order, payment status                                                |
| Not transferred           | Name, email address, postal address, phone, payment data, order comments, IP address in plain text, passwords |
| Bots                      | Excluded from browser and cart events                                                                         |
| Shopping assistant (beta) | Inputs are masked, deleted after 30 days, evaluated in data centres in Germany                                |

## Cookie and consent

### The cookie at a glance

| Property | Value                                                                                          |
| -------- | ---------------------------------------------------------------------------------------------- |
| Name     | `cogi_recommendation_session`                                                                  |
| Content  | A random identifier (UUID), no personal details                                                |
| Lifetime | 365 days                                                                                       |
| Path     | `/`                                                                                            |
| Settings | `SameSite=Lax`, additionally `Secure` on HTTPS. It is set by JavaScript and is not `HttpOnly`. |
| Purpose  | Recognising the same visitor for search, statistics and personalisation                        |

The plugin shares the cookie with "InsightSearch Recommendations". One consent applies to both plugins.

### Entry in the cookie banner

The plugin registers in the Shopware cookie banner:

* **Group:** "Comfort features" (German: "Komfortfunktionen")
* **Name:** "Recognition for search and recommendations"
* **Description:** the German text reads "Merkt sich, welche Produkte Sie angesehen haben, damit Suchergebnisse und Empfehlungen besser zu Ihnen passen." (remembers which products you have viewed so that search results and recommendations suit you better)

If the recommendations plugin is installed as well, there is no duplicate entry. The entry appears with the shared text. The cookie is only set if the visitor has consented. Without consent it is removed.

If you use a cookie banner from a third party, it has to use the cookie mechanism of Shopware. Otherwise the entry may not appear there. If in doubt, check with your provider.

### Behaviour without consent

If a visitor has not consented, the plugin sets **no cookie**. The search works anyway. So that the events of one session belong together, the plugin uses two aids:

* A **derived reference of the Shopware session**. It is calculated from the session identifier (prefix `sr_` plus part of a checksum), cannot be calculated back, and the session value itself is never passed on.
* A **random ID in the session storage of the browser** (`sessionStorage`), which only applies to the open tab and disappears when the tab is closed.

What is missing: the visitor is not recognised across several visits.

### "Ignore cookie consent for recognition"

In the plugin configuration, card "Personalisation", you find the option "Ignore cookie consent for recognition".

| Setting                                 | Effect                                                                | Default |
| --------------------------------------- | --------------------------------------------------------------------- | ------- |
| "Ignore cookie consent for recognition" | The cookie is always set and used, even without consent in the banner | off     |

The help text says: only enable if consent is obtained elsewhere. The legal responsibility for this lies with you as the operator.

## Other storage in the browser

Besides the cookie, the plugin uses some browser storage. These are not cookies, but they may be worth mentioning in a privacy policy:

| Storage          | Purpose                                                                                                                                             |
| ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `localStorage`   | A short-lived technical access key for the search. Also the products last clicked in the search, so that purchases can be attributed to the search. |
| `sessionStorage` | Aids for the running tracking, restoring the search after a page change in the same tab (30 minutes) and hiding the history                         |

## Visit, visitor and session

* Each visit gets its own visit identifier (UUID). It lives in the Shopware session and is kept across login.
* After **30 minutes without activity** a new visit begins with a new identifier.
* Search, clicks, cart and order use the same visit and visitor identifier. This way the statistics can attribute a purchase to the search.

## Which events the plugin sends

**From the visitor's browser:**

* Click on a search result, click on quick view
* Display of the search layout (when the search opens) and impression of search results, also on the search results page
* Click on "Add to cart" and on the wish list in the search result
* Page events (call of landing page, category, product page, checkout, page view)

**From your shop (server):**

* Product added to the cart, with the origin "from the search" or "from the assistant", if known
* Order completed
* Change of payment status (paid, cancelled, change of payment method)
* Cancellation of an order

The search queries themselves go to our search system.

With the switch "Enable order tracking" (default on) you control cart, order and payment status together. If it is off, these three events are not sent.

## Which data is transferred

| Process                          | Transferred data                                                                                                                                                                                                                                                      |
| -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Connection (setup, hourly check) | Instance ID of the shop, shop address, shop type, plugin type, Shopware and plugin version, time zone, purchase status of the additional functions, access key for login                                                                                              |
| Product data                     | The fields set in feed or push (title, description, prices, brand, categories, properties, custom fields, image and product links, stock). Additionally per product the sales count and a margin class from 1 to 5.                                                   |
| Search queries                   | Search term, filters, visitor identifier, surface and origin, browser identifier (user agent, shortened to 512 characters). When called by the server, additionally an IP checksum.                                                                                   |
| Browser events                   | Event type, time, visitor and visit identifier, cleaned page address, page title, product ID, search term, hit position, sales channel, language, device class, user agent, for logged-in customers the customer ID                                                   |
| Cart                             | Visitor and visit identifier, products with quantity and price, origin, sales channel, language, device, for logged-in customers customer ID and customer number                                                                                                      |
| Order                            | Order ID, total amount, currency, items with quantity and price after proportional discount, order date, payment status, transaction status, order status, sales channel, language, visitor and visit identifier, device, user agent, customer ID and customer number |

On individual points:

* **Margin class:** It is derived from the purchase price. The purchase price itself is not transferred. You switch off the transfer of sales count and margin class with "Transfer sales and margin class" (card "Data sharing", default on). Then topseller sorting and margin ranking are omitted.
* **IP checksum:** The last digit of the IP address is anonymised, then a checksum is calculated and shortened. The plugin does not transfer the IP address in plain text. If the visitor's browser calls our search system directly, the IP address is technically visible for the connection, as with any call of a web address.
* **Page address:** Of the address, only the parameters `search`, `p` and `order` remain. Credentials and fragments are removed.
* **Customer ID and customer number** are identifiers that relate to a customer of your shop. They are only sent if the customer is logged in. Please take this into account in your privacy policy.

### What is not transferred

The plugin does not send: names, email addresses, postal addresses, phone numbers, payment data, order comments, IP addresses in plain text and passwords. Access keys are removed from messages and logs.

## Personalisation

In the card "Personalisation" you can enable "Personalise search results" (default off). Brands and categories that a visitor has viewed recently then move up slightly. You choose the strength between "Low" and "Medium".

Personalisation only happens with consent (cookie banner, group "Comfort features") or for logged-in customers. For logged-in customers the customer ID goes to our search system.

## Bots

The plugin does not count bots as visitors. Browser events and cart events are discarded if the browser identifier belongs to a bot. This includes crawlers of search engines, AI services and social networks, headless browsers, testing tools and HTTP libraries such as curl. An empty user agent also counts as a bot. Orders are not filtered by bots.

A test of your own with curl or a script therefore does not show up in the statistics.

## Shopping assistant (beta)

The shopping assistant is in beta and off by default. If you use it:

* Only real text inputs are stored, not clicks on selection buttons. Neither the IP address nor the customer ID is stored.
* Before storing, **email addresses, phone numbers, IBANs and long digit sequences are masked**.
* Conversations are **deleted after 30 days**.
* The language evaluation runs **exclusively in data centres in Germany**.
* Names or addresses that someone writes in free text are not recognised and not masked.

You find more about the assistant under [Shopping assistant (beta)](https://docs.codegiganten.de/plugin-documentation/en/apps/search-intelligent-and-ai-optimized/shopping-assistant.md).

## Logs in the shop

The plugin writes logs into your shop (folder `var/log`, files `cogi_insightsearch-<date>.log`). 14 files are kept. Credentials are not written to them.

## Notes for your privacy policy

Check whether your privacy policy and your cookie banner cover the following points:

1. The search service as a provider to which search queries, product data and events are transferred.
2. The cookie `cogi_recommendation_session` with name, purpose and lifetime of 365 days, and its assignment to the group "Comfort features".
3. The storage in the browser (`localStorage`, `sessionStorage`).
4. The processing of customer ID and customer number for logged-in customers.
5. The recording of cart, order and payment status for the revenue statistics. You can switch this off for your shop with "Enable order tracking".
6. If you use the shopping assistant: masking, deletion after 30 days, evaluation in Germany.
7. If you enable "Ignore cookie consent for recognition": how you obtain consent elsewhere.

Please have your privacy policy reviewed legally.

## Further reading

{% content-ref url="/pages/EKzI7kx2ZAjSIJVZz2DI" %}
[Shopping assistant (beta)](https://docs.codegiganten.de/plugin-documentation/en/apps/search-intelligent-and-ai-optimized/shopping-assistant.md)
{% endcontent-ref %}

{% content-ref url="/pages/HsFAOG9ZITzp3esXXRtx" %}
[Statistics](https://docs.codegiganten.de/plugin-documentation/en/apps/search-intelligent-and-ai-optimized/statistics.md)
{% endcontent-ref %}

{% content-ref url="/pages/v20EC98NJrD47BUleH4w" %}
[Plugin settings](https://docs.codegiganten.de/plugin-documentation/en/apps/search-intelligent-and-ai-optimized/plugin-settings.md)
{% endcontent-ref %}


---

# 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.codegiganten.de/plugin-documentation/en/apps/search-intelligent-and-ai-optimized/data-protection.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.
