post

/shopgate.catalog.getProductRelations.v1

Requests all related products to the given productId and returns them as array.

Request Body

Schema
object
productId
string
required
type
string
required
Allowed Values: crossSelling, upselling, bonus, boughtWith, custom
limit
integer
offset
integer

Responses

1 Example
Schema
object
relations
array[object]
required
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
object
identifiers
object
manufacturer
string

The manufacturer or brand of this product

name
string

The product name to display

stock
object
rating
object

The accumulated review data of this product

featuredImageUrl
string

The main image of this product, displayed in lists or search results

price
object
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
object

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

characteristics
array

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

1 validation
tags
array[string]

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
host