Skip to content

Introduction

The API documentation will guide you on how to use the REST API or JavaScript SDK to set up the Hello Retail products: Search, Recommendations, Pages, Triggered Emails, and Newsletter Content. You have access to the JavaScript SDK if you have the tracking script added to your website.

You can copy our tracking script below.

<script>
    (function() {
        var aws = document.createElement('script');
        aws.type = 'text/javascript';
        if (typeof(aws.async) != "undefined") { aws.async = true; }
        aws.src = 'https://d1pna5l3xsntoj.cloudfront.net/scripts/company/awAddGift.js#8A118134544885358362CE900752DD32';
        var s = document.getElementsByTagName('script')[0];
        s.parentNode.insertBefore(aws, s);
    })();
</script>
The API is located at core.helloretail.com.

Event binding

When using the JavaScript SDK it is important that you ensure that the Hello Retail script has been loaded before calling the methods. In most cases, it means wrapping the calls in an event-binding function like:

_awev=(window._awev||[]);_awev.push(["bind", "context_ready", some_callback_method()]);
You can read more about the event-binding options here.

General support documentation

If you are looking for general support documentation, it can be found here.

If you want a cookbook on how to begin setting up the solution through the API, read this support article.

If you can't find the answer you are looking for here, feel free to reach out to the Hello Retail support team via phone or email.

Working from localhost

When working from localhost, you can pull the data from a specific webshop you are developing for. To do that, you need to add the website_uuid parameter to the Hello Retail JavaScript.

You can find the website_uuid parameter by navigating to the Settings on the Dashboard, then clicking on the Website Settings in the dropdown menu, and proceeding to the Website unique id from the General section, where you can copy the value and paste it into your Hello Retail script.

Website Settings

<script>
    (function() {
        var aws = document.createElement('script');
        aws.type = 'text/javascript';
        if (typeof(aws.async) != "undefined") { aws.async = true; }
        aws.src = 'https://d1pna513xsntoj.cloudfront.net/scripts/company/awAddGift.js#{{partner id }},tracking_optout=true,{{website_uuid}}';
        var s = document.getElementsByTagName('script')[0];
        s.parentNode.insertBefore(aws, s);
    })();
</script>