| Excerpt |
|---|
Diese REST-API ermöglicht die Abfrage von Kategoriendaten aus V8-Shops. |
Inhaltsverzeichnis
| Table of Contents | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Abfrage von Kategorielisten
Request
| Code Block |
|---|
GET https://www.websale.de/api/categories/ |
Filtermöglichkeiten
...
Mit dem Request-Parameter "filter[parentIndex]" kann nach dem Index der Oberkategorie gefiltert werden.
...
Wird für diesen Parameter ein leerer Wert angegeben, so werden die Kategorien unterhalb der "Root" (d. h. die oberste Ebene des Kategoriebaums) zurückgeliefertzurück geliefert.
Bei dem Request-Parameter "subshop" muss der Subshop angegeben werden.
Beispiel: subshop=01-aa
Limit
...
Die Anzahl der zurückgegebenen Kategorien kann mit dem Parameter "size" beschränkt werden.
Beispiel: size=100
Sortierung
...
Die Sortierung wird mit dem Parameter "sort" angegeben, es sind die Werte "predefined" (Reihenfolge, wie sie im Shop angezeigt wird) und "catIndex" (aufsteigend nach Kategorieindex) erlaubt.
Beispiel: sort=predefined
Beispiele
...
| Code Block |
|---|
// Zugriff auf bis zu 100 Unterkategorien von Kategorie 123 GET https://www.websale.de/api/categories/?filter[parentIndex]=123&size=100&subshop=deutsch GET https://www.websale.de/api/categories/?filter[parentIndex]=123&size=100&sort=predefined&subshop=deutsch // Toplevel Kategorien GET https://www.websale.de/api/categories/categories?filter[parentIndex]=&size=100&subshop=deutsch |
Content-Type
application/json
Authorization-Token
benötigt
Response
Liefert im Erfolgsfall eine Liste mit Kategorien.
Beispiel
...
| Code Block |
|---|
{
"totalCount": 1000, // Anzahl der Ergebnisse wenn size nicht greifen würde
"items": [
{
"parentIndex": "1337",
"catIndex": "123",
"name": "Erste Kategorie",
"hasChildren": true,
"hreflang": [
{"catIndex": "456", "subshop": "Deutsch"}, {"catIndex": "457", "subshop": "07-aa"}
]},
...
]
} |
Der Parameter "hreflang" gibt die zugehörigen Kategorien in anderen Subshops an (wenn der Shop das "hreflang" Feature benutzt). Dieses Feld ist nicht Teil der V9-REST-API.
Ebensowenig der Parameter "hasChildren", der angibt, ob eine Kategorie Unterkategorien hat.
Mögliche Fehler
400 | Bad Request | Ungültiges Authentifizierungs-Token |
401 | Forbidden | Keine Berechtigung zum Aufruf |
404 | Not Found | Der angegebene Subshop oder die angegebene Kategorie existiert nicht |
...