Public Products

Link

object
canonicalstring

Canonical link to the product on the third-party website.

urlstring

URL to a third-party desktop page of the product.

Example

PartialBrand

object

Represents the sub brand and parent brand information.

codestring
namestring
Example

PriceQuantityUnit

object

Represents the current price and quantity (within a region).

display_quantitystring

The quantity and unit to display in the frontend.

original_pricenumber(float)

The original price if price is the discounted value.

pricenumber(float)

The price.

quantitynumber(float)

The quantity the price is based on.

unitstring

The price unit.

varying_quantityboolean

Whether the quantity is flexible or fixed.

Example

Product

Represents a product in the API.

boss_numberstringrequired

Product ‘boss number’. It is represented as string because the number can have leading zeros.

brandobject

Represents the Brand information.

Show Child Parameters
categoriesarray[object]

Represents the category basic information.

Show Child Parameters
energy_efficiencyobject

Represents information about energy efficiency in the API.

Show Child Parameters
idstringrequired
imagestring

Main product image (Rokka stack URL template).

image_transparentstring

Main product image, transparent (Rokka stack URL template).

linksobject
namestringrequired
priceobject

Price. It is complicated.

Show Child Parameters
ratingsobject

Represents the ratings of an item, e.g. product.

Show Child Parameters
slugstringrequired

Unique user-friendly ID.

Example

ProductCollection

object

A list of Products

productsarrayrequired

Represents a product in the API.

Show Child Parameters
total_hitsintegerrequired

The total hits may exceed the actual count of results in the collection.

It represents the total number of results of a search and not only the potentially paginated subset.

Example