Operations & Settings
Create a new shipping/delivery profile (V2)
Creates a new shipping or delivery profile for subscription orders using the V2 request format. This version provides enhanced configuration options for delivery methods, zones, and pricing.
Enhancements in V2:
- Improved zone configuration
- Better support for multiple delivery methods
- Enhanced rate definition capabilities
- Support for conditional delivery rates
Key Features:
- Define custom shipping rates per zone
- Configure local delivery options
- Set up local pickup methods
- Manage shipping zones and countries
- Assign profiles to specific products or variants
Authentication: Requires valid X-API-Key header
POST
/
api
/
external
/
v2
/
delivery-profiles
/
v2
/
create-shipping-profile
Create a new shipping/delivery profile (V2)
curl --request POST \
--url https://subscription-admin.appstle.com/api/external/v2/delivery-profiles/v2/create-shipping-profile \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"locationInfos": [
{
"countryInfos": [
{
"code": "<string>",
"deliveryMethodInfo": [
{
"amount": 123,
"carrierRate": true,
"carrierServiceId": "<string>",
"deliveryConditionType": "<string>",
"name": "<string>",
"priceConditions": [
{
"amount": 123,
"deliverCondtion": "<string>"
}
],
"weightConditions": [
{
"deliveryCondition": "<string>",
"weight": 123,
"weightUnit": "<string>"
}
]
}
],
"provinceCode": "<string>",
"restOfWorld": true,
"shouldIncludeAllProvince": true
}
],
"locationId": "<string>"
}
],
"name": "<string>"
}
'import requests
url = "https://subscription-admin.appstle.com/api/external/v2/delivery-profiles/v2/create-shipping-profile"
payload = {
"id": "<string>",
"locationInfos": [
{
"countryInfos": [
{
"code": "<string>",
"deliveryMethodInfo": [
{
"amount": 123,
"carrierRate": True,
"carrierServiceId": "<string>",
"deliveryConditionType": "<string>",
"name": "<string>",
"priceConditions": [
{
"amount": 123,
"deliverCondtion": "<string>"
}
],
"weightConditions": [
{
"deliveryCondition": "<string>",
"weight": 123,
"weightUnit": "<string>"
}
]
}
],
"provinceCode": "<string>",
"restOfWorld": True,
"shouldIncludeAllProvince": True
}
],
"locationId": "<string>"
}
],
"name": "<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({
id: '<string>',
locationInfos: [
{
countryInfos: [
{
code: '<string>',
deliveryMethodInfo: [
{
amount: 123,
carrierRate: true,
carrierServiceId: '<string>',
deliveryConditionType: '<string>',
name: '<string>',
priceConditions: [{amount: 123, deliverCondtion: '<string>'}],
weightConditions: [{deliveryCondition: '<string>', weight: 123, weightUnit: '<string>'}]
}
],
provinceCode: '<string>',
restOfWorld: true,
shouldIncludeAllProvince: true
}
],
locationId: '<string>'
}
],
name: '<string>'
})
};
fetch('https://subscription-admin.appstle.com/api/external/v2/delivery-profiles/v2/create-shipping-profile', 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/delivery-profiles/v2/create-shipping-profile';
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
id: '<string>',
locationInfos: [
{
countryInfos: [
{
code: '<string>',
deliveryMethodInfo: [
{
amount: 123,
carrierRate: true,
carrierServiceId: '<string>',
deliveryConditionType: '<string>',
name: '<string>',
priceConditions: [{amount: 123, deliverCondtion: '<string>'}],
weightConditions: [{deliveryCondition: '<string>', weight: 123, weightUnit: '<string>'}]
}
],
provinceCode: '<string>',
restOfWorld: true,
shouldIncludeAllProvince: true
}
],
locationId: '<string>'
}
],
name: '<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/delivery-profiles/v2/create-shipping-profile",
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([
'id' => '<string>',
'locationInfos' => [
[
'countryInfos' => [
[
'code' => '<string>',
'deliveryMethodInfo' => [
[
'amount' => 123,
'carrierRate' => true,
'carrierServiceId' => '<string>',
'deliveryConditionType' => '<string>',
'name' => '<string>',
'priceConditions' => [
[
'amount' => 123,
'deliverCondtion' => '<string>'
]
],
'weightConditions' => [
[
'deliveryCondition' => '<string>',
'weight' => 123,
'weightUnit' => '<string>'
]
]
]
],
'provinceCode' => '<string>',
'restOfWorld' => true,
'shouldIncludeAllProvince' => true
]
],
'locationId' => '<string>'
]
],
'name' => '<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/delivery-profiles/v2/create-shipping-profile"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"locationInfos\": [\n {\n \"countryInfos\": [\n {\n \"code\": \"<string>\",\n \"deliveryMethodInfo\": [\n {\n \"amount\": 123,\n \"carrierRate\": true,\n \"carrierServiceId\": \"<string>\",\n \"deliveryConditionType\": \"<string>\",\n \"name\": \"<string>\",\n \"priceConditions\": [\n {\n \"amount\": 123,\n \"deliverCondtion\": \"<string>\"\n }\n ],\n \"weightConditions\": [\n {\n \"deliveryCondition\": \"<string>\",\n \"weight\": 123,\n \"weightUnit\": \"<string>\"\n }\n ]\n }\n ],\n \"provinceCode\": \"<string>\",\n \"restOfWorld\": true,\n \"shouldIncludeAllProvince\": true\n }\n ],\n \"locationId\": \"<string>\"\n }\n ],\n \"name\": \"<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://subscription-admin.appstle.com/api/external/v2/delivery-profiles/v2/create-shipping-profile")
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 \"id\": \"<string>\",\n \"locationInfos\": [\n {\n \"countryInfos\": [\n {\n \"code\": \"<string>\",\n \"deliveryMethodInfo\": [\n {\n \"amount\": 123,\n \"carrierRate\": true,\n \"carrierServiceId\": \"<string>\",\n \"deliveryConditionType\": \"<string>\",\n \"name\": \"<string>\",\n \"priceConditions\": [\n {\n \"amount\": 123,\n \"deliverCondtion\": \"<string>\"\n }\n ],\n \"weightConditions\": [\n {\n \"deliveryCondition\": \"<string>\",\n \"weight\": 123,\n \"weightUnit\": \"<string>\"\n }\n ]\n }\n ],\n \"provinceCode\": \"<string>\",\n \"restOfWorld\": true,\n \"shouldIncludeAllProvince\": true\n }\n ],\n \"locationId\": \"<string>\"\n }\n ],\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"deliveryProfileId": "<string>",
"shop": "<string>",
"id": 123,
"name": "<string>",
"sellerGroupIds": [
"<string>"
]
}{
"deliveryProfileId": "<string>",
"shop": "<string>",
"id": 123,
"name": "<string>",
"sellerGroupIds": [
"<string>"
]
}{
"deliveryProfileId": "<string>",
"shop": "<string>",
"id": 123,
"name": "<string>",
"sellerGroupIds": [
"<string>"
]
}{
"deliveryProfileId": "<string>",
"shop": "<string>",
"id": 123,
"name": "<string>",
"sellerGroupIds": [
"<string>"
]
}{
"deliveryProfileId": "<string>",
"shop": "<string>",
"id": 123,
"name": "<string>",
"sellerGroupIds": [
"<string>"
]
}Headers
Query Parameters
API Key (Deprecated - Use Header X-API-Key instead)
Body
application/json
⌘I
Create a new shipping/delivery profile (V2)
curl --request POST \
--url https://subscription-admin.appstle.com/api/external/v2/delivery-profiles/v2/create-shipping-profile \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"locationInfos": [
{
"countryInfos": [
{
"code": "<string>",
"deliveryMethodInfo": [
{
"amount": 123,
"carrierRate": true,
"carrierServiceId": "<string>",
"deliveryConditionType": "<string>",
"name": "<string>",
"priceConditions": [
{
"amount": 123,
"deliverCondtion": "<string>"
}
],
"weightConditions": [
{
"deliveryCondition": "<string>",
"weight": 123,
"weightUnit": "<string>"
}
]
}
],
"provinceCode": "<string>",
"restOfWorld": true,
"shouldIncludeAllProvince": true
}
],
"locationId": "<string>"
}
],
"name": "<string>"
}
'import requests
url = "https://subscription-admin.appstle.com/api/external/v2/delivery-profiles/v2/create-shipping-profile"
payload = {
"id": "<string>",
"locationInfos": [
{
"countryInfos": [
{
"code": "<string>",
"deliveryMethodInfo": [
{
"amount": 123,
"carrierRate": True,
"carrierServiceId": "<string>",
"deliveryConditionType": "<string>",
"name": "<string>",
"priceConditions": [
{
"amount": 123,
"deliverCondtion": "<string>"
}
],
"weightConditions": [
{
"deliveryCondition": "<string>",
"weight": 123,
"weightUnit": "<string>"
}
]
}
],
"provinceCode": "<string>",
"restOfWorld": True,
"shouldIncludeAllProvince": True
}
],
"locationId": "<string>"
}
],
"name": "<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({
id: '<string>',
locationInfos: [
{
countryInfos: [
{
code: '<string>',
deliveryMethodInfo: [
{
amount: 123,
carrierRate: true,
carrierServiceId: '<string>',
deliveryConditionType: '<string>',
name: '<string>',
priceConditions: [{amount: 123, deliverCondtion: '<string>'}],
weightConditions: [{deliveryCondition: '<string>', weight: 123, weightUnit: '<string>'}]
}
],
provinceCode: '<string>',
restOfWorld: true,
shouldIncludeAllProvince: true
}
],
locationId: '<string>'
}
],
name: '<string>'
})
};
fetch('https://subscription-admin.appstle.com/api/external/v2/delivery-profiles/v2/create-shipping-profile', 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/delivery-profiles/v2/create-shipping-profile';
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
id: '<string>',
locationInfos: [
{
countryInfos: [
{
code: '<string>',
deliveryMethodInfo: [
{
amount: 123,
carrierRate: true,
carrierServiceId: '<string>',
deliveryConditionType: '<string>',
name: '<string>',
priceConditions: [{amount: 123, deliverCondtion: '<string>'}],
weightConditions: [{deliveryCondition: '<string>', weight: 123, weightUnit: '<string>'}]
}
],
provinceCode: '<string>',
restOfWorld: true,
shouldIncludeAllProvince: true
}
],
locationId: '<string>'
}
],
name: '<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/delivery-profiles/v2/create-shipping-profile",
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([
'id' => '<string>',
'locationInfos' => [
[
'countryInfos' => [
[
'code' => '<string>',
'deliveryMethodInfo' => [
[
'amount' => 123,
'carrierRate' => true,
'carrierServiceId' => '<string>',
'deliveryConditionType' => '<string>',
'name' => '<string>',
'priceConditions' => [
[
'amount' => 123,
'deliverCondtion' => '<string>'
]
],
'weightConditions' => [
[
'deliveryCondition' => '<string>',
'weight' => 123,
'weightUnit' => '<string>'
]
]
]
],
'provinceCode' => '<string>',
'restOfWorld' => true,
'shouldIncludeAllProvince' => true
]
],
'locationId' => '<string>'
]
],
'name' => '<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/delivery-profiles/v2/create-shipping-profile"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"locationInfos\": [\n {\n \"countryInfos\": [\n {\n \"code\": \"<string>\",\n \"deliveryMethodInfo\": [\n {\n \"amount\": 123,\n \"carrierRate\": true,\n \"carrierServiceId\": \"<string>\",\n \"deliveryConditionType\": \"<string>\",\n \"name\": \"<string>\",\n \"priceConditions\": [\n {\n \"amount\": 123,\n \"deliverCondtion\": \"<string>\"\n }\n ],\n \"weightConditions\": [\n {\n \"deliveryCondition\": \"<string>\",\n \"weight\": 123,\n \"weightUnit\": \"<string>\"\n }\n ]\n }\n ],\n \"provinceCode\": \"<string>\",\n \"restOfWorld\": true,\n \"shouldIncludeAllProvince\": true\n }\n ],\n \"locationId\": \"<string>\"\n }\n ],\n \"name\": \"<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://subscription-admin.appstle.com/api/external/v2/delivery-profiles/v2/create-shipping-profile")
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 \"id\": \"<string>\",\n \"locationInfos\": [\n {\n \"countryInfos\": [\n {\n \"code\": \"<string>\",\n \"deliveryMethodInfo\": [\n {\n \"amount\": 123,\n \"carrierRate\": true,\n \"carrierServiceId\": \"<string>\",\n \"deliveryConditionType\": \"<string>\",\n \"name\": \"<string>\",\n \"priceConditions\": [\n {\n \"amount\": 123,\n \"deliverCondtion\": \"<string>\"\n }\n ],\n \"weightConditions\": [\n {\n \"deliveryCondition\": \"<string>\",\n \"weight\": 123,\n \"weightUnit\": \"<string>\"\n }\n ]\n }\n ],\n \"provinceCode\": \"<string>\",\n \"restOfWorld\": true,\n \"shouldIncludeAllProvince\": true\n }\n ],\n \"locationId\": \"<string>\"\n }\n ],\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"deliveryProfileId": "<string>",
"shop": "<string>",
"id": 123,
"name": "<string>",
"sellerGroupIds": [
"<string>"
]
}{
"deliveryProfileId": "<string>",
"shop": "<string>",
"id": 123,
"name": "<string>",
"sellerGroupIds": [
"<string>"
]
}{
"deliveryProfileId": "<string>",
"shop": "<string>",
"id": 123,
"name": "<string>",
"sellerGroupIds": [
"<string>"
]
}{
"deliveryProfileId": "<string>",
"shop": "<string>",
"id": 123,
"name": "<string>",
"sellerGroupIds": [
"<string>"
]
}{
"deliveryProfileId": "<string>",
"shop": "<string>",
"id": 123,
"name": "<string>",
"sellerGroupIds": [
"<string>"
]
}