Coupons

Data for the three UCBs (CHF 5, 10 and 20).

Data for the three UCBs (CHF 5, 10 and 20).

get
https://api.migros.ch/migros/customers/coupons/v3/ucbs

Query Parameters

langstring

Override Accept-Language header

Allowed values:defrit

Response

application/json

The UCB data

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

get/migros/customers/coupons/v3/ucbs
 
application/json

Coupon-Data

List of all Coupons

This endpoint provides a list of all Coupons.

This list includes all types of Coupons: ‘normal’ Coupons, POS-Coupons and Partnercoupons.

Expect areound 3 to 8 thousend Coupons. The exact value can be found in the X-Coupon-Count HTTP header.

get
https://api.migros.ch/migros/customers/coupons/v3/coupons

Query Parameters

langstring

Override Accept-Language header

Allowed values:defritexperimental_en

Response

application/json

Array of all coupons

Represents the coupon information based on MDB+.

campaign_colorsobject

Optional special colors for special campaigns

Show Child Parameters
campaign_idstring

The ID of the campaign, if this coupon is part of a campaign.

Example:e58efb75-2327-4b98-aeb0-1f7d9a2f5f1e

customer_groupstring

Example:cumulus

digitalboolean

Example:true

disclaimerstring

Terms and conditions.

Example:Ausgenommen sind Gebührensäcke, -marken, Vignetten, Depots, Serviceleistungen, E-Loading, iTunes/App-Karten, SIM-Karten, Gutscheine, Geschenkkarten, Geschenkboxen und alkoholische Getränke. Nur einmalig einlösbar in Verbindung mit der angegebenen Cumulus-Nummer.

discount_amountstring

Example:5-fach Punkte

discount_amount_valuestring

Example:5.0

discount_typestring

Example:mehrfach

distribution_channelsobject

The list of distribution channels (Micasa, Do It, SportX …) this coupon is usable in.

Show Child Parameters
end_datestring

Example:31.10.2024

fine_printstring
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

imagestring

An Image URL template. Replace the placeholder {stack} with an available Rokka stack, e.g “original” to get a usable URL.

Example:https://image.migros.ch/coupons/{stack}/5263e8a6f3282b7f411ae5fce947d7acb65db939.png

image_inactivestring

An Image URL template. Replace the placeholder {stack} with an available Rokka stack, e.g “original” to get a usable URL.

Example:https://image.migros.ch/coupons/{stack}/5263e8a6f3282b7f411ae5fce947d7acb65db939.png

languagestringrequired

Example:de

linksobject

Represents the links on a coupon based on MDB+.

Show Child Parameters
matching_productsinteger

Number of products applicable to thos Coupon.
If this number is not know or the Coupon is applicable to all products this field is ommited.

minimum_purchasestring

Example:Mindesteinkauf CHF 14.90

minimum_purchase_valuenumber(float)

Example:14.9

namestringrequired

Example:Gesamtes Migros-Supermarkt-Sortiment

name_appstring

Example:Gesamtes Migros-Supermarkt-Sortiment

name_webstring

Example:Gesamtes Migros-Supermarkt-Sortiment

personalboolean

Example:true

previewsarray[string]

An Image URL template. Replace the placeholder {stack} with an available Rokka stack, e.g “original” to get a usable URL.

Example:https://image.migros.ch/coupons/{stack}/5263e8a6f3282b7f411ae5fce947d7acb65db939.png

promocodestring

Optional promotion code for Partnercoupons

Example:SommerSale23

promotion_numberstring

Example:C-ID 1871947

redeemable_areastring

Example:Nur regional einlösbar

redeemable_atstring

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

regionsarray[string]

List of IDs where this Coupon can be redeemed.

Example:["ONLINE_SHOP","GMAA","GMZH"]

signetobject

A coupon signet and its properties.

Show Child Parameters
signet_bonuscouponstring

An Image URL template. Replace the placeholder {stack} with an available Rokka stack, e.g “original” to get a usable URL.

Example:https://image.migros.ch/coupons/{stack}/5263e8a6f3282b7f411ae5fce947d7acb65db939.png

signet_inactiveobject

A coupon signet and its properties.

Show Child Parameters
start_datestring
stationary_redeemableboolean

Example:false

subtitlestring

