REST API v4: GET couponcampaign
Je kunt alle informatie omtrent een couponcampagne opvragen met de onderstaande methode. Dit is een HTTP GET-call naar het volgende adres:
https://api.copernica.com/v4/couponcampaign/$id
Als $id moet je de numerieke identifier van de couponcampagne opgeven.
Geretourneerde velden
De methode retourneert een JSON-object dat de volgende velden bevat:
| Variabele | Omschrijving |
|---|---|
| ID | ID van de couponcampagne |
| name | Naam van de couponcampagne |
| description | Beschrijving van de couponcampagne |
| archived | Geeft aan of de database wel of niet gearchiveerd is |
| available | Aantal beschikbare coupons |
| sent | Aantal verzonden coupons |
| redeemed | Aantal ingewisselde coupons |
| tags | Array met tags gekoppeld aan de couponcampagne |
Voorbeeld in JSON
Teruggegeven waardes
{
"ID": "1",
"name": "Winter VIP Sale",
"description": "Campaign for VIP clients during winter",
"archived": false,
"available": 514,
"sent": 751,
"redeemed": 91,
"tags": [
"10euro",
"discount"
]
}Voorbeeld in PHP
Het volgende PHP-script demonstreert hoe je de API-methode kunt aanroepen:
// vereiste scripts
require_once('CopernicaRestAPI.php');
// verander dit in je access code access token
$api = new CopernicaRestAPI("your-access-token", 4);
// voer de opdracht uit en print het resultaat
print_r($api->get("couponcampaign/{$id}"));Dit voorbeeld vereist de REST API-klasse.