Shoporama Installation Guide

Shoporama Installation Guide

Add the Hello Retail partner JavaScript

For Hello Retail to work on your webshop, you'll have to add the partner JavaScript. Please follow these simple steps to do this.

Step 1: Start by logging into Shoporama admin – then navigate to Settings ("Indstillinger")


Step 2: Navigate to HTML-fields ("HTML-felter") – to Add a new HTML-field ("Tilføj nyt HTML-felt"):


Step 3: Provide a name for this new HTML-filed, e.g.: "HelloRetail" and click OK:


Step 4: Select <body> in the drop-down and paste in your Hello Retail partner JavaScript:

<script type="text/javascript">
        (function() {
            var aws = document.createElement('script');
            aws.type = 'text/javascript';
            if (typeof(aws.async) != "undefined") { aws.async = true; }
            aws.src = (window.location.protocol == 'https:' ? '' : '') + '/scripts/company/awAddGift.js#YOUR_PARTNER_ID';
            var s = document.getElementsByTagName('script')[0];
            s.parentNode.insertBefore(aws, s);

Important: Once you have pasted it you should replace YOUR_PARTNER_ID with your own Hello Retail ID. You can find this by logging into your account.

Remember to Save ("Gem")

Share your Product feed with Hello Retail

For Hello Retail to know all the products in your webshop, please share your product feed with Hello Retail.

Your default Shoporama product feed should be available via the URL: http://YOUR_WEBSHOP_DOMAIN/product-feed.xml Note: you should replace YOUR_WEBSHOP_DOMAIN with your actual webshop domain name. 

Share conversion data with Hello Retail

For Hello Retail to continuously improve the recommendation algorithms for your webshop visitors as well as be able to report sales performance metrics –it's important for you to share the conversions with Hello Retail.

You simply do this, by adding a "conversion span" to the order receipt page. Here's a simple guide on how to do this:

Identify the templated called: thanks.html among your theme templates (either in Git/Github or as local files).

Once you've identified this file, please copy/paste the following code – into the bottom of the thanks.html template:

<{if $order}>
<span class="addwish-conversion" style="display:none;" data-ordernumber="<{$order->getWebshopOrderId()}>" data-total="<{$order->getPrice()}>" data-email="<{$order->getEmail()}>">
<{assign var="products" value=$order->getProducts()}>
<{section name="i" loop=$products}>
<span class="addwish-product" data-productnumber="<{$products[i]->getProductId()}>" data-quantity="<{$products[i]->getAmount()}>"></span>

Remember to Save and Publish the template.

Add a blank search page

For Hello Retail dynamic search to work, you'll have to create a blank search page and share it with Hello Retail – to complete the setup.

Please follow these simple steps, to create a new search page:

Step 1:  Start by logging into Shoporama admin – then navigate to Statiske sider > Opret ny side:


Step 2: Choose a suitable name for the new blank search page, e.g. "Search results":
Remember to Save.

Note: If you are using the default theme, this new page will automatically show up in the navigation – if this is the case, please remove the page from the navigation.

Step 3: Once this new page has been saved, you'll see the page in the Pages list:


Step 4: Finally, send the URL of the created search page to to have the setup completed.

How to set up API for Shoporama

Log into your Shoporama Backend --> Shoporama admin.


Step 1: First, navigate to the API Settings inside your Shoporama Backend. 

Click the little wheel in the top-right corner like shown in the image. 

 Step 2:  Within the Setting Panel, click the three dots to the right and select API from the drop-down menu. 

 Step 3: Now you want to add an API for Hello Retail to use. This is done by clicking the "Tilføj adgang" button. 

 Step 4: Insert a name you can remember that indicates that this API is used by Hello Retail. We simply named it Hello Retail. Then click "Save". 

Step 5: The last step is to copy the API Key and insert it into your Hello Retail backend.

Like Follow
  • 1 yr agoLast active
  • 198Views
  • 1 Following