Loyalty Programs API

If you have your own system and would like to get your loyalty programs without our dashboard, we have just created an API allowing you to do just that. This API is for server to server communication, in case you have your own CRM system or something similar to manage your customer base.

• Url: https://mcpn.us/limeApi?ev=loyaltyPrograms
• Supply the following parameters
• Parameters (case sensitive, bold are mandatory):

Return Code

• If the API succeeds then it will return with status code 200 with xml
• If an error occurs or there is an invalid parameter then it returns with status code 400 or 500 with an error message in the response.

Example: 

https://mcpn.us/limeApi?ev=loyaltyPrograms&user=advertiseruser&api_id=a5SNH43WyAA83SWLK

XML Response:

<?xml version="1.0" ?>

<loyalties>

<loyalty>

<id>1</id>

<name>First Loyalty</name>

<optInListId>123</optInListId>

<optInListName>My Opt-in List</optInListName>

<startDate>07/16/2012</startDate>

<endDate>09/01/2017</endDate>

<limitType>Week</limitType>

<limitNumber>5</limitNumber>

<checkPoint1>2</checkPoint1>

<checkPoint2></checkPoint2>

<checkPoint3></checkPoint3>

<checkPoint4></checkPoint4>

<goal>20</goal>

<punchType>Visits</punchType>

<addPointsMessage>Thank You for this visit</addPointsMessage>

<checkPoint1Message></checkPoint1Message>

<checkPoint2Message></checkPoint2Message>

<checkPoint3Message></checkPoint3Message>

<checkPoint4Message></checkPoint4Message>

<reachGoalMessage>Congrats, you have reach the goal</reachGoalMessage>

<checkStatusMessage></checkStatusMessage>

<checkPoint1Coupon></checkPoint1Coupon>

<checkPoint2Coupon></checkPoint2Coupon>

<checkPoint3Coupon></checkPoint3Coupon>

<checkPoint4Coupon></checkPoint4Coupon>

<goalCoupon>12345</goalCoupon>

</loyalty>

<loyalty>

...

...

...

</loyalty>

</loyalties>