Products

Pictogram

object

Represents a Pictogram (or Eyecatcher) on a product.

descriptionstring
imageobject

An image and its properties.

Show Child Parameters
label_codestring

Label code of the pictogram or eyecatcher.

pop_blacklistboolean

Specifies if this pictogram should not be output on the POP template.

pop_orderinteger

Order in which this pictogram should show up on POP labels, only present if popWhitelist is true.

The sort order is ascending, low number means the feature should come early.

pop_pictogramboolean

Specifies if the image for this pictogram should be output on the POP template.

pop_whitelistboolean

If this pictogram should be output on the POP template

value_codestringrequired

Value code of the pictogram or eyecatcher.

Example

Pop

object

Represents POP Label fields on a product.

approvalbooleanrequiredDEPRECATED

If the POP data is validated and allowed to be printed. False by default.

imagesarray[object]DEPRECATED

An image and its properties.

Show Child Parameters
templatesarray[object]DEPRECATED

Represents a POP template on a product.

Show Child Parameters
Example

PopTemplate

object

Represents a POP template on a product.

catalogstring

The catalog this template belongs to.

codestringrequired

The field that is called “code” on the pop template. This field can be used to identify the template.

languagestring
print_only_whitelist_featuresboolean

If we should only print the whitelisted ones, or also other ones.

Example

Preparation

object
informationstring

Information about the preparation.

usage_instructionsstring

Instructions of the usage of the product.

Example

Price

object

The price of a product that is mapped on the product model.

currencystring
estimated_piece_pricenumber(float)

The estimated price of a piece.

Some products that are usually sold by weight (fruit, vegetables, meat). But aMigos
needs to know the estimated price based on the average weight of one piece as it
is added to the cart by number and not by weight.

estimated_piece_weightnumber(float)

The estimated weight of a piece (in grams).

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

itemOne Of
PriceQuantityUnitobject

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)required
valid_tostring(date)required
baseOne Of
PriceQuantityUnitobject

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

Show Child Parameters
Example