If you have your own system and would like to get your coupons or a specific coupon data 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=getCouponsList
- You must supply one of the following parameters: couponid / all
- Parameters (case sensitive, bold are mandatory):
|
Parameter Name (Case Sensitive)
|
Value |
Description |
Default Value |
|
user |
Advertiser username |
The advertiser’s username that matches the api_id |
None |
|
api_id |
Advertiser Api Id |
The advertiser’s api_id that matches the username |
Generated from edit profile |
|
couponid |
Number |
Coupon Id |
The coupon id for lookup |
|
all |
true |
To get a list of all your active coupons |
|
- 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.
- 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:
http://mcpn.us/limeApi?ev=getCouponsList&user=adv@gmail.com&api_id=a4HI43WyFK83821B&listid=398&couponid=11740
XML:
- If it's one coupon lookup that is answer to the parameter: couponid than the XML will be with one coupon:
<?xml version="1.0" encoding="UTF-8"?>
<Coupon>
<Id>11740</Id>
<Name>DemoLocal</Name>
<Image>http://mcpn.us//cell?method=getImage&isCoupon=0&c=AIWM3S</Image>
<CouponImage>http://mcpn.us//cell?method=epn&c=AIWM3S</CouponImage>
<Product>Pizza Joe Mobile </Product>
<Subtitle>Get a Large Classic Sausage & Peppers healthy Pizza.</Subtitle>
<TitleColor>CCCCCC</TitleColor>
<SubTitleColor>000000</SubTitleColor>
<OriginalPrice></OriginalPrice>
<DiscountedPrice>$ 3 Off</DiscountedPrice>
<StartDate>10/31/2011</StartDate>
<EndDate>01/01/2051</EndDate>
<AutoExtendByPeriod></AutoExtendByPeriod>
<CallNow></CallNow>
<WebUrl></WebUrl>
<EnableSharing>true</EnableSharing>
<TargetOptInList></TargetOptInList>
<ForwardUrl></ForwardUrl>
<Address>55 main street</Address>
<Terms>Only on Tue and Wed. www.t&C.com</Terms>
<BarcodeType>2of5</BarcodeType>
<BarcodeNumber>8675789898</BarcodeNumber>
<NotifyDaysBeforeExpiration></NotifyDaysBeforeExpiration>
<OfferMinValue></OfferMinValue>
<OfferMaxValue></OfferMaxValue>
<BranchCodeRequired>true</BranchCodeRequired>
<EnableSmsRedemption>false</EnableSmsRedemption>
<SmsTerms></SmsTerms>
<GrabOfferLink>http://bit.ly/1CaKiDs</GrabOfferLink>
</Coupon>
- If it's a group of coupons lookup that is answer to the parameter: all than the XML will be with a list of coupons:
Example:
http://mcpn.us/limeApi?ev=getCouponsList&user=adv@gmail.com&api_id=a4HI43WyFK83821B&all=true
<?xml version="1.0" encoding="UTF-8" ?>
<Coupons>
<Coupon>
<Id>11740</Id>
<Name>DemoLocal</Name>
<Image>http://mcpn.us//cell?method=getImage&isCoupon=0&c=AIWM3S</Image>
<CouponImage>http://mcpn.us//cell?method=epn&c=AIWM3S</CouponImage> <Product>Pizza Joe Mobile </Product>
<Subtitle>Get a Large Classic Sausage & Peppers healthy Pizza.</Subtitle>
<TitleColor>CCCCCC</TitleColor>
<SubTitleColor>000000</SubTitleColor>
<OriginalPrice></OriginalPrice>
<DiscountedPrice>$ 3 Off</DiscountedPrice>
<StartDate>10/31/2011</StartDate>
<EndDate>01/01/2051</EndDate>
<AutoExtendByPeriod></AutoExtendByPeriod>
<CallNow></CallNow>
<WebUrl></WebUrl>
<EnableSharing>true</EnableSharing>
<TargetOptInList></TargetOptInList>
<ForwardUrl></ForwardUrl>
<Address>55 main street</Address>
<Terms>Only on Tue and Wed. www.t&C.com</Terms>
<BarcodeType>2of5</BarcodeType>
<BarcodeNumber>8675789898</BarcodeNumber>
<NotifyDaysBeforeExpiration></NotifyDaysBeforeExpiration>
<OfferMinValue></OfferMinValue>
<OfferMaxValue></OfferMaxValue>
<BranchCodeRequired>true</BranchCodeRequired>
<EnableSmsRedemption>false</EnableSmsRedemption>
<SmsTerms></SmsTerms>
<GrabOfferLink>http://bit.ly/1CaKiDs</GrabOfferLink>
</Coupon>
<Coupon><Id>15386</Id>
<Name>Demo local.com</Name>
<Image>http://mcpn.us//cell?method=getImage&isCoupon=0&c=VQW2FG</Image>
<CouponImage>http://mcpn.us//cell?method=epn&c=VQW2FG </CouponImage>
<Product>Sushi Special</Product>
<Subtitle>Buy 1 Roll get 2nd FREE! </Subtitle>
<TitleColor>050505</TitleColor>
<SubTitleColor>FF1414</SubTitleColor>
<OriginalPrice>12</OriginalPrice>
<DiscountedPrice>Free</DiscountedPrice>
<StartDate>10/31/2011</StartDate>
<EndDate>08/01/2018</EndDate>
<AutoExtendByPeriod></AutoExtendByPeriod>
<CallNow>15555555555</CallNow>
<WebUrl>mycompany.com</WebUrl>
<EnableSharing>true</EnableSharing>
<TargetOptInList>43357</TargetOptInList>
<ForwardUrl></ForwardUrl>
<Address>55 main street</Address>
<Terms>Only on Tue and Wed. -- This is a demo coupon --</Terms>
<BarcodeType>2of5</BarcodeType>
<BarcodeNumber>8675789898</BarcodeNumber>
<NotifyDaysBeforeExpiration>
</NotifyDaysBeforeExpiration>
<NotifyDaysBeforeExpiration>
</NotifyDaysBeforeExpiration>
<OfferMinValue></OfferMinValue>
<OfferMaxValue></OfferMaxValue>
<BranchCodeRequired>false</BranchCodeRequired>
<EnableSmsRedemption>true</EnableSmsRedemption>
<SmsTerms></SmsTerms>
<GrabOfferLink>http://bit.ly/1CjKiDs</GrabOfferLink>
</Coupon>
</Coupons>
Comments
0 comments
Article is closed for comments.