REST API v4: GET couponcampaign
A method to request a list of a coupon campaign. This is an HTTP GET call to the following address:
https://api.copernica.com/v4/couponcampaign/$id
The $id
here should be replaced with the numerical identifier of the coupon campaign.
Returned fields
The method returns a JSON object that contains the following fields:
Variable | Description |
---|---|
ID | The ID of the coupon campaign |
name | Name of the coupon campaign |
description | Description of the coupon campaign |
archived | Whether or not the coupon campaign is archived |
available | Number of available coupons |
sent | Number of sent coupons |
redeemed | Number of redeemed coupons |
tags | Array with the tags for this coupon campaign |
JSON example
The JSON for this method might look something like this:
{
"ID": "1",
"name": "Winter VIP Sale",
"description": "Campaign for VIP clients during winter",
"archived": false,
"available": 514,
"sent": 751,
"redeemed": 91,
"tags": [
"10euro",
"discount"
]
}
PHP example
The following PHP scripts is an example of how to call this API method:
// dependencies
require_once('CopernicaRestAPI.php');
// change this to your access token
$api = new CopernicaRestAPI("your-access-token", 4);
// execute the call and print the result.
print_r($api->get("couponcampaign/{$ID}"));
The example above requires the CopernicaRestApi class.