Campaigns
Redeem a campaign offer
POST
/
subscriptions
/
cp
/
api
/
campaigns
/
{id}
/
redeem
Redeem a campaign offer
curl --request POST \
--url https://www.myshop.com/apps/subscriptions/cp/api/campaigns/{id}/redeem \
--header 'Content-Type: application/json' \
--data '
{
"addType": "<string>",
"contractId": 123,
"renewType": "<string>"
}
'import requests
url = "https://www.myshop.com/apps/subscriptions/cp/api/campaigns/{id}/redeem"
payload = {
"addType": "<string>",
"contractId": 123,
"renewType": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({addType: '<string>', contractId: 123, renewType: '<string>'})
};
fetch('https://www.myshop.com/apps/subscriptions/cp/api/campaigns/{id}/redeem', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://www.myshop.com/apps/subscriptions/cp/api/campaigns/{id}/redeem';
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({addType: '<string>', contractId: 123, renewType: '<string>'})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://www.myshop.com/apps/subscriptions/cp/api/campaigns/{id}/redeem",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'addType' => '<string>',
'contractId' => 123,
'renewType' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://www.myshop.com/apps/subscriptions/cp/api/campaigns/{id}/redeem"
payload := strings.NewReader("{\n \"addType\": \"<string>\",\n \"contractId\": 123,\n \"renewType\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://www.myshop.com/apps/subscriptions/cp/api/campaigns/{id}/redeem")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"addType\": \"<string>\",\n \"contractId\": 123,\n \"renewType\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"campaignId": 123,
"message": "<string>",
"state": "<string>",
"subscriptionContractId": 123,
"success": true
}⌘I
Redeem a campaign offer
curl --request POST \
--url https://www.myshop.com/apps/subscriptions/cp/api/campaigns/{id}/redeem \
--header 'Content-Type: application/json' \
--data '
{
"addType": "<string>",
"contractId": 123,
"renewType": "<string>"
}
'import requests
url = "https://www.myshop.com/apps/subscriptions/cp/api/campaigns/{id}/redeem"
payload = {
"addType": "<string>",
"contractId": 123,
"renewType": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({addType: '<string>', contractId: 123, renewType: '<string>'})
};
fetch('https://www.myshop.com/apps/subscriptions/cp/api/campaigns/{id}/redeem', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://www.myshop.com/apps/subscriptions/cp/api/campaigns/{id}/redeem';
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({addType: '<string>', contractId: 123, renewType: '<string>'})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://www.myshop.com/apps/subscriptions/cp/api/campaigns/{id}/redeem",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'addType' => '<string>',
'contractId' => 123,
'renewType' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://www.myshop.com/apps/subscriptions/cp/api/campaigns/{id}/redeem"
payload := strings.NewReader("{\n \"addType\": \"<string>\",\n \"contractId\": 123,\n \"renewType\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://www.myshop.com/apps/subscriptions/cp/api/campaigns/{id}/redeem")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"addType\": \"<string>\",\n \"contractId\": 123,\n \"renewType\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"campaignId": 123,
"message": "<string>",
"state": "<string>",
"subscriptionContractId": 123,
"success": true
}