Entities
Product definition
Information about the Product entity, its components, queries and links
Overview
- Entity Name:
Product
Product: A buyable good or service that can be offered in an e-commerce store. A Product only holds general informations. It is not buyable by itself. Instead each Product acts as an aggregation. You can use the link to the ProductVariant entity to retrieve detailed product data.
Components
Product Base
- Component Token:
base - Token path:
Product.base
Properties
| Name | Type | Description |
|---|---|---|
name | string | Name of the base-product. Variants may also have names for further description. |
slug | string | Slug for usage in URLs. |
Queries
- ProductBySlug - Retrieve a single product by its slug.
- ProductsByCategorySlug - Retrieve multiple products by a category slug.
- ProductsSearch - Search for products using a given query string.
Links
- ProductBreadcrumb
BreadcrumbItemmulti- Used for displaying a breadcrumb on the pdp. - ProductReviews
Reviewmulti- User generated product reviews. - ProductVariants
ProductVariantmulti- Link to the actual buyable good or service. A Product must always link to at least one ProductVariant.
Related actions
- CreateReview - Create a new user review for a 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 description description
Schema
html
string required
Product flags flags
Schema
arrayvariant
string required
Style of the flag.
label
string required
Text of the flag.
Product info info
Schema
cover
__schema0 | object 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
object | object | object | object | object
Product media media
Schema
images
__schema0[] required
All images of a product, including the cover-image on index 0.
media
__schema0 | object[] required
All media: images, videos, 3d models and other media.
Product prices prices
Schema
price
__schema0 required
strikethroughPrice
__schema0
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
object
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.