Supplying content data

Supplying content data

Contents

  1. Introduction
  2. Categories
  3. Site pages
  4. Blog posts
  5. Brands
  6. Available shop integrations
  7. Providing content data
  8. Recurring content feed
  9. Manual content upload
  10. XML format
  11. CSV format

Introduction

In order for the helloretail search-feature to work with content we need to have information about the content in your web-shop. We require that each content has a title and a unique URL, and preferably they also have a description, keywords and maybe a hierarchy.

Currently our system can distinguish between these content types:

  • Categories
  • Site pages
  • Blog posts
  • Brands

Categories

Categories is a specific content type that resembles an item category in your shop. This could be "Shoes", or more specifically "Shoes for men".
Observe that "Shoes for men" can be a sub-category of "Shoes" and therefore categories can be part of a hierarchy.
Normally categories do not need to much more data than:

  • Title
  • URL
  • Hierarchy

Site pages

Site pages is a specific content type that resembles an info page in your shop. Examples could be: "Opening hours" or maybe "Contact us".
Normally site pages do not need to have much more data than:

  • Title
  • URL

Blog posts

Blog posts is a specific content type that resembles content related to your shop. These could be "Wooden shed DIY" or "Protein pancake recipe".
Normally blog posts do not need to have much more data than:

  • Title
  • URL

Brands

Brands is a specific content type that reminds a lot like categories, but is only focused on the specific product brands that your shop is selling.
Normally brands do not need to have much more data than:

  • Title
  • URL

Available shop integrations

Before we get any further, take a look at the list of integrations below - if you are running any of these platforms you should skip the step about creating a feed, make sure you have followed our guide for that platform and go down to the "supplying your feed to helloretail" step:

Please note, that our integrations are updated and expanded regularly so always make sure that you have the newest edition. If you have any question please reach out to support@helloretail.com

Providing content data

There are two ways of providing helloretail with content data:

  1. Recurring content feed
  2. Manual content upload

Recurring content feed

If your platform wasn't on the list in Available shop integrations you will have to provide the feed yourself.

What is a feed you might ask? well to put it simple it is a file containing a list of entries of a specific content type. Here is an example.
A recurring feed is a feed that helloretail call regularly to re-apply its content into helloretail. It is therefore optimal if your feed is constantly updated and readily available to helloretail via an URL.
I.e. like this: https://www.yourdomain.com/feeds/categoryfeed.xml
The smart thing about a recurring feed, is that you don't have to log in and upload a file manually each time you want to make changes to the content data already provided to helloretail.

The structure of your content feed can be in either XML, CSV or JSON.

To provide a recurring content feed:

  1. Log in to helloretail
  2. Choose the right shop you want to give content
  3. In the left menu bar click "Data Setup"
  4. Under Data Setup click "Contents"
  5. Click the button "Set up automatic content synchronisation" and pick the right content type.
  6. Alternatively: Choose one of your existing content feeds from the list shown on the page and click "edit" if you need to make changes.
  7. You will now land on a new page, where you should choose the shop platform matching your web-shop. If yours is not there, choose "Other".
  8. Fill in the requested information.
  9. Contact support@helloretail.com and they will configure our system to call your feed regularly.

Manual content upload

A manual content upload is an easy way of getting up and running, when your shop do not have a content feed available.
The upload file format is required to be CSV.

Note: A manual content upload will override any of your existing content of that type.

To provide a manual content upload:

  1. Log in to helloretail
  2. Choose the right shop you want to give content
  3. In the left menu bar click "Data Setup"
  4. Under Data Setup click "Contents"
  5. Click the button with the text "Upload a file".
  6. Choose the right content type in the button drop-down.
  7. A panel shows up, click the button with the text "Browse" and after that click "Upload".
  8. Observe your file being processed.

If you have any questions or need help contact support@helloretail.com

XML format

Below you can see an example structure of a category XML file:

<categories>
 <category>
  <title>Summer dresses</title>
  <url>https://mysite/summer-dresses</url>
  <description>We have the best summer dresses in the world</description>
  <keywords>Sundress One-piece</keywords>
  <hierarchy>
   <category>Woman</category>
   <category>Dresses</category>
   <category>Summer dresses</category>
  </hierarchy>
 </category>
 <category>
  <title>Autumn dresses</title>
  <url>https://mysite/autumn-dresses</url>
  <description>We have the best summer dresses in the world</description>
  <keywords>Sundress One-piece</keywords>
  <hierarchy>
   <category>Woman</category>
   <category>Dresses</category>
   <category>Autumn dresses</category>
  </hierarchy>
 </category>
</categories>

Note on category hierarchy: A Hierarchy is a structured list of a category and its parent categories - very similar to the breadcrumb navigation you can see on most webshops:
"Woman > Dress > Summer dresses".  Please note that its should include the current category, and not just the parent categories.

CSV format

The delimiter of the CSV file needs to be:

;

Column structure of the CSV file has to be in this fixed order:

title; url; hierarchy; searchable keywords; description

Below you can see an example structure of a category CSV file:

Category title; http://example.com/categories/1/2/3; category hierarchy 1, category hierarchy 2, category hierarchy 3; keyword1 keyword2; This is an example description
Baby sandals; http://example.com/shoes/baby/sandals; Shoes, Baby, Sandals; baby shoes sandals babies boy girl; Category containing the most beautiful sandals for your baby
Reply Oldest first
  • Oldest first
  • Newest first
  • Active threads
  • Popular
Follow
  • 3 mths agoLast active
  • 194Views
  • 1 Following