Search
K
Coupons

POSCoupon

object

Represents the POS-Coupon information.

disclaimer_rowsarray[string]

Example:Nur solange Vorrat., Sortiment teilweise nur in grösseren Migros-, Filialen erhältlich.

discount_amountstringrequired

Example:40-fach Punkte

end_datestringrequired

Example:31.10.2024

export_descrstring

Example:PosCoupon 40-fach

gtinrequired

GTIN (EAN) of Coupon. Some Partnercoupons do not have GTINs.

Example:8888122276132945500263

idstringrequired

The ID of the Coupon. This is the same as the M-Promo ID; ReTi and MDB+ call this Offer ID".

Example:1871947

languagestringrequired

Example:de

minimum_purchasestringrequired

Example:Kein Mindesteinkauf

name_rowsarray[string]

Example:Alle frischen Bohnen, in Selbstbedienung

pointfactorstring

Example:40.0

pointfixstring
promofactorstring
promotion_numberstring

Example:C-ID 2060566

redeemable_areastring
redeemable_atstring

Example:Einlösbar in allen Migros-Filialen in der Schweiz gegen Vorweisen der Cumulus-Karte

reductionstring
signetobject
Show Child Parameters
start_datestring
subtitle_rowsarray[string]required

Example:(ohne Migros-Bio,, ohne Demeter)

type_gkstring

Example:2453

valuestringrequired

Example:40-fach Punkte mehrfach

Example

ProductList

array

List of product IDs matching a couopon.

Example

Stats

object

Aggregate statistics about Coupons and UCBs of a user.

couponsActivatedintegerrequired

Number of activated Coupons (ignoring Quantity).

Example:3

diracActiveCountintegerrequired

Total number of activated Coupons (counting Quantity).

Example:4

diracAvailableCountintegerrequired

Number of non-redeem Coupons (ignoring Quantity)

Example:7

ucbActiveSumintegerrequired

Sum of all activated UCBs in CHF

Example:30

ucbAvailableSumintegerrequired

Sum of all non-redeemed UCBs in CHF.

Example:75

Example

UCB

object

Static data of an UCB (Blauer Bon/Coupon Bon).

descriptionstring

Example:Bon Wert Fr. 5

idstringrequired

This ID just identifies the value (5, 10, 20 CHF) only. The individual physical UCB is identified by a UCB-ID that equals the number/barcode printed on the UCB.

Example:980500100000

imagestringrequired

Example:https://image.migros.ch/coupons/{stack}/40187ac745c07f16a184508f17f3a3cb255d4537.jpg

image_appstringrequired

Example:https://image.migros.ch/coupons/{stack}/76a605b12f8ad8586c70b3a0a920836bcb5f94d8.png

image_app_inactivestringrequired

Example:https://image.migros.ch/coupons/{stack}/4a67aeb0ff88b07cc2cd4b4cd2b0272759f74779.png

image_inactivestringrequired

Example:https://image.migros.ch/coupons/{stack}/6c8cf3ca90d107207ca6760e8eb4e554d67c438d.jpg

languagestringrequired

Example:de

valueinteger(int32)required

Example:5

Example

UserCoupon

object

Personalized coupon information of a user based on ReTi.

couponobject

Represents the coupon information based on MDB+.

Show Child Parameters
expirystring

Date string when the coupon expires. Note that the format is different from coupon.start_date.

Example:2023-09-01+02:00

idstring

The GTIN (EAN) of the Coupon. ReTi calls this “offerId”.

Example:8888122276132945500263

pos_tr_idstring

unique_request_id as provided during redeem call.

Example:303461600060EF280F0C206267706114

previewboolean

If true then start_date is in the future and this Coupon cannot be activated yet as it is considered a “Preview-Coupon”.

publishedstring

Date string when the coupon begins to be usable. Note that the format is different from coupon.start_date.

Example:2023-06-13+02:00

quantityinteger

A single Coupon can be attributed multiple times to a customer. 0 is omitted.

>= 0<= 99

Example:2

redeemedstring

Datetime string when the coupon was redeemed (or empty).

Example:2024-05-10T10:39:06+02:00

statusinteger

1 = available, 2 = activated, 3 = redeemed.

Allowed values:123

Example