---
title: "Emarsys Facade"
url: "https://developer-qual.migros.ch/apis/emarsys-facade-1/versions/c912724e-0d10-4f79-a473-ae6f75ea606a"
---

# Emarsys Facade

OpenAPI specification document.

```json
{"components":{"parameters":{"domain":{"description":"The domain to retrieve data from.\nFor products you may query one product by its id. For coupons you may query one coupon by its id. TODO: probably will need \"usercoupons\": all coupons attributed to a cumulus nr. For discounts you may query one discount by its id.","example":"products","in":"path","name":"domain","required":true,"schema":{"enum":["products","coupons","discounts"],"type":"string"}}},"schemas":{"EmarsysRequest":{"description":"Emarsys request","properties":{"fields":{"items":{"type":"string"},"type":"array"},"limit":{"maximum":10,"minimum":1,"type":"integer"},"parameters":{"items":{"additionalProperties":{"type":"string"},"type":"object"},"type":"array"}},"required":["fields","parameters"]},"EmarsysResponse":{"description":"Emarsys compatible response","properties":{"content":{"items":{"additionalProperties":{"type":"string"},"type":"object"},"type":"array"}},"required":["content"]}},"securitySchemes":{"Basic-Auth":{"description":"Kong basic-auth authentication","scheme":"basic","type":"http"},"Kong-Api-Key":{"description":"Kong key-auth authentication","in":"header","name":"X-Api-Key","type":"apiKey"}}},"info":{"contact":{"email":"arg_mgb-udp-business-services@mgb.ch","name":"MGB-UDP-Business-Services"},"description":"Facade for Emarsys email campaign tool in the Nexus project.\n\nYou cannot consume this API and won't get access to it. You do not need to read that documentation if you are not Emarsys. So: Go away. Now!\n\nThe following documents the parameters and fields for the different domains as well as some details.\n### Coupons\nParameters:\n  - Couponids (required): single CouponID or comma-separated list of IDs\n  - Lang (optional, dflt 'de'): Language ('de', 'fr' or 'it')\n    \nFields:\n  - name\n  - start_date\n  - end_date\n  - disclaimer\n  - image\n  - discount_amount\n  - discount_amount_value\n  - preview\n\n### Discounts\nOnly the 'national' variant of a discount is returned. Regional only discounts will fail to resolve. TODO: This might change once project Nexus decides on how to implement discounts.\nParameters:\n  - Discountids (required): single DiscountID or comma-separated list of IDs\n  - Lang (optional, dflt 'de'): Language ('de', 'fr' or 'it')\n    \nFields:\n  - type\n  - type_id\n  - reduction_type_id\n  - advertisement_type_id\n  - price\n  - amount\n  - hint\n  - description\n  - reference_product_id\n  - minimum_pieces\n  - collective\n  - relative\n  - points_relative\n  - image\n  - original_price\n  - cumulus_points\n\n### Products\nParameters:\n  - Artikelids (required): single ProductID or comma-separated list of IDs\n  - Lang (optional, dflt 'de'): Language ('de', 'fr' or 'it')\n    \nFields:\n  - name\n  - description\n  - price\n  - image","title":"Emarsys Facade","version":"1.0.0"},"openapi":"3.0.1","paths":{"/migros/marketing/campaigns/v1/emarsys/{domain}":{"post":{"description":"This endpoint implements the Emarsys protocol needed to personalize marketing emails.\n\nThis endpoint is expected to change in incompatible ways until v1 is reached.","operationId":"call","parameters":[{"$ref":"#/components/parameters/domain"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmarsysRequest"}}},"description":"Emarsys POST request body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmarsysResponse"}}},"description":"Data of the domain selected by the POST body."},"406":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"The 406 response on any error. TODO"},"default":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Standard HTTP semantics. TODO: Needed if anything is 406 anyway?"}},"summary":"Access to data","tags":["Emarsys"]}}},"security":[{"Kong-Api-Key":[]},{"Basic-Auth":[]}],"servers":[{"description":"URL of upstream","url":"https://api-qual.migros.ch"}],"tags":[{"name":"Emarsys"}],"x-company":"migros","x-edm-domain":"marketing","x-format-suffix":{"enabled":true,"pattern":"json|xml"},"x-headmatter":{"readable_by":"*"},"x-kong-route-defaults":{"protocols":["https"],"strip_path":false},"x-kong-service-defaults":{"connect_timeout":500,"read_timeout":3000,"write_timeout":800},"x-leanix-id":"84ab491d-30f8-4eac-a830-d706a3dd345f","x-link-get-access":"https://httpbin.org/status/403","x-link-get-support":"mailto:we-do-not-provide@any.support"}
```