LET OP: Draait jouw webshop op een Magento platform, dan hebben we de implementatie al voor je gedaan in onze extensie. Bekijk dan de volgende artikelen: https://support.tweakwise.com/nl/cat/magento-recommendations/overview

In je webshop moet je de functionaliteit realiseren om bij Tweakwise de recommendations op te vragen. Die aanvraag gaat middels een aantal REST API’s. De URL’s voor de oproep zijn voorzien van een unieke instancekey, deze is te vinden in de app onder Connectivity > Endpoints.

Op https://developers.tweakwise.com/api/ vind je de informatie die je nodig hebt om deze feature te implementeren onder Recommendations.

 

{instancekey}	Instancekey voor het gebruik van Tweakwise wat specifiek per klant wordt uitgegeven. Deze key is in alle aanroepen voor één Tweakwise instantie hetzelfde
{id}	Uniek nummer voor een recommendations regel. Dit nummer is zichtbaar op het tabblad ‘info implementatie’. ‘uitgelichte producten’ > Als laatste genoemd in de getoonde URL. ‘upselling & cross selling’ > Genoemd voor {productnr}
{categoryid}	Uniek nummer voor een (sub) categorie in de webshop. Hierbij moet de nummering gebruikt worden die voor de categorieën ook in de import feed wordt gehanteerd.
{productnr}	Uniek nummer voor een product in Tweakwise. Het gaat om de nummers zoals die ook genoemd worden in de module Catalogus > Producten, in de kolom ‘Artikelnr’.
{groupkey}	Upselling & cross selling regels kunnen gegroepeerd worden door verschillende regels uit te rusten met eenzelfde groeperingscode. Met deze parameters wordt die code bedoeld.

Verschillende endpoints voor uitgelichte producten

Lijst met uitgelichte producten
Wanneer je alle uitgelichte producten die je hebt ingericht in Tweakwise in lijstvorm wilt opvragen gebruik je deze functie. Daarmee is het mogelijk om in een willekeurig CMS alle recommendations op te vragen en selecteer jezelf de gewenste regel. Deze functie is niet nodig voor de front-end maar enkel in het CMS. 

/catalog/recommendation/featured/{instancekey}/
 

Uitgelichte producten opvragen
Als je de recommendations wilt opvragen van een exacte regel met uitgelichte producten, gebruik je deze functie.

/recommendations/featured/{instancekey}/{id}

 

Uitgelichte producten opvragen met producten uit één categorie
Met deze oproep kan je recommendations opvragen waarbij je in de aanroep exact aangeeft welke regel gebruikt moet worden en waarbij flexibel aangegeven kan geven uit welke categorie de producten geselecteerd moeten worden. Die flexibiliteit moet dus door de webshop ingevuld worden.

/recommendations/featured/{instancekey}/{id}?tn_cid={categoryid}

 

Verschillende endpoints voor upselling & cross selling

 

Lijst met ‘upselling &cross selling’ opvragen

Gebruik deze functie als je alle upselling & cross selling regels die je hebt ingericht in Tweakwise in lijstvorm wil opvragen . Daarmee is het mogelijk om in een willekeurig CMS alle recommendations op te vragen en selecteer jezelf de gewenste regel. Deze functie is niet nodig voor de front-end maar enkel in het CMS.

/catalog/recommendation/product/{instancekey}/

 

Lijst met ‘upselling &cross selling’ groeperingscodes opvragen

Wanneer je alle upselling & cross selling groeperingscodes die je hebt ingericht in Tweakwise in lijstvorm wil opvragen gebruik je deze functie. Daarmee is het mogelijk om in een willekeurig CMS alle groeperingscodes op te vragen en selecteer jezelf de gewenste regel. Deze functie is niet nodig voor de front-end maar enkel in het CMS.

/catalog/recommendation/product/groups/{instancekey}

 

‘Upselling of cross selling’ producten opvragen bij één regel

Wanneer je de recommendations feed wil opvragen van een exacte regel voor een product met upselling of cross selling producten gebruik je deze functie.

/recommendations/product/{instancekey}/{id}/{productnr}

 

‘Upselling of cross selling’ producten opvragen over alle regels

Met deze functie kan je product recommendations opvragen zonder daarbij specifiek aan te geven welke regel gehanteerd moet worden. Tweakwise zal dan alle regels bij langs gaan om te kijken welke recommendations ze opleveren. In de XML komt ook terug via welke regel een product is geselecteerd. In de URL moet meegegeven worden bij welk product de recommendations gematched moeten worden.

/recommendations/product/{instancekey}/{productnr}

 

‘Upselling of cross selling’ producten opvragen over regels met bepaalde groepcode

Met deze functie kan je product recommendations opvragen zonder daarbij specifiek aan te geven welke regel gehanteerd moet worden. Om te voorkomen dat Tweakwise alle regels bij langs gaat wordt een groeperingscode meegegeven en alleen regels die gekoppeld zijn aan deze code worden gebruikt. In de XML komt ook terug via welke regel een product is geselecteerd. In de URL moet meegegeven worden bij welk product de recommendations gematched moeten worden. De volgorde van de regels wordt bepaald in Tweakwise. Ons advies is om deze variant te implementeren.

/recommendations/grouped/{instancekey}/{productnr}/{groupkey}