post

/shopgate.catalog.getProduct.v1

This pipeline is used to retrieve one specific product. Mainly used for deeplinks to the detail page, because the relevant data is normally already fetched by the getProducts_v1 which is the logical step before the detail page, if not arrived by a deeplink.

Request Body

Schema

object

productId

string

required

Responses

Successful response.

1 Example

Schema

object

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

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

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

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

{#/definitions/BasicProduct}

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

Send a Test Request

Send requests directly from the browser (CORS must be enabled)

$$.env

1 variable not set

host