Suchergebnisse abrufen - Kameleoon Documentation

Der Kameleoon Search-Service bietet zwei Suchtypen:

Instant (typeahead) search: Zeigt Ergebnisse an und aktualisiert sie, während Benutzer Suchanfragen eingeben.
Full search: Gibt vollständige, gefilterte Suchergebnisse zurück, nachdem der Benutzer eine Suchanfrage abgesendet hat.

Beide Optionen verwenden denselben Endpoint. Verwenden Sie den Parameter type, um den Suchtyp anzugeben.

Anfrage

GET https://api.products.kameleoon.com/search

Abfrageparameter

Diese Abfrageparameter gelten sowohl für die Full Search als auch für die Instant Search. Verwenden Sie zusätzliche Parameter nur mit der Full Search.

Parameter	Typ	Erforderlich	Beschreibung
`did`	String	True	Device-ID. Holen Sie diese ID aus dem Cookie `KameleoonProducts_device_id`. Rufen Sie sie vor dem Aufruf dieses Endpoints aus dem Backend ab. Geben Sie `did` nur an, wenn Sie Filter oder Algorithmen verwenden, die auf historischen Gerätedaten basieren, wie zum Beispiel “Recently Viewed” oder “Recommended for You.”
`sid`	String	True	Temporäre Benutzersitzungs-ID. Holen Sie diese ID aus dem Cookie `KameleoonProducts_session_code`. Rufen Sie sie vor dem Aufruf dieses Endpoints aus dem Backend ab. Geben Sie `sid` nur an, wenn Sie Filter oder Algorithmen verwenden, die auf historischen Benutzerdaten basieren, wie zum Beispiel “Recently Viewed” oder “Recommended for You.”
`shop_id`	String	True	Store Key. Sie finden ihn in Recommendations > Settings > Store settings in der Kameleoon App. Kontaktieren Sie Ihren Customer Success Manager, falls erforderlich, um den Schlüssel zu erhalten.
`type`	String	True	Gibt den Suchtyp an: `instant_search` oder `full_search`.
`search_query`	String	True	Aktuelle Suchanfrage.
`locations`	List	Optional	Durch Kommas getrennte Liste von Standort-IDs.

Zusätzliche Abfrageparameter (nur Full Search)

Verwenden Sie diese zusätzlichen Parameter mit Full Search-Anfragen (type=full_search).

Parameter	Typ	Erforderlich	Beschreibung
`limit`	Integer	Optional	Maximale Anzahl der von der API zurückgegebenen Ergebnisse.
`offset`	Integer	Optional	Ergebnisversatz.
`category_limit`	Integer	Optional	Maximale Anzahl von Kategorien für den Sidebar-Filter.
`categories`	List	Optional	Durch Kommas getrennte Liste von Kategorien zur Filterung.
`extended`	Integer or empty	Optional	Fügt erweiterte Informationen für Produktergebnisse hinzu. Unterstützte Werte: `1` oder leer. Bei `1` gibt die API alle Produktinformationen zurück. Wenn leer, gibt die API nur Produkt-IDs zurück. Kameleoon empfiehlt, diesen Wert für die Full Search auf `1` zu setzen.
`sort_by`	String	Optional	Sortierparameter. Unterstützte Werte: `popular`, `price`, `discount`, `sales_rate`, `date`.
`order`	String	Optional	Sortierrichtung: `asc` (aufsteigend) oder `desc` (absteigend). Standardwert ist `desc`.
`brands`	List	Optional	Durch Kommas getrennte Liste von Marken zur Filterung.
`filters`	String	Optional	Escapeter JSON-String mit Filterparametern. Beispiel: `{"bluetooth":["yes"],"offers":["15% cashback"],"weight":["1.6"]}`
`price_min`	Integer	Optional	Mindestpreis.
`price_max`	Integer	Optional	Höchstpreis.
`colors`	Integer	Optional	Durch Kommas getrennte Liste der Farben.
`exclude`	Integer	Optional	Durch Kommas getrennte Liste von Produkt-IDs, die aus den Suchergebnissen ausgeschlossen werden sollen.

Antwort (Instant Search)

