cumulusstringrequired
Cumulus number.
Match pattern:^\d{13}$
>= 13 characters<= 13 characters
Example:2099123456789
Select Coupons of a customer matching product IDs
This endpoint allows to match a set of Product-IDs against the current Coupons attributed to a customer.
Only Rabattcoupons and Bonuscoupons in the state Available or Activated are matched. Partnercoupons, Preview Coupons and Coupons that have been Redeemed already are not returned.
Like in the other endpoints working with Product IDs this endpoint also operates with the IDs of actual, buyable products as well as the corresponding “Sammler” products.
The response contains a map of Coupon GTINs that are applicable to at least one of the given products. The map entries contain the UserCoupon data, whether this Coupon matches the whole sortiment and the actual IDs matched.
Unlike the product matching endpoints on unpersonalised coupons this endpoint only provides the POST variant.
post
https://api-qual.migros.ch/migros/customers/publiccoupons/v3/users/{cumulus}/matches
Path Parameters
Body
application/x-www-form-urlencoded
Body
application/x-www-form-urlencoded
Product IDs to check, provided as (multiple) id form parameter(s).
idstringrequired
Response
application/json
Response
application/json
Map of GTINs to coupon and product data
object
post/migros/customers/publiccoupons/v3/users/{cumulus}/matches
Authentication
Path Parameters
Body
{
"id": "id"
}
application/json
Coupon
objectRepresents 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
subtitlestring
type_idstring
Example:8
variantstring
Example:Rabattcoupon
whole_assortmentboolean
Indicates whether this Coupon is applicable to all products.
Example
CouponLinks
objectRepresents the links on a coupon based on MDB+.
notestring
Note about link
Example:Im Online-Shop einlösbar
onlineshopobject
Link information.
Show Child Parameters
Example
CouponMatch
objectInformation about a Coupon matching products.
couponobject
Personalized coupon information of a user based on ReTi.
Show Child Parameters
productsarray[string]
List of product IDs matching a couopon.
Example:280134171000, 121301900000
Example
CouponSignet
objectA coupon signet and its properties.
hex_colorstring
The hexadecimal color code for this signet.
Example:#003D8C
logoobject
The logo only of the signet
Show Child Parameters
stackstring
An URL template to a raster/pixel image. Replace the placeholder {stack} with an available Rokka stack, e.g “original” to get a usable URL.
Example:https://image.migros.ch/coupons/{stack}/ebeaebd5907eeba6a7dab3b1776632f1d3436c81.png
vectorstring
URL of vector image (SVG).
Example:https://image.migros.ch/coupons/original/be0c000a3088bac1c429d9dd3da16b3081482b7e.svg
Example