Operations & Settings
Bulk update subscription delivery method
Updates the delivery method configuration for subscription contracts in bulk.
Endpoint:
PUT /api/external/v2/bulk-automations/delivery-method
Authentication:
- API Key (query parameter: api_key) Query Parameters:
api_key(required) – Your API keydeliveryMethodTitle(required) – Delivery method titledeliveryMethodCode(required) – Delivery method codedeliveryMethodPresentmentTitle(required) – Customer-facing delivery method titledeliveryMethodId(required) – Shopify Delivery Method Definition GraphQL ID
Request Body:
{
"subscriptionIds": "29879894300"
}
What This Endpoint Does:
- Updates the delivery method details for the provided subscription contracts
- Creates a bulk automation task
- Processes updates asynchronously in the background
How It Works:
- Merchant provides delivery method details via query parameters
- Subscription IDs are provided in request body
- System validates shop ownership and active status
- Bulk automation job is created
- Delivery method is updated for each subscription
Important Notes:
- Only one bulk automation per shop can run at a time
- deliveryMethodId is optional. Omit it for a custom title/code edit that preserves each subscription’s delivery price and enables its manual price override.
- For a selected method, supply the full Shopify GraphQL ID returned by the shop delivery-options catalogue: DeliveryMethodDefinition or a Market option such as gid://shopify/DeliveryFlatRateOptionDefinition/123.
- On market-driven shops, the server resolves the selected option’s title once per job, then validates and applies a current eligible quote separately for each subscription. Missing or ambiguous quotes leave that subscription unchanged and record a job error.
- Processing is asynchronous
- Previous generated orders are not modified
PUT
/
api
/
external
/
v2
/
bulk-automations
/
delivery-method
Bulk update subscription delivery method
curl --request PUT \
--url https://subscription-admin.appstle.com/api/external/v2/bulk-automations/delivery-method \
--header 'Content-Type: application/json' \
--data '
{
"subscriptionIds": "<string>"
}
'import requests
url = "https://subscription-admin.appstle.com/api/external/v2/bulk-automations/delivery-method"
payload = { "subscriptionIds": "<string>" }
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({subscriptionIds: '<string>'})
};
fetch('https://subscription-admin.appstle.com/api/external/v2/bulk-automations/delivery-method', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://subscription-admin.appstle.com/api/external/v2/bulk-automations/delivery-method';
const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({subscriptionIds: '<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://subscription-admin.appstle.com/api/external/v2/bulk-automations/delivery-method",
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([
'subscriptionIds' => '<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://subscription-admin.appstle.com/api/external/v2/bulk-automations/delivery-method"
payload := strings.NewReader("{\n \"subscriptionIds\": \"<string>\"\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://subscription-admin.appstle.com/api/external/v2/bulk-automations/delivery-method")
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 \"subscriptionIds\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{}Query Parameters
Your API Key
Body
application/json
Response
Bulk delivery method update successfully queued and initiated.
⌘I
Bulk update subscription delivery method
curl --request PUT \
--url https://subscription-admin.appstle.com/api/external/v2/bulk-automations/delivery-method \
--header 'Content-Type: application/json' \
--data '
{
"subscriptionIds": "<string>"
}
'import requests
url = "https://subscription-admin.appstle.com/api/external/v2/bulk-automations/delivery-method"
payload = { "subscriptionIds": "<string>" }
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({subscriptionIds: '<string>'})
};
fetch('https://subscription-admin.appstle.com/api/external/v2/bulk-automations/delivery-method', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://subscription-admin.appstle.com/api/external/v2/bulk-automations/delivery-method';
const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({subscriptionIds: '<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://subscription-admin.appstle.com/api/external/v2/bulk-automations/delivery-method",
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([
'subscriptionIds' => '<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://subscription-admin.appstle.com/api/external/v2/bulk-automations/delivery-method"
payload := strings.NewReader("{\n \"subscriptionIds\": \"<string>\"\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://subscription-admin.appstle.com/api/external/v2/bulk-automations/delivery-method")
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 \"subscriptionIds\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{}