Collection abrufen
Empfehlen
Collection abrufen
Rufen Sie eine konfigurierte Produktkollektion und ihre HTML-Vorlage von der Kameleoon Product Recommendation API ab.
GET
Collection abrufen
Der Dienst bietet Zugriff auf den Produktkollektion-Endpoint.
Liste der Felder für das
Liste der Eigenschaften für das
HTTP-Anfrage
Sie finden die Produkt-
collection_id im Bereich Product Collections des Dashboards. Ihre konfigurierten Kollektionen sind dort zusammen mit ihren ID-Nummern aufgelistet.Abfrageparameter
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
shop_id | String | True | Ihr Store Key. Sie finden ihn in Recommendations > Settings > Store settings in der Kameleoon App. Sie können sich auch an Ihren Customer Success Manager wenden, um den Schlüssel zu erhalten. |
did | String | False | Device-ID. Sie finden diese ID im Cookie KameleoonProducts_device_id, das Sie vor dem Aufruf dieses Endpoints vom Backend abrufen können. |
location | String | False | Standort des Benutzers. |
external_id | String | False | Dies ist ein eindeutiger Identifikator, der einem Benutzer in Ihrem System oder CRM zugeordnet ist. (Um eine genaue Übereinstimmung mit dem Kameleoon VisitorCode zu gewährleisten, muss die ID zunächst als Kameleoon Custom Data gespeichert werden. Stellen Sie beim Einrichten dieser Custom Data sicher, dass Sie die Option Use this custom data as a unique identifier for cross-device matching aktivieren, um sicherzustellen, dass die ID zur Verknüpfung von Benutzeraktivitäten über beide Systeme hinweg verwendet wird.). |
API-Antwort
| Name | Typ | Beschreibung |
|---|---|---|
products | Array of objects | Array mit Informationen zu Produkten. Jedes Objekt hat die folgenden Eigenschaften. |
html | String | Die bei der Erstellung der Kollektion ausgewählte HTML-Vorlage |
Liste der Felder für das products-Objekt-Array
| Eigenschaft | Beschreibung |
|---|---|
name | Produktname |
url | Vollständige URL zur Produktseite |
category_ids | Liste der zugehörigen Kategorie-IDs |
barcode | Produktbarcode oder eindeutiger Identifikator |
vendor_code | Lieferanten- oder Markencode |
brand | Markenname |
leftovers | Gibt den Bestandstyp an (z. B. “lot”, “single” usw.) |
rating | Produktbewertung |
fashion_feature | Modemerkmal oder Zielgruppe (z. B. child, woman) |
fashion_wear_type | Art des Modeartikels (z. B. shoe, clothing) |
fashion_original_sizes | Ursprünglich verfügbare Größen |
picture | Standard-Bild-URL |
categories | Produktkategorien (Array). Hat die folgenden Eigenschaften. |
price_formatted | Als String formatierter Produktpreis (z. B. ”$ 70”) |
price_full_formatted | Vollständig als String formatierter Produktpreis (z. B. ”$ 70.00”) |
price | Produktpreis als Zahl |
price_full | Vollständiger Produktpreis als Zahl |
image_url | Haupt-Bild-URL |
image_url_handle | Relativer Pfad zum Hauptbild |
image_url_resized | Objekt mit URLs der nach Größe skalierten Bilder |
url_handle | Relativer Pfad zur Produktseite |
currency | Währungssymbol (z. B. ”$“) |
_id | Interner eindeutiger Identifikator |
id | Produkt-ID (oft identisch mit dem Barcode) |
stock_quantity | Verfügbare Lagermenge |
fashion_colors | Verfügbare Farbe(n) für das Produkt |
params | Liste von Schlüssel/Wert-Paaren, die Produktattribute darstellen (z. B. Größe, Farbe) |
group_id | ID der Gruppe, zu der das Produkt gehört |
Liste der Eigenschaften für das categories-Array
| Eigenschaft | Beschreibung |
|---|---|
id | Kategorie-ID |
parent_id | (Optional) ID der übergeordneten Kategorie (falls zutreffend) |
url | Vollständige URL der Kategorie |
name | Kategoriename |
level | Kategorieebene (z. B. “1” = übergeordnet, “2” = Unterkategorie) |
url_handle | Relativer URL-Pfad zur Kategorie |