Skip to main content
PUT
/
subscriptions
/
cp
/
api
/
v2
/
subscription-contracts-add-sectioned-line-item
/
{contractId}
Add a line item to a specific section of a contract
curl --request PUT \
  --url https://www.myshop.com/apps/subscriptions/cp/api/v2/subscription-contracts-add-sectioned-line-item/{contractId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "bundleUniqueId": "<string>",
  "sectionedBundleItems": [
    {
      "id": 123,
      "sectionedVariantInfos": [
        {
          "variantId": "<string>",
          "variantQty": 123
        }
      ]
    }
  ]
}
'
import requests

url = "https://www.myshop.com/apps/subscriptions/cp/api/v2/subscription-contracts-add-sectioned-line-item/{contractId}"

payload = {
"bundleUniqueId": "<string>",
"sectionedBundleItems": [
{
"id": 123,
"sectionedVariantInfos": [
{
"variantId": "<string>",
"variantQty": 123
}
]
}
]
}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
bundleUniqueId: '<string>',
sectionedBundleItems: [{id: 123, sectionedVariantInfos: [{variantId: '<string>', variantQty: 123}]}]
})
};

fetch('https://www.myshop.com/apps/subscriptions/cp/api/v2/subscription-contracts-add-sectioned-line-item/{contractId}', 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/v2/subscription-contracts-add-sectioned-line-item/{contractId}';
const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
bundleUniqueId: '<string>',
sectionedBundleItems: [{id: 123, sectionedVariantInfos: [{variantId: '<string>', variantQty: 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/subscriptions/cp/api/v2/subscription-contracts-add-sectioned-line-item/{contractId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'bundleUniqueId' => '<string>',
'sectionedBundleItems' => [
[
'id' => 123,
'sectionedVariantInfos' => [
[
'variantId' => '<string>',
'variantQty' => 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/subscriptions/cp/api/v2/subscription-contracts-add-sectioned-line-item/{contractId}"

payload := strings.NewReader("{\n \"bundleUniqueId\": \"<string>\",\n \"sectionedBundleItems\": [\n {\n \"id\": 123,\n \"sectionedVariantInfos\": [\n {\n \"variantId\": \"<string>\",\n \"variantQty\": 123\n }\n ]\n }\n ]\n}")

req, _ := http.NewRequest("PUT", 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/v2/subscription-contracts-add-sectioned-line-item/{contractId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"bundleUniqueId\": \"<string>\",\n \"sectionedBundleItems\": [\n {\n \"id\": 123,\n \"sectionedVariantInfos\": [\n {\n \"variantId\": \"<string>\",\n \"variantQty\": 123\n }\n ]\n }\n ]\n}"

response = http.request(request)
puts response.read_body
{}

Path Parameters

contractId
integer<int64>
required

Body

application/json
bundleUniqueId
string
sectionedBundleItems
object[]

Response

200 - */*

OK

The response is of type object.