Suggestions

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

GenericProduct

object
category_codestringrequired
idintegerrequired

Whether or not a product should be shown in EKL search.

show_in_ekl_searchboolean
imageOne Of
Imageobject

An image and its properties.

Show Child Parameters
namestringrequired
synonymsarray[string]
Example

Image

object

An image and its properties.

codestringDEPRECATED

Code for the image, useful for pictograms.

customstringDEPRECATED

Image URL with placeholders for {width} and {height}.

descriptionstringDEPRECATED

Image description, useful for example as alt attribute.

end_datestring(date-time)DEPRECATED

End date of the validity.

hashstringDEPRECATED

Sha1 hash of original image.

originalstringDEPRECATED

Full size image.

sourcestringDEPRECATED

Source where the image comes from originally.

stackstringDEPRECATED

Image URL with a placeholder for a Rokka {stack}.

start_datestring(date-time)DEPRECATED

Start date of the validity.

tagsarray[string]DEPRECATED
Example

Label

object

Represents the Label information in the Product.

abstractstring

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

descriptionstring

The long description of the label (can contain HTML).

headlinestring

The caption to the description.

idstringrequired

ID of the label.

imageOne Of

Image of the label.

Imageobject

An image and its properties.

Show Child Parameters
keywordsarray[string]

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

linksobject

Collection of links indexed by string identifier.

namestringrequired

Name of the label.

position_for_product_titlestring

Position of label short name for the product title

short_name_for_product_titlestring

Short name of label for the product title

slugstringrequired

Unique user-friendly ID.

tagsarray[string]

Tags for flagging certain labels.

titlestring

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

Example

Link

object
app_urlstring

URL to a third-party mobile app (only provided on the migros_online link).

canonicalstring

Canonical link to the product on the third-party website.

imageOne Of

Associated logo.

Imageobject

An image and its properties.

Show Child Parameters
mo_product_idstringDEPRECATED

The migros online product id (only provided on the migros_online link).

mobile_urlstring

URL to a third-party mobile page of the product (optional).

namestringDEPRECATED

Human readable name of the third-party website (for example SportXX, micasa, Migipedia).

purchasablebooleanDEPRECATED

Whether this links leads to an onlineshop page where the product can be purchased.

tablet_urlstring

URL to a third-party tablet page of the product (optional).

typestringDEPRECATED

The link type, one of ‘shop’ and ‘info’.

urlstring

URL to a third-party desktop page of the product.

Example