Public Products

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

ProductPrice

object

Price. It is complicated.

baseobject

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

Show Child Parameters
currencystring
discountobject

Represents the Discount information.

Show Child Parameters
discount_hintstring
estimated_piece_original_pricenumber(float)

The estimated original price of a piece, without discount.

estimated_piece_pricenumber(float)

The estimated price of a piece.

Some products that are usually sold by weight (fruit, vegetables, meat). This value is the estimated price based on the average weight of one piece.

estimated_piece_weightnumber(float)

The estimated weight of a piece (in grams).

The average weight that the estimated piece price is calculated on.

itemobject

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

Show Child Parameters
no_price_hintstring

The price hint if no price is set.

sourcestring
valid_fromstring(date-time)required
valid_tostring(date-time)required
Example