Fetch Loyalty Platform Information
A brand can be configured to either work with MENU’s loyalty platform or with our integration with Punchh.
To identify what loyalty platform is being used, the /brands/{brand_uuid}/dlc-integrations endpoint needs to be called.
Request
{
"method": "get",
"url": "https://api-public-playground.menu.app/api/brands/{brand_id}/dlc-integrations",
"headers": {
"X-Request-ID": "69da3547-204b-4093-a225-54e084c24215",
"Application": "f3a90488ffee32c3acb6fcd0ca417cf6",
"Api-Version": 4.38.0,
"Content-Type": "application/json"
}
}
Response
{
"status": "OK",
"code": 200,
"data": {
"dlc_integration": {
"id": "c2364a1a-32d3-4e98-a299-153ce0721d86",
"brand_id": "21c053fc-6201-4657-bcb8-eae90f554768",
"type_id": 2,
"reference_type": "Punchh"
}
}
}
| Property | Value | Description |
|---|---|---|
dlc_integration |
JSON | Contains all properties related to a brand's discounting, loyalty, and CRM platform configuration. |
id |
number | The internal ID of the integration. |
brand_id |
number | The ID representing the brand in MENU's system. |
type_id |
number | Possible values: 1, 2. It indicates what type of DLC integration is configured. |
reference_type |
String | Possible values: "Plain", "Punchh". It indicates what type of DLC integration is configured. |
If the value for type_id in the response is 1 then it is a MENU-based loyalty platform and if the value is 2 then it is Punchh based.
Depending on the platform being used, for the subsequent loyalty endpoints documented in this guide, different properties should be populated.