Name	Typ	Beschreibung
`search_query`	string	Suchanfrage.
`categories`	array	Kategorieinformationen. Jedes Objekt enthält diese Eigenschaften: `id` – Kategorie-ID (string) `name` – Kategoriename (string) `url` – Kategorie-URL (string) `count` – Anzahl der Produkte in der Kategorie (number)
`filters`	array	Filterinformationen. Jedes Objekt enthält diese Eigenschaften: `filter` – Filterobjekt mit diesen Eigenschaften: `count` – Gesamtanzahl der Produkte, die diesen Parametern entsprechen (number) `values` – Array von Werteobjekten mit diesen Eigenschaften: `value` – Wertlabel (string) `count` – Anzahl der Produkte mit diesem Parameter (number)
`html`	string	HTML-Code für den Produktblock. Passen Sie die Vorlage im persönlichen Kameleoon-Konto an.
`price_range`	object	Mindest- und Höchstpreise der Produkte. Enthält diese Eigenschaften: `min` – Mindestpreis (number) `max` – Höchstpreis (number)
`products`	array	Produktinformationen. Jedes Objekt enthält diese Eigenschaften: `description` – Produktbeschreibung (string) `url` – absolute Produkt-URL (string) `url_handle` – relative Produkt-URL (string) `picture` – URL des Produktbildes im Kameleoon-Speicher (string) `name` – Produktname (string) `price` – Produktpreis (integer) `price_full` – Produktpreis (float) `price_formatted` – Produktpreis mit Währung (string) `price_full_formatted` – formatierter Produktpreis mit Währung (string) `image_url` - absolute URL des Produktbildes im Kameleoon-Speicher (string) `image_url_handle` - relative URL des Produktbildes im Kameleoon-Speicher (string) `image_url_resized` - Array von skalierten Bild-URLs `currency` – Produktwährung (string) `id` – Produkt-ID (string) `old_price` – alter Produktpreis (integer, Standard ist 0) `old_price_full` – alter Produktpreis (float) `old_price_formatted` – alter Produktpreis mit Währung (string) `old_price_full_formatted` – formatierter alter Produktpreis mit Währung (string) Zusätzliche Eigenschaften, wenn Sie `extended` in die Anfrage aufnehmen: `id` – Kategorie-ID (string) `name` – Kategoriename (string) `parent_id` – ID der übergeordneten Kategorie (string) `url` - Kategorie-URL `category_ids` - Produktkategorie-IDs (array)
`search_query_redirects`	array	Weiterleitungsinformationen. Jedes Objekt enthält diese Eigenschaften: `query` – Suchanfrage (string) `redirect_link` – URL für die Weiterleitung (string) `deep_link` – URL für mobile Anwendungen (string)
`products_total`	number	Gesamtanzahl der Produkte.

Antwort (Full Search)

Name	Typ	Beschreibung
`brands`	array	Markeninformationen. Jedes Objekt enthält diese Eigenschaften: `name` – Markenname (string) `picture` – URL des Markenbildes (string)
`categories`	array	Kategorieinformationen. Jedes Objekt enthält diese Eigenschaften: `alias` – Kategoriealias (string) `id` – Kategorie-ID (string) `name` – Kategoriename (string) `parent` – ID der übergeordneten Kategorie (string) `url` – Kategorie-URL (string)
`filters`	array	Filterinformationen. Jedes Objekt enthält diese Eigenschaften: `filter` – Filterobjekt mit diesen Eigenschaften: `count` – Gesamtanzahl der Produkte, die diesen Parametern entsprechen (number) `values` – Werteobjekte mit `value` (string) und `count` (number)
`html`	string	HTML-Code für den Produktblock. Passen Sie die Vorlage im persönlichen Kameleoon-Konto an.
`price_range`	object	Mindest- und Höchstpreise der Produkte. Enthält diese Eigenschaften: `min` – Mindestpreis (number) `max` – Höchstpreis (number)
`products`	array	Produktinformationen. Jedes Objekt enthält diese Eigenschaften: `brand` – Produktmarke (string) `currency` – Produktwährung (string) `id` – Produkt-ID (string) `is_new` – Produkteigenschaft (boolean, Standard ist null) `name` – Produktname (string) `old_price` – alter Produktpreis (string, Standard ist 0) `picture` – URL des Produktbildes im Kameleoon-Speicher (string) `price` – Produktpreis (number) `price_formatted` – Produktpreis mit Währung (string) `url` – Produkt-URL (string) Zusätzliche Eigenschaften, wenn Sie `extended` in die Anfrage aufnehmen: `barcode` – Produkt-Barcode (string) `categories` – Produktkategorien (array) mit `id`, `name` und `parent`-ID. `params` – Parameterinformationen. Jedes Objekt enthält `key` (string) und `values` (array).
`products_total`	number	Gesamtanzahl der Produkte.
`search_query`	string	Suchanfrage.

​Anfrage

​Abfrageparameter

​Zusätzliche Abfrageparameter (nur Full Search)

​Antwort (Instant Search)

​Antwort (Full Search)

Anfrage

Abfrageparameter

Zusätzliche Abfrageparameter (nur Full Search)

Antwort (Instant Search)

Antwort (Full Search)