Category
objectRepresents the category information including its ancestors and children.
A short, plain text description, e.g. suitable for the page meta element.
ID of the category.
The caption to the description.
One OfAn image and its properties.
Show Child Parameters
Keywords, e.g. suitable for the page meta element.
Category level.
Parent category ID.
Unique user-friendly ID.
The title, e.g. suitable for the page title element.
Whether the category should be shown to users.
Represents the category basic information.
Show Child Parameters
Represents the category basic information.
Show Child Parameters
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.
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.
Represents a list of multilingual slugs.
Show Child Parameters
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.
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.
If set to false, the category should not be displayed anywhere (e.g. ‘Dienstleistungen’).
It’s based on the same field coming from PEx.
CategoryCollection
objectA collection of category instances.
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.
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.
Represents the category information including its ancestors and children.
Show Child Parameters
CategoryNode
objectRecursive element of the category tree.
This is an alternate representation of categories instead of Category & BaseCategory to output the tree structure
on the dedicated API end point.
ID of the category.
CategoryStoreOrderCollection
objectA collection of category instances for a store order.
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.
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.
Represents the category information including its ancestors and children.
Show Child Parameters
The store for which the categories are ordered.
If no data has been available for the requested store, the value of this field is “default”.
Image
objectAn image and its properties.
Code for the image, useful for pictograms.
Image URL with placeholders for {width} and {height}.
Image description, useful for example as alt attribute.
End date of the validity.
Sha1 hash of original image.
Full size image.
Source where the image comes from originally.
Image URL with a placeholder for a Rokka {stack}.
Start date of the validity.