Onboarding on/migrating to Fredhopper

If you are onboarding on Fredhopper or migration from previous FHR DATA API based on CSV or JSON files, please follow mapping below how to represent Fredhopper data types in the items API.

FHR to Items API data type mapping

Mapping

categories attribute (i.e. hierarchical type) is mandatory on parent item creation (POST operation) and contains a list of item's leaf category ids.

FHR	Items API	Translatable
int	INTEGER	✘
float	FLOAT	✘
text	TEXT	✘
asset	LOCALIZEDTEXT	✔
list/list64	OBJECT	✔
set/set64	OBJECTLIST	✔
hierarchical	LIST	✔

Examples Multi-locale catalog

INTEGER (FHR int)

{
    "attributes": {
        "in_stock": 1
    }
}

FLOAT (FHR float)

{
    "attributes": {
        "price": 33.3
    }
}

TEXT (FHR text)

{
    "attributes": {
        "_imageurl": "https://example.com/media/main_img.jpg"
    }
}

LOCALIZEDTEXT (FHR asset)

{
    "attributes": {
        "display_name": {
            "en_GB": "World Cup Boots",
            "fr_FR": "Chaussures World Cup"
        }
    }
}

OBJECT (FHR list/list64)

{
    "attributes": {
        "color": {
            "value_id": "red",
            "value": {
                "en_GB": "Red",
                "de_DE": "Rot"
            }
        }
    }
}

OBJECTLIST (FHR set/set64)

{
    "attributes": {
        "colors": [
            {
                "value_id": "red",
                "value": {
                    "en_GB": "Red",
                    "de_DE": "Rot"
                }
            },
            {
                "value_id": "blue",
                "value": {
                    "en_GB": "Blue",
                    "de_DE": "Blau"
                }
            }
        ]
    }
}

Fredhopper requires for localisable attributes the locale to be sent, even if the catalogue contains only a single locale

Attribute type Object/ObjectList

The attribute type Object and ObjectList must have the following structure and be set at the root level of the schema or variant:

[
    {
        "name": {attribute_name},
        "type": "OBJECT" | "OBJECTLIST",
        "attributes": [
            { "name": "value", "type": "LOCALIZEDTEXT"},
            { "name": "valueId", "type": "TEXT"}
        ]
    }
]

FHR data model validation

The new items API supports a more flexible data model which may not always be supported by the Fredhopper platform. The query parameter fhrValidation=true can be added to enforces Fredhopper specific validation to the schema API, the category API and the items API to ensure all the data can correctly be indexed.