Products

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

IngredientsInformation

object
additives_informationOne Of

Information about additives.

AdditivesInformationobject
Show Child Parameters
allergens_informationOne Of

Information about allergens.

AllergensInformationobject
Show Child Parameters
ingredients_of_concernarray[string]

Ingredients of concern.

ingredients_textstring

Ingredients declaration text.

substances_informationOne Of

Information about containing substances.

SubstancesInformationobject
Show Child Parameters
Example

ItemRatings

object

Represents the ratings of an item, e.g. product.

average_allnumber(float)required
count_allintegerrequired

Average rating.

Example

ItemUsage

object
idstring
namestring
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