StarWeb Installation Guide
Add the Hello Retail partner JavaScript
To get started with Hello Retail on your Starweb webshop, you'll need to add the Hello Retail partner JavaScript. Please follow this simple step-by-step guide to do this:
Step 1: Navigate to Utseende > Teman:
Step 2: Click the "edit" icon:
Step 3: Add a new HTML-field (HTML-fält) by dragging it the content layout area:
Step 4: Once the new HTML-field has been added, give it the name: Hello Retail as well as paste in the following Hello Retail partner JavaScript code:
<script async src="https://helloretailcdn.com/helloretail.js"></script>
<script>
window.hrq = window.hrq || [];
hrq.push(['init', {}]);
</script>
into the HTML-code area:
Step 5: Finally, remember to Save and Publish your changes:
Add the Hello Retail conversion tracking
To track conversion and sales performance with Hello Retail as well as improve your algorithms for on-site recommendations, you'll have to add the Hello Retail conversion script. Please follow this easy step-by-step guide to add the Hello Retail conversion script:
Step 1: Navigate to Utseende > Sidor:
Step 2: Choose and edit your receipt (conversion) page (by default, this page is called "Tack för din beställning"):
Step 3: Add a new HTML-field (HTML-fält) by dragging it the content layout area:
Step 4: Once the new HTML-field has been added, give it a suiting name, i.e. Hello Retail conversion tracking, as well as paste in the following snippet of code:
<!-- start hello retail conversion tracking -->
<script type="text/javascript">
hrq=(window.hrq||[]);hrq.push(["trackConversion", {
total: [[orderGrandTotal]],
orderNumber: ('[[orderNo]]' || '[[orderPaymentReference]]'),
email:'[[customerEmail]]'
}]);
</script>
<!-- end hello retail conversion tracking -->
into the HTML-code area:
Step 5: Finally, remember to Save and Publish your changes:
Share your product data with Hello Retail
For Hello Retail to recommend all products to your visitors, it's important for Hello Retail to have the details on all your products.
To share your product data, there are two ways to do so. We recommend you use Starweb's API integration.
Method 1 (API Integration):
If you are a new customer who uses Starweb, this is the method you should use.
Step 1: From the menu navigate to: Inställiningar > Kopplingar > StarWeb API. (see image below)
Step 2: Inside the section Starweb API > API -> Select "Hantera API-klienter" to create a new API-integration for Hello Retail.
Step 3: Within API-Klienter create a new API by clicking "Lägg till ny klient".
Final Step: To create and set up the API you need to insert the following values:
- Klient-id: you can name this whatever you want. E.g your-shopname
- API-grupp: From the drop-down, select the option "Hello Retail".
- Rättigheter: Select the options; Produkter, Kategorier and Ordrar.
Step 5: Right after you created the API-Integration the first time, you will be able to see the Client secret / Klienthemlighet. Copy this and send it to Hello Retail together with your self-made Client ID / Klient-id.
You have now successfully added an API-integration for Hello Retail and we will now be able to set up our services for you.
Method 2 (Google Shopping Feed):
The second option is to share your Google Shopping feed with Hello Retail. Please follow this guide, to ensure your Google Shopping feed in Starweb is set up correctly:
Step 1: Navigate to Inställningar > Prisagenter:
Step 2: In the Google Shopping section, please ensure All products ("Alla produkter") are selected in the Product ("Produkter") drop-down:
Step 3: Finally, please share your Google Shopping feed URL with Hello Retail – for Hello Retail to finalise the setup process. Your Google Shopping feed URL can be found as described above, and should look like this: https://YOUR_DOMAIN/products-feed/google-shopping
Create a blank search page for Hello Retail Search
The following section is only relevant for setups for a full search.
Step 1: Navigate to Utseende > Sidor:
Step 2: Choose to add a new page (via: "Lägg till ny sida"):
Step 3: Give this new page a reasonable name, e.g.: Search results:
Step 4: Remember to remove the page header (via: "Dölj huvudrubrik") to make sure the page is blank:
Now Save your changes.
Step 5: As the next step, you'll have to navigate to Utseende > Menyer:
Step 6: Here, choose to add a new menu (via: Lägg till ny meny):
Step 7: Give this new menu a suitable name, e.g. Menu (or as here: "Meny"):
Remember to Save your changes.
Step 8: Now you'll have to edit this new menu, by adding all the pages you would like in the navigation.
Here the key is to replicate the structure of the default menu called Standardmeny, as we can not hide the new blank search page from the default Standardmeny menu. So when creating this new menu, remember to leave out the newly created search page:
Remember to Save your changes.
Step 9: As the final step, you have to navigatee to Utseende > Teman:
Step 10: Now choose to edit your theme:
Step 11: Here you'll have to edit the menu ("Meny"):
Step 12: When editing the menu, choose the newly create menu you've created in the above steps:
Remember to Save your changes.
Step 13: Once this new blank search page and menu has been published to the webshop, please share the new blank search page URL with Hello Retail - to finalize the setup process of dynamic search.
The new blank search page URL should look something like this: http://YOUR_WEBSHOP_DOMAIN/page/searchresults if you called your page Searchresults.
Configure Webshop
After the installation setup of your platform and the onboarding flow, make sure to have your webshop configured. Read this guide here on how to do so:
