> For the complete documentation index, see [llms.txt](https://helpcenter.etron.info/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://helpcenter.etron.info/verwaltungsoberflache/api-and-hooks/endpunkte/documentation-v2-rest-api-dokumentation.md).

# Documentation: v2 REST API Dokumentation

{% hint style="success" %}
*Modul: ETRON onRetail REST API*
{% endhint %}

> *API & Hooks -> Endpunkte -> Documentation*

{% hint style="info" %}
*Direkter Link zur Dokumentation:* [*REST API Dokumentation*](https://apidocs.wawi.onretail.eu/rest/docs)
{% endhint %}

<div data-with-frame="true"><figure><img src="https://2281246901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlM26Mg6nljOOOe95HyIq%2Fuploads%2FS2t6r3gBEFBaTa9ftFra%2Fimage.png?alt=media&amp;token=db9f071b-3815-48a6-9b97-31ae5a1db900" alt="Menüpunkt Documentation im Bereich API &#x26; Hooks"><figcaption></figcaption></figure></div>

Über den Menüpunkt öffnet sich die API Dokumentation (Swagger) in einem neuen Browser-Tab.

<div data-with-frame="true"><figure><img src="https://2281246901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlM26Mg6nljOOOe95HyIq%2Fuploads%2FdNRurwiEgN22nu7bwJjE%2Fimage.png?alt=media&amp;token=8406e304-aefc-4716-9c27-7a8354b63fcc" alt="Geöffnete REST API Dokumentation in Swagger"><figcaption></figcaption></figure></div>

## Download API Postman Collection, Postman Environment

Unter dem Menüpunkt API & Hooks -> Endpunkte -> Dokumentation kann über den Link "Download Postman Collection & Environment" direkt die Postman Collection und das Postman Environment als zip-Datei heruntergeladen werden. In Postman kann der entpackte Ordner importiert werden, wodurch die API Dokumentation und die Daten für die Authentifizierung über oAuth2 direkt in Postman verfügbar sind.

{% hint style="warning" %}
*Das Paket enthält gültige Zugangsdaten der jeweiligen Instanz. Die Datei ist wie ein Passwort zu behandeln. Eine öffentliche Weitergabe oder Ablage in Tickets und Versionsverwaltungen ist zu vermeiden.*
{% endhint %}

Alternativ kann die Postman Collection auch als json-Datei heruntergeladen werden:

{% file src="/files/o0w6ILLZmhOuS1Q4w4F3" %}

## Beschreibung der API Dokumentation (Swagger)

<div data-with-frame="true"><figure><img src="https://2281246901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlM26Mg6nljOOOe95HyIq%2Fuploads%2FYIg3mK6PurLZLepDColP%2Fimage.png?alt=media&amp;token=7af5899f-9f96-4f98-8277-0984eebbe9ae" alt="Übersicht der REST API Dokumentation in Swagger"><figcaption></figcaption></figure></div>

In der Dokumentation befindet sich eine Beschreibung der API, für verschiedene Datenmodelle sind Beispiele bzw. Schema im JSON-Format angegeben. Die verschiedenen Endpunkte können nach vorheriger [Autorisierung](#autorisierung) über oauth2 direkt [getestet](#testen-try-it-out) werden.

<div data-with-frame="true"><figure><img src="https://2281246901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlM26Mg6nljOOOe95HyIq%2Fuploads%2F7Y8mpTqgmm7RLWmbxDu7%2Fimage.png?alt=media&amp;token=d8eb8fd3-4d08-44ba-8c21-8d8b516026b5" alt="Ausgeklappter API-Request in Swagger"><figcaption></figcaption></figure></div>

### Testen (Try it out)

Die API-Requests können nach vorheriger [Autorisierung](#autorisierung) getestet werden.

Dafür wird einer der Requests in der Doku durch Anklicken ausgeklappt, und rechts oben der Button ![Try it out](https://2281246901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlM26Mg6nljOOOe95HyIq%2Fuploads%2F2bOoQThjLluoFAMUaS8K%2Fimage.png?alt=media\&token=d752f336-d04b-4638-a06c-2b4c7a2ba7b6) ausgewählt. Nun können die gewünschten Parameter gesetzt und durch Auswählen des Buttons ![Execute](https://2281246901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlM26Mg6nljOOOe95HyIq%2Fuploads%2FOCzzHdkON5GznUFbJJMB%2Fimage.png?alt=media\&token=a4946afe-5165-4b40-8b7e-6dc99eddc7aa) der Request getestet werden.

<div data-with-frame="true"><figure><img src="https://2281246901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlM26Mg6nljOOOe95HyIq%2Fuploads%2FgilewFfUAweW1Dh7XBlU%2Fimage.png?alt=media&amp;token=dcdece31-1c55-4951-9ed9-c839d5d76445" alt="Ausführbarer API-Request mit dem Button Execute"><figcaption></figcaption></figure></div>

### Autorisierung

Die Autorisierung wird recht oben über den Button <img src="https://2281246901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlM26Mg6nljOOOe95HyIq%2Fuploads%2F9hLwSmym2ANlmZk6ynRx%2Fimage.png?alt=media&amp;token=a6e99971-fb03-4888-97e2-4574b1c78610" alt="Authorize" data-size="original"> geöffnet. Im Bereich **OAuth2** wird die client\_id und das client\_secret der zu [testenden Verbindung ](/verwaltungsoberflache/api-and-hooks/authentication.md)eingegeben.

<div data-with-frame="true"><figure><img src="https://2281246901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlM26Mg6nljOOOe95HyIq%2Fuploads%2Fb7ARlASeFAJBpv6E201U%2Fimage.png?alt=media&amp;token=335162b7-5e58-4280-b3b0-271840df6625" alt="OAuth2-Autorisierungsdialog in Swagger"><figcaption></figcaption></figure></div>

Über den Button <img src="https://2281246901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlM26Mg6nljOOOe95HyIq%2Fuploads%2FTvPpeowWbBEtLCZYRYtO%2Fimage.png?alt=media&amp;token=b7dfec39-3338-4a7b-ac68-400980a011f0" alt="Authorize" data-size="line"> bestätigen.

Nach erfolgreicher Autorisierung sollten die Daten im Fenster so aussehen.

<div data-with-frame="true"><figure><img src="https://2281246901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlM26Mg6nljOOOe95HyIq%2Fuploads%2FSOX8luMTb66FthwY6lMc%2Fimage.png?alt=media&amp;token=ea146f80-d106-44f5-b56e-b9fa772d1b00" alt="Erfolgreich autorisierte OAuth2-Verbindung in Swagger"><figcaption></figcaption></figure></div>

### Schemas

<div data-with-frame="true"><figure><img src="https://2281246901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlM26Mg6nljOOOe95HyIq%2Fuploads%2FlFNTUKajhFQWrPWeXEkM%2Fimage.png?alt=media&amp;token=b6a5b9d4-e97f-409e-b833-28a11765d28c" alt="Bereich Schemas in der REST API Dokumentation"><figcaption></figcaption></figure></div>

Am Ende der API Dokumentation befinden sich die Schemas der verschiedenen Modelle mit der Beschreibung der Felder und Datentypen.

Beispiel: Schema einer Angebotszeile in einem [Angebot](/verwaltungsoberflache/auftragswesen/angebote-and-auftrage-auftragswesen.md#auftragszeilen).

<div data-with-frame="true"><figure><img src="https://2281246901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlM26Mg6nljOOOe95HyIq%2Fuploads%2FkTvXAWAseSrZjinuKjhN%2Fimage.png?alt=media&amp;token=43600b1f-e84a-4913-bd9f-bb790c6c823e" alt="Schema einer Angebotszeile in der REST API Dokumentation"><figcaption></figcaption></figure></div>


---

# 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://helpcenter.etron.info/verwaltungsoberflache/api-and-hooks/endpunkte/documentation-v2-rest-api-dokumentation.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.