Skip to content

BasicProduct

A basic product entity, that is used for search results or categoryviews

Field Type Required Description
id string The unique product id of this product inside the shop (in old cake system: product_number)
active boolean if this product is active or not
availability Availability
identifiers object
manufacturer string The manufacturer or brand of this product
name string The product name to display
stock Stock
rating object The accumulated review data of this product
featuredImageUrl string The main image of this product, displayed in lists or search results
featuredImageBaseUrl string Base URL of the main image of this product, displayed in lists or search results. GET params for width, height, etc needs to be added.
price Price
flags object
liveshoppings array[object] A list of liveshopping-timeframes for this product. By default it will load all timeframes, that ended in the last 7 days, are active or will start in the future.
highlight boolean True if the product is highlighted
parent BasicProduct A basic product entity, that is used for search results or categoryviews
characteristics ProductCharacteristics Special kind of characteristics which are directly label/value mappings for a certain product. Will only be applied, if the product is a variant.
type string Type of the product
one of: simple, parent, variant
tags array[string]
{
"id": "string",
"active": true,
"availability": {
"text": "string",
"state": "ok"
},
"identifiers": {
"sku": "string",
"ean": "string",
"isbn": "string",
"upc": "string",
"pzn": "string",
"mpn": "string"
},
"manufacturer": "string",
"name": "string",
"stock": {
"info": "string",
"orderable": true,
"quantity": 0,
"maxOrderQuantity": 0,
"minOrderQuantity": 0,
"ignoreQuantity": true
},
"rating": {
"count": 0,
"average": 0,
"reviewCount": 0
},
"featuredImageUrl": "string",
"featuredImageBaseUrl": "string",
"price": {
"tiers": [
{}
],
"info": "string",
"unitPrice": 0,
"unitPriceStriked": 0,
"unitPriceMin": 0,
"unitPriceMax": 0,
"unitPriceNet": 0,
"unitPriceWithTax": 0,
"taxAmount": 0,
"taxPercent": 0,
"msrp": 0,
"currency": "EUR"
},
"flags": {
"hasChildren": true,
"hasVariants": true,
"hasOptions": true
}
}