Coupons

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

UserCouponCollection

object

Collection of Coupons attributed to a user (cumulus number). Note that the two arrays contain different types of elements.

activatedarray[object]

Personalized coupon information of a user based on ReTi.

Show Child Parameters
availablearray[object]

Personalized coupon information of a user based on ReTi.

Show Child Parameters
partnerarray[object]required

Represents the coupon information based on MDB+.

Show Child Parameters
previewarray[object]required

Personalized coupon information of a user based on ReTi.

Show Child Parameters
redeemedarray[object]required

Personalized coupon information of a user based on ReTi.

Show Child Parameters
Example

UserUCB

object

Personalized UCB information of a user based on ReTi.

balanceintegerrequired

Value of this UCB in CHF.

Allowed values:51020

Example:5

expirystring

Valid until (including) this date.

Example:2025-09-30+02:00

idstringrequired

The actual UCB-ID that identifies the individual UCB. This ID is the number/barcode printed on the UCB.

Example:778400003621541383

publishedstring

Valid from (including) this date.

Example:2023-07-18+02:00

redeemedstring

Date and time of redemption.

Example:2015-05-27T08:27:27+02:00

statusintegerrequired

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

Allowed values:123

ucbobject

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

Show Child Parameters
Example