Products Related

BadgeSignet

A badge signet and its properties.

customstring

Image URL with placeholders for {width} and {height}.

hex_colorstring

The hexadecimal color code for this badge.

originalstring

Full size image.

stackstring

Image URL with a placeholder for a Rokka {stack}.

vectorstring

Vector image.

Example

Base

object
descriptionstring

Base description.

operatorstring

Base operator.

quantityOne Of

Base quantity.

ValueWithUnitobject
Show Child Parameters
Example

BaseCategory

object

Represents the category basic information.

abstractstring

A short, plain text description, e.g. suitable for the page meta element.

codestringrequired

ID of the category.

headlinestring

The caption to the description.

imageOne Of

Image of the category.

Imageobject

An image and its properties.

Show Child Parameters
keywordsarray[string]

Keywords, e.g. suitable for the page meta element.

levelinteger

Category level.

namestringrequired
parent_codestring

Parent category ID.

slugstringrequired

Unique user-friendly ID.

titlestring

The title, e.g. suitable for the page title element.

visibleboolean

Whether the category should be shown to users.

Example

BaseDiscount

object

Represents the Discount information.

additional_descriptionstring

Description text for a discount

E.g.
Zucht aus Dänemark

additional_textstring

Additional information about the discount, e.g. ‘in Selbstbedienung und Bedienung’

advertisement_type_idstring

ID of how to advertise this discount.

An example usage is to distinguish if the price or the percentage should be promoted more.

badgeOne Of

The currently active badge.

This field is only available when using the Discount model to consume MAPI data.

Badgeobject

A badge image and its properties.

Show Child Parameters
boss_numberstring

The BoSS number.

campaign_idsarray[string]

List of campaign ID’s this discount is in.

These campaign ID’s are delivered by the M-Promo system, used for promotions.

channelstring
collective_discountboolean

Collective discount (Sammelaktion).

conditionsOne Of
DiscountConditionsobject
Show Child Parameters
cooperativestring

Cooperative which created this discount. “Erfassergruppe”

cumulus_pointsOne Of
DiscountCumulusPointsobject
Show Child Parameters
descriptionstring

May contain HTML tags.

disclaimerstring
discount_amountstring
discount_eventsarray[object]

Represents a discount event on a discount. These events are created in the M-Promo system, used for promotions.

product_ids are only available on stand alone discount events, if there are any specified.

discount_id and campaign_id are only set on stand alone discount events. When it is nested inside a discount,
refer to the containing object to find the id and campaign ids.

Show Child Parameters
discount_hintstring

May contain HTML tags.

discount_regionsarray[string]

List of regions in which the discount is valid in.

discount_role_idstring

Discount role id.

discount_role_labelstring

Discount role label.

discount_typestring

Discount type: “neuheit” or “aktion”.

See DISCOUNT_* constants.

Allowed values:neuheitaktion

discount_type_idstring

Discount type id.

discount_type_labelstring

Label for discount type id.

end_datestring(date-time)
example_textstring

Information text about an example product of a discount for multiple products.

Examples include
M-Classic, Wildfang aus dem Nordostatlantik

example_unitstring

Information about the unit of the package of an example product of a discount for multiple products.

The ‘unit’ (see field above) is used for discounts for one specific product.
The ‘exampleUnit’ is used for discounts for multiple products.
Only one of the two fields contains a value.

Examples include:
200 g
16 Stück, 216 g
12 x 50 g

high_performerboolean

High performing discount.

idstringrequired

Pex discounts do not have an id, so this field has to be optional.

imageOne Of
Imageobject

An image and its properties.

Show Child Parameters
image_transparentOne Of
Imageobject

An image and its properties.

Show Child Parameters
instead_ofstring
last_importedstring(date-time)

Time of last import.

last_mappedstring(date-time)required

Time of last mapping to Elasticsearch.

location_planning_typestring

Location planning type. “Planungsart” on M-Promo. Usually either “national” or “regional” or “lokal”.

logoOne Of
Imageobject

An image and its properties.

Show Child Parameters
newsletter_imagestring
organisationstring

smvm, fm…

original_pricenumber(float)

The original price.

package_descriptionstring

Information about the package.

Examples include:
4er-Pack
Im Duo-Pack
Im 12er-Pack

pricenumber(float)

The discounted price.

profitinteger
publication_datestring(date-time)

Publication date of the discount.

reductionOne Of
DiscountReductionobject
Show Child Parameters
reduction_type_idstring

The reduction type id of the discount.

01 - “Relativer Rabatt”
02 - “Absoluter Rabatt”
03 - “X für Y”
04 - “Absolute CUMULUS Punkte”
05 - “X-Fach Punkte”
06 - “Rabattpreis = CHF”
07 - “HIT”
08 - “Preisabschlag”

reference_product_idstring

ID of the reference product of this discount.

regionstring

The region (Migros Genossenschaft).

See regions in RegionalInformation.

secondary_imageOne Of
Imageobject

An image and its properties.

Show Child Parameters
secondary_logoOne Of
Imageobject

An image and its properties.

Show Child Parameters
sourcestring
special_advertisementboolean

Whether or not it’s a “Zusatzauslobung”.

start_datestring(date-time)
tagsarray[string]

Tags for flagging certain discounts.

unitstring

Information about the unit of the sold package.

Examples include:
Mödeli, 4 x 250 g
per 100 g, in Selbstbedienung

visibilitystring

Whether the discount visibility is overridden, can be ‘blacklist’ or ‘whitelist’.

Example

BasePrice

object

Represents a price basic information in the Product.

This is not used for the base price property.

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

The items price, quantity and unit.

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
Example