Public Products

Brand

object

Represents the Brand information.

descriptionstring

The long description of the brand (can contain HTML).

idstringrequired
imagestring

(Rokka stack URL template)

linksobject

Collection of links indexed by string identifier.

namestringrequired
parent_brandobject

Represents the sub brand and parent brand information.

Show Child Parameters
slugstringrequired

Unique user-friendly ID.

sub_brandobject

Represents the sub brand and parent brand information.

Show Child Parameters
Example

Category

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.

imagestring

Image of the category.

keywordsarray[string]

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

levelinteger
namestringrequired
parent_codestring

Parent category ID.

slugstringrequired

Unique user-friendly ID.

titlestring

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

visibleboolean
Example

Discount

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.

Example: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.

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).

conditionsobject
Show Child Parameters
cooperativestring

Cooperative which created this discount. “Erfassergruppe”

cumulus_pointsobject
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.

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

The 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”.

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.

Example: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.

Example:16 Stück 216 g

high_performerboolean

High performing discount.

idstringrequired

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

imagestring

Image (Rokka stack URL template).

image_transparentstring

Image with transparent background (Rokka stack URL template).

instead_ofstring
location_planning_typestring

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

Example:regional

logostring

(Rokka stack URL template).

newsletter_imagestring
organisationstring

smvm, fm…

original_pricenumber(float)

The original price.

package_descriptionstring

Information about the package.

Example:Im Duo-Pack

pricenumber(float)

The discounted price.

profitinteger
publication_datestring(date-time)

Publication date of the discount.

reductionobject
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).

secondary_imagestring

(Rokka stack URL template).

secondary_logostring

(Rokka stack URL template).

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.

Example:Mödeli, 4 x 250 g

visibilitystring

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

Example

DiscountConditions

object
minimum_piecesobject
Show Child Parameters
minimum_purchase_pricenumber(float)

Example:10

Example

DiscountConditionsMinimumPieces

object
prefixstringrequired

Example:ab

valueintegerrequired

Example:2

Example