Users can view the coupon details using our API authentication token.

Request URL

XML/ JSON

https://campaigns.zoho.com/api/coupon/coupondetails

Request Type:  Get/ Post

Parameters:

Parameter

Data Type

Description

authtoken*
scope*

String
String

API Authentication Token
CampaignsAPI

version

String

This will fetch responses based on the current API version.

type

String

XML (or) JSON

couponCode*

String

Get it from recent coupon campaign.

* - Mandatory Parameters

Sample Request:

XML/ JSON

  • https://campaigns.zoho.com/api/coupon/coupondetails?authtoken=[API Authentication Token]&scope=CampaignsAPI&type=xml&version=1&couponCode=[Couponcode]

Sample Response:

Our API response will let you know of the following be it in the XML or JSON format.

XML Format:

<response uri="/api/coupon/coupondetails" version="1">
<code>200</code>
<message>Success</message>
<CouponDetails>
<couponid>42660000000513041</couponid>
<coupon>TESTTSIGiCvV</coupon>
<couponprefix>TESTTSI</couponprefix>
<recipient>patriciab@zylker.com</recipient>
<campaignname>Coupon campaign Api Use</campaignname>
<senton>07/30/2014 10:40 AM IST </senton>
<expireon>08/28/2014 10:00 PM IST </expireon>
<status>Active</status>
<usedon>0</usedon>
</CouponDetails>
</response>

JSON format:

{
"response":{
"message":"Success",
"code":"200",
"CouponDetails":{
"usedon":"0",
"campaignname":"Coupon campaign Api Use",
"status":"Active",
"expireon":"08/28/2014 10:00 PM IST",
"senton":"07/30/2014 10:40 AM IST",
"couponprefix":"TESTTSI",
"coupon":"TESTTSIGiCvV",
"couponid":"42660000000513041",
"recipient":"patriciab@zylker.com"
},
"uri":"/api/coupon/coupondetails",
"version":"1"
}
}