Da es sich um authentifizierte Endpunkte handelt, wird das Access-Token für den Zugriff benötigt.
Produktsuche
Zum Suchen von Produkten im Sortiment gibt es den authentifizierten Endpunkt
GET /storefront/products
Gemäß der openAPI-Dokumentation erwartet dieser Endpunkt entweder einen Suchbegriff keyword und/oder Filterknoten filters. Wenn zum Beispiel im Sortiment nach „ipad“ gesucht werden soll, sieht das folgendermaßen aus:
Wenn zum Beispiel die Suche auf Tablets eingeschränkt werden soll, muss der Filterknoten SET194 mit gesendet werden. Die Filterknoten werden aus den dynamischen Filtern gelesen oder aus dem Kategoriebaum gezogen.
Kategoriebaum
Der Kategoriebaum kann unter dem Endpunkt
GET /storefront/categories
geholt werden. Der Baum hat maximal drei Verzweigungen. Der Name jedes Knotens wird in der Benutzersprache lokalisiert zurückgegeben. Unter dem Feld searchTerm steht der Filterknoten, der an den Produktsuchendpunkt gesendet werden muss, wenn diese Kategorie geladen werden soll. Der Filterknoten kann auch mitgeschickt werden, um die Textsuche auf diese Kategorie einzuschränken, siehe oben.
Dynamische Filter
Das Suchergebnis kann durch Filter weiter eingeschränkt werden. Diese Filterknoten werden dynamisch auf Basis des Suchergebnis berechnet. Es würde beispielsweise keinen Sinn ergeben, eine Ergebnismenge, die nichts aus dem Bereich Aquaristik oder 19 Zoll Bildschirmdiagonale enthält, danach zu filtern. Für die dynamischen Filter steht deshalb der Endpunkt
GET /storefront/products/filters
bereit. Die Parameter keyword und filters müssen identisch zur Suchabfrage sein, um sinnvolle Ergebnisse zu erhalten.
Das Resultat ist eine Liste von Filtermöglichkeiten. Die Listeneinträge haben den name des Filters (in diesem Fall „Produkttyp“) und die Filteroptionen auf diesem Knoten. Das Feld name ist in der Sprache des Shop-Users lokalisiert. Das Feld term entspricht dem Filterknoten, der gegen die Storefront API geschickt wird.
Produktseite
Die Produktseite wird über den Aufruf
GET /storefront/products/{id}
geholt. Analog dazu können an den jeweiligen Endpunkten Zubehörprodukte, Bundle-Stücklisten und Datenblätter geholt werden.
Die id entspricht dabei der productId im Suchergebnis, welche wiederum der ITscope-ID entspricht, welche im Shop Produkt-ID genannt wird.