Hello Retail API
In this guide, you can read and learn about everything related to the Hello Retail API such as how to locate the API credentials which are your website's unique id (also known as website UUID) and your API key.
Furthermore, you can read and learn about expectations when setting up your solution through the Hello Retail API.
In order to use the Hello Retail resource API, you need to know your website UUID and you need to have an API key.
Credentials
Website UUID
- Start by logging into your Hello Retail account. On the dashboard view, navigate to the left-hand side menu. Under the Configuration section, click on Settings to unfold the drop-down menu.
- Next, from the drop-down menu, click on Website Settings.
- Under the heading General, you can see the website UUID field which you can copy and paste for different use cases.
API Key
- Start by logging into your Hello Retail account. On the dashboard view, navigate to the right-hand upper corner.
Under the User
symbol, from the drop-down menu, click on API Keys. From here, you will be able to see the input field where you can write an identification tag for the API key that you are about to create.
Since this key is to be used for queueing product feed runs, you could call it "queue product feed runs" as a suggestion. The naming is of course entirely up to you. This will help to differentiate between the cases of multiple keys.
When you have given it a tag, then click on the Create button. An API key should then be generated and shown on the overview API Keys page.
Note Be very cautious about who you share this API key with. This key should be considered as the same level of sharing your password to your Hello Retail account.
What Can You Expect When Setting Up with the Hello Retail API
It is important to note here for the purpose of standardizing and aligning expectations when setting up your webshop and solution through the API that there are some confinements on what Support will be able to directly change and assist with.
Examples of Employing the API within Recommendations
It is not possible from Support's side to adjust your recommendation design in the use cases where your request URLs have been formatted as JSON.
This is because Support will be looking into the data and parameters provided by you, particularly within the request URLs. This means that in the cases where wrong products are shown on a product page then it will be subjected to yourself on adjusting this correctly.
This is on the account of Support only being able to work with the hierarchies from the request URL.
You can read more about categories (also known as hierarchies) from here.
If needed for more in-depth and technical API documentation then please check out this page here.
If you have any questions about this guide, then please contact Support or your designated Account Manager about this.