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

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
text
string

Text to describe the availability of this product

state
string

A kind of flag, that describes the availability state of this product

1 validation
identifiers
object
sku
string

should always be used for visual representation instead of id if not explicitly given, this will be the same as id (product_number_public in cake)

required
ean
string

The European Article Number of this product

isbn
string

The International Standard Book Number of this product

upc
string

The Universal Product Code of this product

pzn
string

The “Pharmazentralnummer” of this product

mpn
string

The Manufacturer Product Number of this product

manufacturer
string

The manufacturer or brand of this product

name
string

The product name to display

stock
object
info
string

A custom text concerning stock (see available_text in old cake system)

orderable
boolean

A boolean flag that determines if the product it orderable at all

quantity
integer

The amount of products that are available

1 validation
maxOrderQuantity
integer

The maximum of amount of items that are orderable in one order

1 validation
minOrderQuantity
integer

The minimu amount of items that have to be ordered of this product

2 validations
ignoreQuantity
boolean

If true, this will allow the customer to buy more products than are available in stock

1 validation
rating
object

The accumulated review data of this product

count
integer

The amount of star-ratings

1 validation
average
number

The average score of the star-ratings

3 validations
reviewCount
integer

The amount of reviews

1 validation
featuredImageUrl
string

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

price
object
tiers
array[object]

A list of tier prices for this product, if available

info
string

Additional text which should be displayed near the price, like “12,40€/kg” (amount_info_text in old cake system)

unitPrice
number

The price in the shop’s selected currency (unit_amount_display/100 in old cake system), which already includes possible customer group discounts

1 validation
unitPriceStriked
number

The crossed out price in the shop’s selected currency (unit_amount_display_old/100 in old cake system)

1 validation
unitPriceMin
number

The price of the cheapest variant or child product in the shop’s selected currency (unit_amount_display_min/100 in old cake system), which already includes possible customer group discounts

1 validation
unitPriceMax
number

The price of the most expensive variant or child product in the shop’s selected currency (unit_amount_display_min/100 in old cake system), which already includes possible customer group discounts

1 validation
unitPriceNet
number

The net price in the shop’s selected currency (unit_amount_display/100 in old cake system)

1 validation
unitPriceWithTax
number

The price with tax in the shop’s selected currency (unit_amount_display/100 in old cake system)

1 validation
taxAmount
number

The amount of the taxes (unitPriceWithTax - unitPriceNet) in the shop’s selected currency

1 validation
taxPercent
number

The tax percentage for product

1 validation
msrp
number

The manufacturer’s suggested retail price in the shop’s selected currency

1 validation
currency
string

The currency code for this value

1 validation
flags
object
hasChildren
boolean

A flag that determines if this product has children, they have to be loaded seperately at the detail page by using getProductChildren_v1 pipeline

hasVariants
boolean

A flag that determines if this product has variants, they have to be loaded seperately at the detail page by using getProductVariants_v1 pipeline

hasOptions
boolean

A flag that determines if this product has options, they have to be loaded seperately at the detail page by using getProductOptions_v1 pipeline

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.

from
string

The exact start-time for this liveshopping entry

1 validation
to
string

The exact end-time for this liveshopping entry

1 validation
highlight
boolean

True if the product is highlighted

parent
object

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

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
{#/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
tags
array[string]
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

Allowed Values: simple, parent, variant
tags
array[string]

Send a Test Request

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