04. Beispiele und Downloads

Beispielvorlagen

Die OpenAPI-Datei und Beispielvorlagen gehören zum separat bereitzustellenden Entwicklerpaket.

Die OpenAPI-Datei und Beispielvorlagen gehören zum separat bereitzustellenden Entwicklerpaket.

Das vorbereitete, noch nicht öffentlich zum Download freigegebene ZIP enthält README.txt mit Versionshinweisen, openapi.yaml, quickstart.ps1 für PowerShell 7 und requests.http für einen HTTP-Client mit Cookie-Verwaltung. Der Schnellstart führt nur Anmeldung und Kataloglesen aus. Die HTTP-Datei enthält zusätzlich einen ausdrücklich gekennzeichneten manuellen Warenkorb-Schreibaufruf. Die Beispiele wurden nicht gegen ein produktives Kundensystem ausgeführt.

Warenkorb lesen

Nach dem technischen Login mit derselben Cookie-Sitzung:

GET /api/WebshopUserCart/GetWebshopUserCart?partnerId=123
Accept: application/json

Erwartet wird ein APIEntityResponse mit einer Liste von UserCartDto. Prüfen Sie success, Positionen, Mengen, Summen und Adressen.

Testartikel hinzufügen

Nur mit einem freigegebenen Testartikel und WebshopUserCart-Create:

POST /api/WebshopUserCart/AddToCart?partnerId=123
Content-Type: application/json

{"articleId":"TESTARTIKEL","quantity":1}

Der Aufruf kann die Menge einer bereits vorhandenen Position erhöhen. Deshalb bei Zeitüberschreitungen zuerst den Warenkorb neu lesen und keine automatische Wiederholung voraussetzen.

Menge ändern

Verwenden Sie die Positions-ID aus dem gelesenen Warenkorb, nicht die Artikel-ID. Im Beispiel ist 456 ein Platzhalter:

PUT /api/WebshopUserCart/UpdateCartItem?id=456&quantity=2

Menge 0 entfernt die Position. Negative Mengen sind fachlich ungültig. Auch bei HTTP 200 ist die Erfolgseigenschaft der Antwort zu prüfen.

Bestellung vorbereiten

Für den Abschluss werden partnerId und employeeId als Query-Parameter sowie deliveryAddress und billingAddress im JSON-Body verwendet. Die vollständigen Adressfelder stehen in der OpenAPI-Datei. Übernehmen Sie ein geprüftes Adressobjekt und validieren Sie den erzeugten Testbeleg fachlich.

POST /api/WebshopUserCart/WebshopPlaceOrder?partnerId=123&employeeId=7
Content-Type: application/json

Dies ist die Aufrufsignatur, kein vollständiger ausführbarer Checkout-Request. Ein Body mit beiden Adressobjekten ist erforderlich. Wegen der dokumentierten Abweichungen bei Beleg-ID und Adressübernahme enthält das Schnellstartskript bewusst keinen automatischen Bestellabschluss.

Helpdesk mit Pagination lesen

Ersetzen Sie die Testwerte und verwenden Sie die passende autorisierte Sitzung:

GET /api/Helpdesk/123/true/PageFromViewForPartner?skip=0&take=25&requireTotalCount=true
Accept: application/json

Hier wird ein DataSourceLoadOptions-Ergebnis erwartet, nicht zwingend der success/data/errorMessages-Umschlag. Laden Sie Folgeseiten mit erhöhtem skip; stimmen Sie für verlässliche große Exporte eine stabile Sortierung ab. Verwenden Sie die tatsächliche Seitenstruktur Ihrer Serverversion.

Zugangsdaten und Beispieldaten

Alle IDs und Domains auf dieser Seite sind Platzhalter. Zugangsdaten nur lokal eingeben, nicht in Versionsverwaltung, Tickets oder Protokolle übernehmen. Cookie-Dateien beziehungsweise Cookie-Container sind wie Zugangsdaten zu behandeln. Nutzen Sie pro Testfirma eine eigene Sitzung.