# Documentation: v2 REST API Dokumentation

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

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

<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&#x26;token=db9f071b-3815-48a6-9b97-31ae5a1db900" alt=""><figcaption></figcaption></figure>

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

<figure><img src="https://2281246901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlM26Mg6nljOOOe95HyIq%2Fuploads%2FFjZtaMstIH1FK5W65Ek5%2Fimage.png?alt=media&#x26;token=c0ff49c3-3cc2-486a-9b93-d09b5d4055f2" alt=""><figcaption></figcaption></figure>

## 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.&#x20;

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

{% file src="<https://2281246901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlM26Mg6nljOOOe95HyIq%2Fuploads%2FZrLYipwje8slm01U4yas%2FonRetail%20V2%20API.postman_collection.json?alt=media&token=407c8998-6ddc-4b2f-8c74-c54b601f17d2>" %}

## Beschreibung der API Dokumentation (Swagger)

<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&#x26;token=7af5899f-9f96-4f98-8277-0984eebbe9ae" alt=""><figcaption></figcaption></figure>

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.&#x20;

<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&#x26;token=d8eb8fd3-4d08-44ba-8c21-8d8b516026b5" alt=""><figcaption></figcaption></figure>

### 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 ![](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.

<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&#x26;token=dcdece31-1c55-4951-9ed9-c839d5d76445" alt=""><figcaption></figcaption></figure>

### Autorisierung&#x20;

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&#x26;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 ](https://helpcenter.etron.info/verwaltungsoberflache/api-and-hooks/authentication)eingegeben.

<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&#x26;token=335162b7-5e58-4280-b3b0-271840df6625" alt=""><figcaption></figcaption></figure>

Ü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&#x26;token=b7dfec39-3338-4a7b-ac68-400980a011f0" alt="" data-size="line"> bestätigen.&#x20;

Nach erfolgreicher Autorisierung sollten die Daten im Fenster so aussehen.

<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&#x26;token=ea146f80-d106-44f5-b56e-b9fa772d1b00" alt=""><figcaption></figcaption></figure>

### Schemas

<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&#x26;token=b6a5b9d4-e97f-409e-b833-28a11765d28c" alt=""><figcaption></figcaption></figure>

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](https://helpcenter.etron.info/auftragswesen/angebote-and-auftrage-auftragswesen#auftragszeilen).

<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&#x26;token=43600b1f-e84a-4913-bd9f-bb790c6c823e" alt=""><figcaption></figcaption></figure>


---

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