Fetch Loyalty Platform Information
A brand runs its loyalty program either on PAR Ordering's own discounting and loyalty features or on Punchh. Which one decides the rest of this section, so start by reading it from GET /brands/{brand_uuid}/dlc-integrations.
Request
{
"method": "get",
"url": "https://api-public-demo.menu.app/api/brands/{brand_id}/dlc-integrations",
"headers": {
"X-Request-ID": "69da3547-204b-4093-a225-54e084c24215",
"Application": "f3a90488ffee32c3acb6fcd0ca417cf6",
"Api-Version": "<current-release-version>",
"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 PAR Ordering. |
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. |
type_id 1 (Plain) is PAR Ordering's own loyalty; 2 (Punchh) is Punchh. The guides under Punchh apply to the second; a brand on another loyalty provider uses External Discounts.
