Product Swap Rules
Get product swap options by variant
Retrieves available product swap/substitution options for specified variant IDs, allowing customers to exchange subscription items.
POST
/
memberships
/
cp
/
api
/
product-swaps-by-variant-groups
Get product swap options by variant
curl --request POST \
--url https://www.myshop.com/apps/memberships/cp/api/product-swaps-by-variant-groups \
--header 'Content-Type: application/json' \
--data '
{
"variantQuantityList": [
{
"image": "<string>",
"productId": "<string>",
"productTitle": "<string>",
"quantity": 123,
"sellingPlanId": "<string>",
"title": "<string>",
"variantId": 123
}
]
}
'import requests
url = "https://www.myshop.com/apps/memberships/cp/api/product-swaps-by-variant-groups"
payload = { "variantQuantityList": [
{
"image": "<string>",
"productId": "<string>",
"productTitle": "<string>",
"quantity": 123,
"sellingPlanId": "<string>",
"title": "<string>",
"variantId": 123
}
] }
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({
variantQuantityList: [
{
image: '<string>',
productId: '<string>',
productTitle: '<string>',
quantity: 123,
sellingPlanId: '<string>',
title: '<string>',
variantId: 123
}
]
})
};
fetch('https://www.myshop.com/apps/memberships/cp/api/product-swaps-by-variant-groups', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://www.myshop.com/apps/memberships/cp/api/product-swaps-by-variant-groups';
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
variantQuantityList: [
{
image: '<string>',
productId: '<string>',
productTitle: '<string>',
quantity: 123,
sellingPlanId: '<string>',
title: '<string>',
variantId: 123
}
]
})
};
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/memberships/cp/api/product-swaps-by-variant-groups",
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([
'variantQuantityList' => [
[
'image' => '<string>',
'productId' => '<string>',
'productTitle' => '<string>',
'quantity' => 123,
'sellingPlanId' => '<string>',
'title' => '<string>',
'variantId' => 123
]
]
]),
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/memberships/cp/api/product-swaps-by-variant-groups"
payload := strings.NewReader("{\n \"variantQuantityList\": [\n {\n \"image\": \"<string>\",\n \"productId\": \"<string>\",\n \"productTitle\": \"<string>\",\n \"quantity\": 123,\n \"sellingPlanId\": \"<string>\",\n \"title\": \"<string>\",\n \"variantId\": 123\n }\n ]\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/memberships/cp/api/product-swaps-by-variant-groups")
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 \"variantQuantityList\": [\n {\n \"image\": \"<string>\",\n \"productId\": \"<string>\",\n \"productTitle\": \"<string>\",\n \"quantity\": 123,\n \"sellingPlanId\": \"<string>\",\n \"title\": \"<string>\",\n \"variantId\": 123\n }\n ]\n}"
response = http.request(request)
puts response.read_body[
[
{
"image": "<string>",
"productId": "<string>",
"productTitle": "<string>",
"quantity": 123,
"sellingPlanId": "<string>",
"title": "<string>",
"variantId": 123
}
]
]⌘I
Get product swap options by variant
curl --request POST \
--url https://www.myshop.com/apps/memberships/cp/api/product-swaps-by-variant-groups \
--header 'Content-Type: application/json' \
--data '
{
"variantQuantityList": [
{
"image": "<string>",
"productId": "<string>",
"productTitle": "<string>",
"quantity": 123,
"sellingPlanId": "<string>",
"title": "<string>",
"variantId": 123
}
]
}
'import requests
url = "https://www.myshop.com/apps/memberships/cp/api/product-swaps-by-variant-groups"
payload = { "variantQuantityList": [
{
"image": "<string>",
"productId": "<string>",
"productTitle": "<string>",
"quantity": 123,
"sellingPlanId": "<string>",
"title": "<string>",
"variantId": 123
}
] }
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({
variantQuantityList: [
{
image: '<string>',
productId: '<string>',
productTitle: '<string>',
quantity: 123,
sellingPlanId: '<string>',
title: '<string>',
variantId: 123
}
]
})
};
fetch('https://www.myshop.com/apps/memberships/cp/api/product-swaps-by-variant-groups', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://www.myshop.com/apps/memberships/cp/api/product-swaps-by-variant-groups';
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
variantQuantityList: [
{
image: '<string>',
productId: '<string>',
productTitle: '<string>',
quantity: 123,
sellingPlanId: '<string>',
title: '<string>',
variantId: 123
}
]
})
};
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/memberships/cp/api/product-swaps-by-variant-groups",
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([
'variantQuantityList' => [
[
'image' => '<string>',
'productId' => '<string>',
'productTitle' => '<string>',
'quantity' => 123,
'sellingPlanId' => '<string>',
'title' => '<string>',
'variantId' => 123
]
]
]),
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/memberships/cp/api/product-swaps-by-variant-groups"
payload := strings.NewReader("{\n \"variantQuantityList\": [\n {\n \"image\": \"<string>\",\n \"productId\": \"<string>\",\n \"productTitle\": \"<string>\",\n \"quantity\": 123,\n \"sellingPlanId\": \"<string>\",\n \"title\": \"<string>\",\n \"variantId\": 123\n }\n ]\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/memberships/cp/api/product-swaps-by-variant-groups")
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 \"variantQuantityList\": [\n {\n \"image\": \"<string>\",\n \"productId\": \"<string>\",\n \"productTitle\": \"<string>\",\n \"quantity\": 123,\n \"sellingPlanId\": \"<string>\",\n \"title\": \"<string>\",\n \"variantId\": 123\n }\n ]\n}"
response = http.request(request)
puts response.read_body[
[
{
"image": "<string>",
"productId": "<string>",
"productTitle": "<string>",
"quantity": 123,
"sellingPlanId": "<string>",
"title": "<string>",
"variantId": 123
}
]
]