Example:[ "" ]

type_idstring

Example:8

variantstring

Example:Rabattcoupon

whole_assortmentboolean

Indicates whether this Coupon is applicable to all products.

get/migros/customers/coupons/v3/coupons
 
application/json

Fetch Coupon by GTIN

Retrieve the data of a Coupon by its GTIN.

get
https://api.migros.ch/migros/customers/coupons/v3/coupons/by-gtin/{gtin}

Query Parameters

langstring

Override Accept-Language header

Allowed values:defrit

Path Parameters

gtinstringrequired

GTIN (EAN) of Coupon. Its a string as GTINs often are longer than what integers can represent.

Match pattern:^\d+$

Response

application/json

Coupon data

Coupon

Represents the coupon information based on MDB+.

campaign_colorsobject

Optional special colors for special campaigns

Show Child Parameters
campaign_idstring

The ID of the campaign, if this coupon is part of a campaign.

Example:e58efb75-2327-4b98-aeb0-1f7d9a2f5f1e

customer_groupstring

Example:cumulus

digitalboolean

Example:true

disclaimerstring

Terms and conditions.

Example:Ausgenommen sind Gebührensäcke, -marken, Vignetten, Depots, Serviceleistungen, E-Loading, iTunes/App-Karten, SIM-Karten, Gutscheine, Geschenkkarten, Geschenkboxen und alkoholische Getränke. Nur einmalig einlösbar in Verbindung mit der angegebenen Cumulus-Nummer.

discount_amountstring

Example:5-fach Punkte

discount_amount_valuestring

Example:5.0

discount_typestring

Example:mehrfach

distribution_channelsobject

The list of distribution channels (Micasa, Do It, SportX …) this coupon is usable in.

Show Child Parameters
end_datestring

Example:31.10.2024

fine_printstring
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

imagestring

An Image URL template. Replace the placeholder {stack} with an available Rokka stack, e.g “original” to get a usable URL.

Example:https://image.migros.ch/coupons/{stack}/5263e8a6f3282b7f411ae5fce947d7acb65db939.png

image_inactivestring

An Image URL template. Replace the placeholder {stack} with an available Rokka stack, e.g “original” to get a usable URL.

Example:https://image.migros.ch/coupons/{stack}/5263e8a6f3282b7f411ae5fce947d7acb65db939.png

languagestringrequired

Example:de

linksobject

Represents the links on a coupon based on MDB+.

Show Child Parameters
matching_productsinteger

Number of products applicable to thos Coupon.
If this number is not know or the Coupon is applicable to all products this field is ommited.

minimum_purchasestring

Example:Mindesteinkauf CHF 14.90

minimum_purchase_valuenumber(float)

Example:14.9

namestringrequired

Example:Gesamtes Migros-Supermarkt-Sortiment

name_appstring

Example:Gesamtes Migros-Supermarkt-Sortiment

name_webstring

Example:Gesamtes Migros-Supermarkt-Sortiment

personalboolean

Example:true

previewsarray[string]

An Image URL template. Replace the placeholder {stack} with an available Rokka stack, e.g “original” to get a usable URL.

Example:https://image.migros.ch/coupons/{stack}/5263e8a6f3282b7f411ae5fce947d7acb65db939.png

promocodestring

Optional promotion code for Partnercoupons

Example:SommerSale23

promotion_numberstring

Example:C-ID 1871947

redeemable_areastring

Example:Nur regional einlösbar

redeemable_atstring

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

regionsarray[string]

List of IDs where this Coupon can be redeemed.

Example:["ONLINE_SHOP","GMAA","GMZH"]

signetobject

A coupon signet and its properties.

Show Child Parameters
signet_bonuscouponstring

An Image URL template. Replace the placeholder {stack} with an available Rokka stack, e.g “original” to get a usable URL.

Example:https://image.migros.ch/coupons/{stack}/5263e8a6f3282b7f411ae5fce947d7acb65db939.png

signet_inactiveobject

A coupon signet and its properties.

Show Child Parameters
start_datestring
stationary_redeemableboolean

Example:false

subtitlestring

Example:[ "" ]

type_idstring

Example:8

variantstring

Example:Rabattcoupon

whole_assortmentboolean

Indicates whether this Coupon is applicable to all products.

