Categories

AbstractCollection

A generic collection of elements.

AbstractSearchResultCollection

object

A collection of search result instances.

idsarray[string]

Ids only.

Is filled instead of the usual property for content, with only the ids when a call is made with verbosity=id on a
route that supports it.

total_hitsinteger

The total hits may exceed the actual count of results in the collection.

It represents the total number of results of a search and not only the
potentially paginated subset.

Example

BaseCategory

object

Represents the category basic information.

abstractstring

A short, plain text description, e.g. suitable for the page meta element.

codestringrequired

ID of the category.

headlinestring

The caption to the description.

imageOne Of

Image of the category.

Imageobject

An image and its properties.

Show Child Parameters
keywordsarray[string]

Keywords, e.g. suitable for the page meta element.

levelinteger

Category level.

namestringrequired
parent_codestring

Parent category ID.

slugstringrequired

Unique user-friendly ID.

titlestring

The title, e.g. suitable for the page title element.

visibleboolean

Whether the category should be shown to users.

Example

Category

object

Represents the category information including its ancestors and children.

abstractstring

A short, plain text description, e.g. suitable for the page meta element.

codestringrequired

ID of the category.

headlinestring

The caption to the description.

imageOne Of
Imageobject

An image and its properties.

Show Child Parameters
keywordsarray[string]

Keywords, e.g. suitable for the page meta element.

levelinteger

Category level.

namestringrequired
parent_codestring

Parent category ID.

slugstringrequired

Unique user-friendly ID.

titlestring

The title, e.g. suitable for the page title element.

visibleboolean

Whether the category should be shown to users.

ancestorsarray[object]

Represents the category basic information.

Show Child Parameters
childrenarray[object]

Represents the category basic information.

Show Child Parameters
generic_productsarray[string]

List of generic product BoSS numbers.

The BoSS number from the BoSS/BeSS mapping, so that the app can query for categories by BoSS number.

google_product_categoriesarray[string]

List of google taxonomy IDs this category maps to.

See https://support.google.com/merchants/answer/6324436?hl=en and https://www.google.com/basepages/producttype/taxonomy-with-ids.de-CH.txt
It’s based on the field “googletaxonomy” coming from PEx.

slugsobjectrequired

Represents a list of multilingual slugs.

Show Child Parameters
updated_atstring(date-time)required

Time when category was last indexed (or partially updated) with modifications in Elasticsearch.

When a category did not change after mapping, it is not re-indexed and thus the timestamp is not updated as well.

visible_navigationboolean

If set to false, the category should not be displayed in navigation, but may still be displayed in
search suggestions or similiar (e.g. ‘Fussball EM 2016’).

It’s based on the same field coming from PEx.

visible_shopboolean

If set to false, the category should not be displayed anywhere (e.g. ‘Dienstleistungen’).

It’s based on the same field coming from PEx.

Example

CategoryCollection

object

A collection of category instances.

idsarray[string]

Ids only.

Is filled instead of the usual property for content, with only the ids when a call is made with verbosity=id on a
route that supports it.

total_hitsintegerrequired

The total hits may exceed the actual count of results in the collection.

It represents the total number of results of a search and not only the
potentially paginated subset.

categoriesarray[object]required

Represents the category information including its ancestors and children.

Show Child Parameters
Example