Field-by-Field Guide to the FHR Response

The FHR query response contains all contextual information and data needed to understand the outcome of an FHR query. This page walks through the most important fields of the FHR Query response, explaining what each field and nested object represents, how it’s used, and what values you can expect.

You can find full examples of FHR Query responses here.

To improve readability, the FHR Query response is divided into sections. Parameters listed in each table are shown relative to their section. For example, in the info section, the parameter lang refers to info[].lang.

info

info is an object holding general information about the request and response context.

info[].<parameter>	Data type	Description
lang	string	response language, e.g. "en"
country	string	country/website of the request, e.g. "US"
locale	object	infromation about the locale used for the website
locale[].value	string	locale used for current website, e.g. "en_us"
current-universe	string	FHR catalog/universe used for request, e.g. catalog001
view	string	type of page request made, e.g. "home", "lister", etc.
query	string	exact query sent to FHR
ranges	object	ranges (i.e. filters) applied to the product catalog
ranges[].query-ranges.range	object	list of apllied filters
url	string	unformatted page URL
source-xml	string	source XML
server[].role	string	environment indication, e.g. "staging"

universes

universes is an object containing the core content blocks that drive what users see and interact with on the page.

universes[].<parameter>	Data type	Description
universe	object	full information about defined universe/FHR catalog with applied filters

universes[].universe[].link

universes.universe.link is an object holding information about the link to the root FHR catalog.

universes[].universe[].link.<parameter>	Data type	Description
name	string	name of the root FHR catalog used for this website
url-params	string	URL for the root FHR catalog used for this website

universe[].universes[].facetmap

universe[].universes[].facetmap is an object holding information about all facets available for the current catalog.

universe[].universes[].facetmap[].<parameter>	Data type	Descripti
universe	string	current FHR catalog/universe

universes[].universe[].facetmap[].filter

universe[].universes[].facetmap[].filter is an object containing a list of filters and respective available values.

universe[].universes[].facetmap[].filter[].<parameter>	Data type	Description
title	string	facet title, e.g. "Categories", "Colors"
filtersection	object	list of all available values for a given facet
filtersection[].link	object	name and FHR URL parameters for the facet value
filtersection[].link[].name	string	name of the facet value
filtersection[].link[].url-params	string	FHR URL facet parameters used when when value is used for filtering
filtersection[].value[].value	string	value of facet variant
filtersection[].nr	integer	number of products available for facet variant
filtersection[].custom-fields	object	list of custom fields
filtersection[].custom-fields[].custom-field	object	information about custom field
filtersection[].custom-fields[].custom-field[].value	string	the default state of the facet to be shown on the page; can be either "expanded" or "collapsed"
filtersection[].custom-fields[].custom-field[].name	string	name of the custom attribute
filtersection[].custom-fields[].custom-field[].id	string	id of the custom attribute
on	string	contains the attribute_id the filter is based on, e.g. "price_us"
facetid	string	unique identifier of the facet sent in the FHR product feed
basetype	string	type of facet, e.g. "cat"
show-number-values	integer	number of facet variants to show on the page
display-hint	string	if the facet has been configured as multi-select this shows whether it is "multiselect-or" or "multiselect-and"

Example

universes[].universe[].breadcrumbs

universes[].universe[].breadcrumbs is an object containing information about the breadcrumbs that should be used on the page.

universes[].universe[].breadcrumbs[].crumb

universes[].universe[].breadcrumbs[].crumb is an object containing a list of breadcrumb elements.

universes[].universe[].breadcrumbs[].crumb[].<parameter>	Data type	Description
url-param	string	URL-parameter to the page
name	object	name attributes
name[].value	string	breadcrumb name (title), e.g "kids"
range	object	range selected for a navigation step
link	object	the query that can be sent to FHR if the breadcrumb is removed
link[].url-params	string	full FHR query to the source of the breadcrumb

universes[].universe[].items-section

universes[].universe[].items-section is an object holding information about the products to be shown in the product list.

universes[].universe[].items-section[].results

universes[].universe[].items-section[].results is a object defining how the item list is split into parts in order to be shown on the page.