get/migros/customers/coupons/v3/coupons/by-gtin/{gtin}
 
application/json

Fetch Coupon by ID

This endpoint provides a single Coupon identified via its Coupon-ID i.e. the corresponding M-Promo-ID. Note that GTINs cannot be used to look up a single Coupon.

get
https://api.migros.ch/migros/customers/coupons/v3/coupons/{id}

Query Parameters

langstring

Override Accept-Language header

Allowed values:defritexperimental_en

Path Parameters

idintegerrequired

Coupon ID (the M-Promo ID, not the GTIN).

Example:234531

Response

application/json

Array of all coupons

Coupon

Represents the coupon information based on MDB+.

campaign_colorsobject

Optional special colors for special campaigns

Show Child Parameters
campaign_idstring

The ID of the campaign, if this coupon is part of a campaign.

Example:e58efb75-2327-4b98-aeb0-1f7d9a2f5f1e

customer_groupstring

Example:cumulus

digitalboolean

Example:true

disclaimerstring

Terms and conditions.

Example:Ausgenommen sind Gebührensäcke, -marken, Vignetten, Depots, Serviceleistungen, E-Loading, iTunes/App-Karten, SIM-Karten, Gutscheine, Geschenkkarten, Geschenkboxen und alkoholische Getränke. Nur einmalig einlösbar in Verbindung mit der angegebenen Cumulus-Nummer.

discount_amountstring

Example:5-fach Punkte

discount_amount_valuestring

Example:5.0

discount_typestring

Example:mehrfach

distribution_channelsobject

The list of distribution channels (Micasa, Do It, SportX …) this coupon is usable in.

Show Child Parameters
end_datestring

Example:31.10.2024

fine_printstring
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

imagestring

An Image URL template. Replace the placeholder {stack} with an available Rokka stack, e.g “original” to get a usable URL.

Example:https://image.migros.ch/coupons/{stack}/5263e8a6f3282b7f411ae5fce947d7acb65db939.png

image_inactivestring

An Image URL template. Replace the placeholder {stack} with an available Rokka stack, e.g “original” to get a usable URL.

Example:https://image.migros.ch/coupons/{stack}/5263e8a6f3282b7f411ae5fce947d7acb65db939.png

languagestringrequired

Example:de

linksobject

Represents the links on a coupon based on MDB+.

Show Child Parameters
matching_productsinteger

Number of products applicable to thos Coupon.
If this number is not know or the Coupon is applicable to all products this field is ommited.

minimum_purchasestring

Example:Mindesteinkauf CHF 14.90

minimum_purchase_valuenumber(float)

Example:14.9

namestringrequired

Example:Gesamtes Migros-Supermarkt-Sortiment

name_appstring

Example:Gesamtes Migros-Supermarkt-Sortiment

name_webstring

Example:Gesamtes Migros-Supermarkt-Sortiment

personalboolean

Example:true

previewsarray[string]

An Image URL template. Replace the placeholder {stack} with an available Rokka stack, e.g “original” to get a usable URL.

Example:https://image.migros.ch/coupons/{stack}/5263e8a6f3282b7f411ae5fce947d7acb65db939.png

promocodestring

Optional promotion code for Partnercoupons

Example:SommerSale23

promotion_numberstring

Example:C-ID 1871947

redeemable_areastring

Example:Nur regional einlösbar

redeemable_atstring

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

regionsarray[string]

List of IDs where this Coupon can be redeemed.

Example:["ONLINE_SHOP","GMAA","GMZH"]

signetobject

A coupon signet and its properties.

Show Child Parameters
signet_bonuscouponstring

An Image URL template. Replace the placeholder {stack} with an available Rokka stack, e.g “original” to get a usable URL.

Example:https://image.migros.ch/coupons/{stack}/5263e8a6f3282b7f411ae5fce947d7acb65db939.png

signet_inactiveobject

A coupon signet and its properties.

Show Child Parameters
start_datestring
stationary_redeemableboolean

Example:false

subtitlestring

Example:[ "" ]

type_idstring

Example:8

variantstring

Example:Rabattcoupon

whole_assortmentboolean

Indicates whether this Coupon is applicable to all products.

get/migros/customers/coupons/v3/coupons/{id}
 
application/json