Entities
Product
Product base base
Schema
name
string required
Name of the base-product. Variants may also have names for further description.
slug
string required
Slug for usage in URLs.
Product availableVariants availableVariants
Schema
arrayid
string required
name
string required
color
string | string[]
Can either be a single color or an array of colors
size
string
May be clothing-size or other size-information
previewImage
object
Product description description
Schema
stringProduct flags flags
Schema
arrayvariant
string required
Style of the flag.
label
string required
Text of the flag.
Product info info
Schema
cover
Media required
shortDescription
string
Short product description. This may be used as subtitle on product-tiles. Not to be confused with the description-component which is the full html-description of a product.
brand
string
Brand of the product. Can also be used for manufacturer or vendor name.
brandLink
string
Link to the brand-page.
Product media media
Schema
images
__schema0[] required
All images of a product, including the cover-image on index 0.
media
Media[] required
All media: images, videos, 3d models and other media.
Product prices prices
Schema
price
Money required
strikethroughPrice
Money
isOnSale
boolean required
If true, indicates that the product is discounted from its original price. See `strikethroughPrice` for the original price and `savingsPercent` for the percentage of discount.
savingsPercent
number
Percentage of discount from the `strikethroughPrice`.
isStartingFrom
boolean required
If true, indicates that there are multiple variants with different prices. Can be used in the frontend to indicate a starting-from price, e.g. "from 100 EUR".
unitPrice
UnitPrice
Product rating rating
Schema
average
Rating required
count
number required
Number of ratings.
Product seo seo
Schema
title
string
description
string
robots
string
E.g. "index, follow", "noindex, nofollow", etc.