Skip to content

Catagory data

The category feed is used for customers utilizing our search feature, so they can easily find your category pages, and while not a requirement, it is highly advised to set it up.

Note: At this time, customers cannot set up the category feed themselves. Once the category feed is ready, please send it to support@helloretail.com, and our team will handle the setup for you.

Category Data

The feed must include all active categories on the site.

Required fields

Each category entry in the feed must include the following fields:

  • url: URL of the category as it appears on the site.
  • title: Name or title of the category.

Optional Fields

Each category entry in the feed can optionally include the following fields:

  • imgUrl: URL of an an image representing the category
  • hierarchy: Hierarchical structure of the category (e.g., "Men > Shirts").
  • keywords : Keywords associated with the category for search optimization.
  • description: Description of the category.
  • extraData.*: Extra string attributes for the category.
  • extraDataNumber.*: Extra number attributes for the category.
  • extraDataList.* : Extra string list attributes for the category.

Read more about extraData in feeds here.

Example

[
    {
        "id": "72",
        "url": "https://www.domain.com/equipment/bike-equipment/helmets",
        "title": "Helmets",
        "hierarchy": [
            "Equipment",
            "Bike equipment",
            "Helmets"
        ],
        "keywords": "safety bike helmets",
        "description": "Helmets for everyone",
    }
]