universes[].universe[].items-section[].results[].<parameter>	Data type	Description
ranking	object	information about the sorting applied to the product lister
ranking[].sort-fields	object	attributes used for sorting and the type of sorting, i.e. descending/ascending
ranking[].sort-fields[].sort-field	object	the sort-fields used in the respective ranking
ranking[].sort-fields[].sort-field[].sort-direction	string	direction of sorting; either "DESC" (descending) or "ASC" (ascending)
ranking[].sort-fields[].sort-field[].sort-attribute	string	attribute used for sorting, e.g. "price"
view-size	integer	amount of products shown per page
total-items	integer	total number of items for a facet combination
start-index	double	index number of the product which should start the list o

Example

universes[].universe[].items-section[].heading

universes[].universe[].items-section[].heading is an object containing all attribute types that are provided for each item.

universes[].universe[].items-section[].heading[].<parameter>	Data type	Description
link	object	data needed for the link that would point to a particular object in the browser
link[].name	string	name of attribute, e.g. "original price"
link[].value[].value	string	the attribute_id that was submitted in the data feed to the Fredhopper; the attribute_id always needs to be used when querying Fredhopper

Examples

universes[].universe[].items-section[].items

universes[].universe[].items-section[].items is an object holding information about all items that are ont he current page of the lister.

universes[].universe[].items-section[].items[].<parameter>	Data type	Description
item	object	all attributes and their values for individual products
item[].id	string	product ID
item[].attribute	object	list of the attributes used for the product; each attribute is defined by an ID and includes values for the particular product
item[].attribute[].name	string	attribute ID, e.g. "brand"
item[].attribute[].name.value	object	values of the attribute for the particular product
item[].attribute[].name.value[].value	string	value of the attributes used for rendering on the page
item[].attribute[].name.value[].non-ml	string	raw format of the value that can be used for processing, e.g. "31.99" instead of "$31.99"

Example

universes[].universe[].themes

universes[].universe[].themes is an object including the list of promotions or merchandising components within the current request.

universes[].universe[].themes[].theme

universes[].universe[].themes[].theme is an object that includes the description and the content of a particular block.

universes[].universe[].themes[].theme[].<parameter>	Data type	Description
title	string	title of the block, e.g. "recommended for you"
slogan	string	description of the block or text to be presented on it, e.g. "buy now!"
link	object	links to the required catalog pages
link[].url-param	string	URL to the required page
link[].type	string	valid for images and banners; possible values are "catalog" (if the rules has been set up to direct the user into a specific location within the catalog) or "URL" (if the rule has been configured to link to a direct URL)
link[].nr	integer	number of products to be shown in the block
static-content	object	all promotion related information for which FHR does not have a semantic understanding, e.g. image references, URLs and static text
static-content[].content	object	one content element of the entire static-content, e.g. an image reference
static-content[].content[].content-value	string	value of the content element
static-content[].content[].content-link	string	selection link for static-content element with image type
items	object	description of the product in the block
items[].item	object	description of a specific product
items[].item[].attribute	object	description of the attributes
items[].item[].attribute[].value[].value	string	value of the attribute used for rendering on the page
items[].item[].attribute[].value[].non-ml	string	raw format of the value that can be used for processing, e.g. "31.99" instead of "$31.99"
items[].item[].attribute[].name	string	attribute ID
items[].item[].id	string	product ID

universes[].universe[].themes[].attribute-types

universes[].universe[].themes[].attribute-types is an object that describes all attributes used for the block.

universes[].universe[].themes[].attribute-types[].<parameter>	Data type	Description
attribute-type	object	list of all attribute in the block
attribute-type[].type	string	FHR type, e.g. "set"

footer

footer is an object containing data for logging and bench-marking.

footer[].<parameter>	Data type	Description
process-time	object	logging information on the current FAS request
process-time[].value	double	amount of that FAS took to answer the current request
process-time[].unit	string	scale of the response time, e.g. "s" (for seconds)

rid

rid contains the response ID that uniquely identifies the response.

Example