> For the complete documentation index, see [llms.txt](https://help.vario-software.de/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.vario-software.de/vario-cloud-handbuch/verkaufskanaele/shopsysteme/shopware-6/einrichten.md).

# Einrichten

Verbinde Shopware 6 mit VARIO Cloud, übernimm vorhandene Daten und richte den Verkaufskanal mit den benötigten Zuordnungen ein.

Hier richtest Du die Verbindung zu Deinem Shopware 6 Onlineshop ein und übernimmst bei Bedarf vorhandene Daten. Zurück zur Übersicht [Shopware 6](/vario-cloud-handbuch/verkaufskanaele/shopsysteme/shopware-6.md).

## Voraussetzungen

{% hint style="info" %}
**Voraussetzungen**

Um einen **Verkaufskanal** anhand Deines **Shopware 6 Onlineshop** einzurichten, musst Du zuerst die **Shopware 6 App** im **Admin-Center** installieren. Eine detaillierte **Schritt-für-Schritt-Anleitung** dazu findest Du [**hier**](/admin-center-handbuch/installationen-im-uberblick/app-verwaltung.md#installation-von-apps).

Für die Installation der App benötigst Du eine **Lizenz**, welche Du von uns erhältst und Dir zukünftig über unseren **App Store** holen kannst.
{% endhint %}

## Verkaufskanal mit Shopware 6 verknüpfen

Nach der Installation der **Shopware 6 App** wird im Menüpunkt **Verkaufskanäle** automatisch ein Verkaufskanal für Shopware 6 angelegt. Über das **»+«**-Zeichen kannst Du weitere **Verkaufskanäle** mit einer Shopware 6-Anbindung hinzufügen. Weitere Informationen zu den Verkaufskanälen und den einzelnen Reitern findest Du [**hier**](/vario-cloud-handbuch/verkaufskanaele/grundlagen.md).

### Verknüpfung in Shopware 6 einrichten

Bevor Du Deinen Verkaufskanal in VARIO Cloud mit Deinem Shopware 6 Onlineshop verknüpfen kannst, musst Du zuerst eine **Integration** in Shopware 6 für VARIO Cloud erstellen. Gehe dazu wie folgt vor:

{% stepper %}
{% step %}
Öffne auf der Seite Deines Onlineshops die **Einstellungen** und wähle im Bereich **System** den Punkt **»Integrationen«** aus.

<figure><img src="https://534317722-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fa7nDlxyw1xkeHi7FnWgm%2Fuploads%2FdIn5YDzGnlfGtT5lGz9f%2Fimage.png?alt=media&amp;token=8979c9af-20b8-4f5e-a802-7088cec4a06d" alt="Integrationen in den Einstellungen von Shopware 6"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Klicke auf **»Integration anlegen«**, um die Integration für VARIO Cloud einzurichten.
{% endstep %}

{% step %}
Beim Einrichten kannst Du der Integration einen Namen geben und die erforderlichen Rechte festlegen. **Speichere** die angezeigte **Zugangs-ID** und den **Sicherheitsschlüssel** außerhalb der Seite, da Du diese später für die Verknüpfung in VARIO Cloud benötigst.

<figure><img src="https://534317722-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fa7nDlxyw1xkeHi7FnWgm%2Fuploads%2FQgcmcLh2KjhPMg5ZxAz9%2Fimage.png?alt=media&amp;token=a4d9bf0a-09ae-4ae7-b5a7-69ba2e11b41b" alt="Integration in Shopware 6 anlegen" width="409"><figcaption></figcaption></figure>

{% hint style="warning" %}
**Speichere** Dir unbedingt die **Zugangs-ID** und den **Sicherheitsschlüssel**. Nach dem Anlegen der Integration werden beide Werte **nicht erneut angezeigt**.
{% endhint %}
{% endstep %}
{% endstepper %}

### Verknüpfung in VARIO Cloud einrichten

Nachdem Du die Integration in Shopware 6 angelegt hast, kannst Du den entsprechenden **Verkaufskanal in VARIO Cloud** mit Deinem Onlineshop verknüpfen und einrichten. Gehe dafür folgendermaßen vor:

{% stepper %}
{% step %}
Öffne den Shopware 6 Verkaufskanal im Menüpunkt **Verkaufskanäle** und klicke auf den Button **»Einrichtung«**.

<figure><img src="https://534317722-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fa7nDlxyw1xkeHi7FnWgm%2Fuploads%2FRKcI8r1bOxM3tUWatPZu%2Fimage.png?alt=media&amp;token=7c752140-78ef-41c4-82d6-e4cc6a96740f" alt="Button Einrichtung im Verkaufskanal"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Gib im Bereich **Zugangsdaten** die **URL** Deines Shops an sowie die **Zugangs-ID** und den **Sicherheitsschlüssel** in den Feldern **„Client-ID“** und **„Client-Secret“**, welche beim Einrichten von der Integration in Shopware 6 angegeben wurden. Klicke anschließend auf **»Speichern und weiter«**.

<figure><img src="https://534317722-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fa7nDlxyw1xkeHi7FnWgm%2Fuploads%2FsPzfeHXGVD7eCfXLVjZ9%2Fimage.png?alt=media&amp;token=86264ef4-7a92-4dee-ad5f-ec4fd73b6ecd" alt="Zugangsdaten im Einrichtungsassistenten"><figcaption></figcaption></figure>

Im Bereich **Verbindungstest** siehst Du, ob die Verbindung zum Onlineshop hergestellt wurde. Der Bereich **Datenanalyse** zeigt Dir je Datenart, wie viele Datensätze aus Shopware 6 noch nicht importiert oder nicht verbunden sind.

<figure><img src="https://534317722-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fa7nDlxyw1xkeHi7FnWgm%2Fuploads%2FQc6QqOOB1TUJUYcbaNuy%2Fimage.png?alt=media&amp;token=bb16e7b5-4981-4a5f-9667-a22e888b9d0c" alt="Verbindungstest und Datenanalyse"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
In den Bereichen **Basis-Stammdaten**, **Artikel** und **Adressen** kannst Du jeweils die Daten aus Shopware 6 importieren. Jeder Schritt bietet die Buttons **»Importieren«**, **»Überspringen«** und **»Zurück«**. Die Daten müssen nicht zwingend importiert werden.

| Bereich          | Schritte                                                                                                                                                                                                                          |
| ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Basis-Stammdaten | **Version und Verkaufskanäle**, **Lokalisierung** (Sprachen, Währungen, Steuern, Länder und Anreden), **Maßeinheiten**, **Kategorien**, **Weitere globale Stammdaten** (Tags und Lieferzeiten), **CMS-Layouts**, **Medienordner** |
| Artikel          | **Stammdaten**, **Zusatzfelder**, **Bilder**                                                                                                                                                                                      |
| Adressen         | **Kunden**, **Hersteller**                                                                                                                                                                                                        |

{% hint style="info" %}
Importiere mindestens den Schritt **Version und Verkaufskanäle**. Erst danach stehen im Verkaufskanal die Bereiche **Bestellabruf** und **Einstellungen** zur Verfügung. Vorher steht dort **„Schnittstelle wurde noch nicht eingerichtet“**.
{% endhint %}

Im Schritt **Stammdaten** des Bereichs **Artikel** wählst Du die **Import-Vorlage** aus. Mit dem Toggle **»Sortierreihenfolge aus ERP«** legst Du fest, ob die Sortierreihenfolge von VARIO Cloud festgelegt oder aus Shopware 6 übernommen wird. Fehlen Maßeinheiten, weist Dich vorher ein Hinweis darauf hin.

Im selben Schritt wählst Du im Pflichtfeld **„Warengruppe“** die Warengruppe für neu angelegte Artikel aus. Ohne Auswahl ist **»Importieren«** gesperrt. Bereits vorhandene Artikel behalten ihre Warengruppe.

Die beim Start des Imports gespeicherte Warengruppe ist beim nächsten Öffnen vorausgewählt, sofern sie noch vorhanden ist. Andernfalls wird **Sonstiges** vorgeschlagen, falls diese Warengruppe in VARIO Cloud vorhanden ist.

Ist noch keine Warengruppe vorhanden, öffnest Du über den Hinweis **Einstellungen/Artikel/Warengruppen** die Einstellungen in einem neuen Tab. Lege dort eine Warengruppe an und öffne die Auswahl anschließend erneut.

Bei Artikeln, Zusatzfeldern, Kunden und Herstellern wird der Import zunächst vorbereitet und mit **„Import vorbereitet“** angezeigt. Über **»Import öffnen«** siehst Du Dir den Import an, über **»Import starten«** führst Du ihn aus. Für Hersteller kannst Du zusätzlich eine **Adressvorlage** wählen.

**Zusatzfelder** müssen nach Abschluss der Einrichtung über das **Zusatzfeld-Mapping** im Bereich **Einstellungen** zugeordnet werden.

Die Daten aus Shopware 6 kannst Du auch nachträglich über den Einrichtungsassistenten importieren. Das gilt sowohl für bereits vorhandene als auch für neue Daten.

<figure><img src="https://534317722-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fa7nDlxyw1xkeHi7FnWgm%2Fuploads%2FkKjctg1ydSAvDar2YqBD%2Fimage.png?alt=media&amp;token=a4df635b-55b0-449e-a172-55bec3721081" alt="Import im Einrichtungsassistenten"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Nachdem alle benötigten Daten importiert wurden, kannst Du die Einrichtung im Bereich **Abschluss** mit dem Button **»Los geht's«** abschließen.

<figure><img src="https://534317722-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fa7nDlxyw1xkeHi7FnWgm%2Fuploads%2FtCaucJtT8QokrYL7zhKK%2Fimage.png?alt=media&amp;token=5aaeffc1-a483-4879-9733-86717f18f36d" alt="Abschluss der Einrichtung"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Nach Abschluss der Einrichtung werden Dir die Stammdaten des Verkaufskanals angezeigt, in denen Du die Einstellungen zum Verkaufskanal vornehmen kannst. Die grundlegenden Einstellungen und Zuordnungen findest Du im Abschnitt [Verkaufskanal verwalten](#verkaufskanal-verwalten).

<figure><img src="https://534317722-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fa7nDlxyw1xkeHi7FnWgm%2Fuploads%2FI79S0OPxGt43JX9Oq8eF%2Fimage.png?alt=media&amp;token=1c060780-08a7-427b-a0df-f0bea40dde9a" alt="Stammdaten des Verkaufskanals nach der Einrichtung"><figcaption></figcaption></figure>
{% endstep %}
{% endstepper %}

## Verkaufskanal verwalten

Nach dem Verknüpfen nimmst Du die grundlegenden Einstellungen im Verkaufskanal vor. Die Pflege von Kategorien und Artikeln findest Du unter [Artikel und Angebote](/vario-cloud-handbuch/verkaufskanaele/shopsysteme/shopware-6/artikel-und-angebote.md); Bestellabruf, Warteschlange und Aufgabenplanung unter [Bestellungen und Datenaustausch](/vario-cloud-handbuch/verkaufskanaele/shopsysteme/shopware-6/bestellungen-und-datenaustausch.md).

Genauere Informationen zu den weiteren Reitern findest Du auf der Seite zu den [Verkaufskanälen](/vario-cloud-handbuch/verkaufskanaele/grundlagen.md).

Im Reiter »Stammdaten« hast Du mehrere Optionen mit denen Du den Verkaufskanal verwalten kannst.

<figure><img src="https://534317722-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fa7nDlxyw1xkeHi7FnWgm%2Fuploads%2Fi7hCn3BdP32TvIrQcBIt%2Fimage.png?alt=media&amp;token=eecf6673-01f9-4d4a-8167-d48e68b83e05" alt="Reiter Stammdaten des Verkaufskanals"><figcaption></figcaption></figure>

### Bereich Verkaufskanal

Hier kannst Du einzelne Angaben zum Verkaufskanal vornehmen, die VARIO Cloud betreffen, während die Angaben in allen weiteren Bereichen speziell Shopware 6 betreffen.

Neben den adressbezogenen und finanziellen Angaben kannst Du eine der **Reportgruppen** auswählen, die unter **System/Ausgabe** im Reiter **»Belegdruck«** angelegt wurden. Diese wird dann automatisch für die Ausgabe der Aufträge verwendet, die durch den Import der Bestellungen aus Shopware 6 erstellt wurden. Für verschiedene Shopware 6 Verkaufskanäle können über die **Reportgruppen-Zuordnung** im Bereich **Einstellungen** verschiedene Reportgruppen zugeordnet werden.

<figure><img src="https://534317722-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fa7nDlxyw1xkeHi7FnWgm%2Fuploads%2FoFHxiIPOTvlbdD79xb5v%2Fimage.png?alt=media&amp;token=9d2812f6-48f7-4f24-b14e-affdcbf9e8bb" alt="Bereich Verkaufskanal" width="518"><figcaption></figcaption></figure>

### Bereich Einstellungen

Im Bereich **Einstellungen** legst Du fest, welche Daten zwischen VARIO Cloud und Shopware 6 übertragen werden, und pflegst die Zuordnungen.

<figure><img src="https://534317722-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fa7nDlxyw1xkeHi7FnWgm%2Fuploads%2FxnfoMqhSFgOOuBHucJQm%2Fimage.png?alt=media&amp;token=00bb6232-01a4-48b6-8ccd-8d028db726f6" alt="Bereich Einstellungen"><figcaption></figcaption></figure>

Die Toggles für Artikel, Preise, Bilder und Bestände sind unter [Übertragungseinstellungen](/vario-cloud-handbuch/verkaufskanaele/shopsysteme/shopware-6/artikel-und-angebote.md#ubertragungseinstellungen) beschrieben. Die Schalter für Versandstatus, Zahlungsstatus und Konten findest Du unter [Einstellungen für Rückmeldungen und Konten](/vario-cloud-handbuch/verkaufskanaele/shopsysteme/shopware-6/bestellungen-und-datenaustausch.md#einstellungen-fur-ruckmeldungen-und-konten). Nur bei aktivem Toggle entstehen die passenden Einträge in der Warteschlange.

Diese weiteren Felder betreffen die Verbindung und Verarbeitung insgesamt:

| Feld                                 | Bedeutung                                                                                                                                                                                                                                    |
| ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **„Shopware-Version“**               | Version Deines Onlineshops. Wird im Einrichtungsassistenten eingelesen und kann nicht bearbeitet werden.                                                                                                                                     |
| **»Skriptausführung«**               | Zum Aktivieren benötigst Du eine Skripting-Lizenz. Bei aktiviertem Toggle werden benutzerdefinierte [**Skripte**](/vario-cloud-handbuch/system/skripte.md) bei der Übertragung von Daten berücksichtigt. Die Übertragung dauert dann länger. |
| **„Aktive Shopware-Verkaufskanäle“** | Hier wählst Du die **Verkaufskanäle aus Shopware 6** aus, die mit diesem Verkaufskanal in VARIO Cloud verarbeitet werden. Nicht ausgewählte Kanäle werden bei Synchronisierungen übersprungen.                                               |

### Zuordnungen

Im Bereich **Zuordnungen** verknüpfst Du über die Buttons Datensätze aus VARIO Cloud mit den entsprechenden Datensätzen in Shopware 6. Über **»+ Mapping«** fügst Du eine Zeile hinzu und übernimmst die Zuordnung mit **»Speichern«**. In der **Reportgruppen-Zuordnung** ist jeder Verkaufskanal aus Shopware 6 bereits als Zeile vorhanden.

| Feld                        | Bedeutung                                                                                                                                                                                                                                                       |
| --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Kundengruppen-Mapping**   | Verknüpft Preisgruppen in VARIO Cloud mit Kundengruppen in Shopware 6.                                                                                                                                                                                          |
| **Zahlungsarten-Mapping**   | Ordnet jeder Zahlungsart aus Shopware 6 eine **Art** und eine **Bedingung** der Zahlungsmodalitäten in VARIO Cloud zu. Wird beim Import der Bestellungen verwendet.                                                                                             |
| **Versandarten-Mapping**    | Ordnet jeder Versandart aus Shopware 6 eine **Art** und eine **Bedingung** der Versandmodalitäten in VARIO Cloud zu. Wird beim Import der Bestellungen verwendet.                                                                                               |
| **Zusatzfeld-Mapping**      | Verknüpft Felder aus VARIO Cloud mit Zusatzfeldern in Shopware 6, getrennt für Artikel, Artikel Listing, Adresse, Beleg und Kategorie. Je Zeile kannst Du **»Leere Strings als null übertragen«** aktivieren.                                                   |
| **Positionstyp-Mapping**    | Legt fest, wie Bestellpositionen je Positionstyp importiert werden, z. B. **Ignorieren**, **Mit Artikelnummer importieren** oder **Als Rabattposition**. Standard-Artikel werden 1:1 zugeordnet. Über **»Zurücksetzen«** stellst Du die Vorgaben wieder her.    |
| **Attribut-Mapping**        | Überträgt Variantenattribute als Eigenschaftengruppen an Shopware 6. Zur Auswahl stehen Zusatzfelder vom Typ **Variantenattribut** aus der Gruppe **„Shopware 6 Properties“**. Fehlende Gruppen legst Du über **»Eigenschaftengruppe in Shopware anlegen«** an. |
| **Reportgruppen-Zuordnung** | Ordnet jedem Verkaufskanal aus Shopware 6 eine Reportgruppe zu, die die importierten Aufträge erhalten.                                                                                                                                                         |

{% hint style="warning" %}
Beim Mappen von **Zahlungs- und Lieferungsmodalitäten** achte darauf, dass alle in Shopware 6 zur Verfügung stehenden **Zahlungsarten** und **Versandarten** gemappt werden, da sonst keine entsprechenden Zahlungs- und Lieferungsmodalitäten in den Aufträgen automatisch angegeben werden.
{% endhint %}

### Cross-Selling-Gruppen pflegen <a href="#cross-selling-gruppen-pflegen" id="cross-selling-gruppen-pflegen"></a>

Öffne im Reiter **»Stammdaten«**, Bereich **Einstellungen**, den Dialog **„Cross-Selling-Gruppen“**. Die Gruppen werden je Verkaufskanal gepflegt und stehen anschließend in den Artikelzuordnungen zur Auswahl. Beachte vor der ersten Übertragung den Hinweis zu [bestehenden Cross-Sellings in Shopware 6](/vario-cloud-handbuch/verkaufskanaele/shopsysteme/shopware-6/artikel-und-angebote.md#reiter-cross-selling).

1. Ergänze über **»+ Cross-Selling-Gruppe«** eine Gruppe und vergib eine **Bezeichnung**. Sie erscheint im Shop als Überschrift.
2. Lege über **„Position“** die Reihenfolge der Gruppen fest und steuere über **»Aktiv«**, ob die Gruppe im Shop aktiv ist. Über das Mülleimer-Icon (**»Entfernen«**) entfernst Du eine Gruppe.
3. Bestätige mit **»Speichern«**.

Änderungen an Bezeichnung, Position oder Aktiv sowie das Löschen einer Gruppe werden bei den zugeordneten Artikeln über die Warteschlange an Shopware 6 übertragen. Deaktivierte Artikelzuordnungen zum Verkaufskanal werden dabei übersprungen. Die Zuordnung der Artikel erklärt Reiter [Cross-Selling](/vario-cloud-handbuch/verkaufskanaele/shopsysteme/shopware-6/artikel-und-angebote.md#reiter-cross-selling).

Gespeicherte Gruppen benötigen eine Bezeichnung; ohne sie lässt sich die Liste nicht speichern. Neue leere Zeilen werden ignoriert.

Kann die Gruppenliste nicht geladen werden, ist **»Speichern«** gesperrt. Schließe den Dialog und öffne ihn erneut.

## Eingelesene Stammdaten

Die Buttons **»Aufgabenplanung«** und **»Stammdaten«** stehen Dir in der oberen rechten Ecke zur Verfügung, sobald im Einrichtungsassistenten der Schritt **Version und Verkaufskanäle** importiert wurde. Die [Aufgabenplanung](/vario-cloud-handbuch/verkaufskanaele/shopsysteme/shopware-6/bestellungen-und-datenaustausch.md#aufgabenplanung) wird auf der Seite zum Datenaustausch erklärt.

Hier werden Dir alle Daten aufgelistet, die aus Shopware 6 eingelesen wurden: **Verkaufskanal**, **Steuer**, **Währung**, **Sprache**, **Land**, **Kategorie**, **Lieferzeiten**, **Tags**, **Maßeinheiten** und **Medienordner**.

<figure><img src="https://534317722-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fa7nDlxyw1xkeHi7FnWgm%2Fuploads%2FKoD75r8rze453BKlT0e9%2Fimage.png?alt=media&amp;token=d8724ebc-43b1-4d6d-b1af-97523c1ccefe" alt="Eingelesene Stammdaten"><figcaption></figcaption></figure>

## Aktionsmenü des Verkaufskanals

Im Aktionsmenü steht Dir die Aktion **»Änderungsprotokoll«** zur Verfügung. Hier werden Dir alle an dem Verkaufskanal durchgeführten Änderungen aufgelistet. Weitere Informationen zum Änderungsprotokoll findest Du [**hier**](/vario-cloud-handbuch/einfuhrung/tipps-zur-bedienung.md#anderungsprotokoll). Über die Aktion **»Deaktivieren«** deaktivierst Du den Verkaufskanal, über **»Aktivieren«** aktivierst Du ihn wieder.

<figure><img src="https://534317722-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fa7nDlxyw1xkeHi7FnWgm%2Fuploads%2FlV7bd0XW7hw4Z1hsDwoz%2Fimage.png?alt=media&amp;token=086ad12a-3f88-4163-bf0f-3357525f8d2b" alt="Aktionsmenü des Verkaufskanals"><figcaption></figcaption></figure>

Wenn die Verbindung und Zuordnungen eingerichtet sind, kannst Du [Artikel und Angebote](/vario-cloud-handbuch/verkaufskanaele/shopsysteme/shopware-6/artikel-und-angebote.md) vorbereiten und den [Bestellungsimport](/vario-cloud-handbuch/verkaufskanaele/shopsysteme/shopware-6/bestellungen-und-datenaustausch.md#bestellungsimport-verwalten) einrichten.


---

# 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://help.vario-software.de/vario-cloud-handbuch/verkaufskanaele/shopsysteme/shopware-6/einrichten.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.