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 async src="https://helloretailcdn.com/helloretail.js"></script>
<script>
    window.hrq = window.hrq || [];
    hrq.push(['init', {}]);
</script>

The API is located at core.helloretail.com.

Waiting for the script to be ready

When using the JavaScript SDK it is important that you ensure that the Hello Retail script is ready before calling the methods. This can be done in two ways. You can either use the command queue (hrq) to make your calls. When done in this way, the script will automaticall wait with executing them until it is ready. Alternatively you can add a callback that will be notified once the SDK is ready. This callback will be passed a sdk-object that can be used to call the method.:

To wait for the SDK object to be ready you push a callback method to the command queue

hrq = window.hrq || [];
hrq.push(function(sdk) {
    // The sdk object is ready to use. You could use it to track a cart for instance
    sdk.setCart({total:314, productNumbers:["p1", "p2"]});
});

Alternatively you can push the command you want to execute directly to the command queue. The example from above would look like this:

hrq = window.hrq || [];
hrq.push([
    "setCart",
    {
        total: 314,
        productNumbers: ["p1", "p2"]
    }
]);

If you are just executing a single SDK method then the command queue approach is probably the simplest. If you have to call multiple methods it might be more clean to get hold of the SDK object and keep using that.

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.

Forcing a specific website

The Hello Retail script will automatically detect what website it is on. If you are working from a different domain you can force the script to serve content fro a specific website. To do that, you need to add the websiteUuid parameter to the Hello Retail JavaScript.

You can find the websiteUuid 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.

<script async src="https://helloretailcdn.com/helloretail.js"></script>
<script>
    window.hrq = window.hrq || [];
    hrq.push(['init', 
        {
            websiteUuid: "{{ website uuid }}"
        }
    ]);
</script>