Update manual shipping method detail
curl --request PUT \
--url https://staging.api.commercengine.io/api/v1/{store_id}/admin/store/manual-shipping-methods/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"is_forward_shipping": true,
"is_return_shipping": true,
"enable_shipping_rate": true,
"delivery_leadtime_minimum": 123,
"delivery_leadtime_maximum": 123,
"shipping_zone_id": [
"<string>"
],
"warehouse_id": [
"<string>"
],
"is_default": false,
"maximum_weight": 123,
"shipping_rate_name": "<string>",
"shipping_rate_fixed_price": 123,
"shipping_rate_condition": {
"rate_based_on": "item-weight",
"rate_type": "weight-slabs",
"slabs": [
{
"weight": 123,
"shipping_rate": 123
}
]
}
}
'import requests
url = "https://staging.api.commercengine.io/api/v1/{store_id}/admin/store/manual-shipping-methods/{id}"
payload = {
"name": "<string>",
"is_forward_shipping": True,
"is_return_shipping": True,
"enable_shipping_rate": True,
"delivery_leadtime_minimum": 123,
"delivery_leadtime_maximum": 123,
"shipping_zone_id": ["<string>"],
"warehouse_id": ["<string>"],
"is_default": False,
"maximum_weight": 123,
"shipping_rate_name": "<string>",
"shipping_rate_fixed_price": 123,
"shipping_rate_condition": {
"rate_based_on": "item-weight",
"rate_type": "weight-slabs",
"slabs": [
{
"weight": 123,
"shipping_rate": 123
}
]
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
is_forward_shipping: true,
is_return_shipping: true,
enable_shipping_rate: true,
delivery_leadtime_minimum: 123,
delivery_leadtime_maximum: 123,
shipping_zone_id: ['<string>'],
warehouse_id: ['<string>'],
is_default: false,
maximum_weight: 123,
shipping_rate_name: '<string>',
shipping_rate_fixed_price: 123,
shipping_rate_condition: {
rate_based_on: 'item-weight',
rate_type: 'weight-slabs',
slabs: [{weight: 123, shipping_rate: 123}]
}
})
};
fetch('https://staging.api.commercengine.io/api/v1/{store_id}/admin/store/manual-shipping-methods/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://staging.api.commercengine.io/api/v1/{store_id}/admin/store/manual-shipping-methods/{id}",
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([
'name' => '<string>',
'is_forward_shipping' => true,
'is_return_shipping' => true,
'enable_shipping_rate' => true,
'delivery_leadtime_minimum' => 123,
'delivery_leadtime_maximum' => 123,
'shipping_zone_id' => [
'<string>'
],
'warehouse_id' => [
'<string>'
],
'is_default' => false,
'maximum_weight' => 123,
'shipping_rate_name' => '<string>',
'shipping_rate_fixed_price' => 123,
'shipping_rate_condition' => [
'rate_based_on' => 'item-weight',
'rate_type' => 'weight-slabs',
'slabs' => [
[
'weight' => 123,
'shipping_rate' => 123
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://staging.api.commercengine.io/api/v1/{store_id}/admin/store/manual-shipping-methods/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"is_forward_shipping\": true,\n \"is_return_shipping\": true,\n \"enable_shipping_rate\": true,\n \"delivery_leadtime_minimum\": 123,\n \"delivery_leadtime_maximum\": 123,\n \"shipping_zone_id\": [\n \"<string>\"\n ],\n \"warehouse_id\": [\n \"<string>\"\n ],\n \"is_default\": false,\n \"maximum_weight\": 123,\n \"shipping_rate_name\": \"<string>\",\n \"shipping_rate_fixed_price\": 123,\n \"shipping_rate_condition\": {\n \"rate_based_on\": \"item-weight\",\n \"rate_type\": \"weight-slabs\",\n \"slabs\": [\n {\n \"weight\": 123,\n \"shipping_rate\": 123\n }\n ]\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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))
}HttpResponse<String> response = Unirest.put("https://staging.api.commercengine.io/api/v1/{store_id}/admin/store/manual-shipping-methods/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"is_forward_shipping\": true,\n \"is_return_shipping\": true,\n \"enable_shipping_rate\": true,\n \"delivery_leadtime_minimum\": 123,\n \"delivery_leadtime_maximum\": 123,\n \"shipping_zone_id\": [\n \"<string>\"\n ],\n \"warehouse_id\": [\n \"<string>\"\n ],\n \"is_default\": false,\n \"maximum_weight\": 123,\n \"shipping_rate_name\": \"<string>\",\n \"shipping_rate_fixed_price\": 123,\n \"shipping_rate_condition\": {\n \"rate_based_on\": \"item-weight\",\n \"rate_type\": \"weight-slabs\",\n \"slabs\": [\n {\n \"weight\": 123,\n \"shipping_rate\": 123\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.api.commercengine.io/api/v1/{store_id}/admin/store/manual-shipping-methods/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"is_forward_shipping\": true,\n \"is_return_shipping\": true,\n \"enable_shipping_rate\": true,\n \"delivery_leadtime_minimum\": 123,\n \"delivery_leadtime_maximum\": 123,\n \"shipping_zone_id\": [\n \"<string>\"\n ],\n \"warehouse_id\": [\n \"<string>\"\n ],\n \"is_default\": false,\n \"maximum_weight\": 123,\n \"shipping_rate_name\": \"<string>\",\n \"shipping_rate_fixed_price\": 123,\n \"shipping_rate_condition\": {\n \"rate_based_on\": \"item-weight\",\n \"rate_type\": \"weight-slabs\",\n \"slabs\": [\n {\n \"weight\": 123,\n \"shipping_rate\": 123\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"success": true,
"content": {
"shipping_method": {
"name": "<string>",
"shipping_method_type": "manual",
"type": "manual",
"description": "<string>",
"is_connected": true,
"is_forward_shipping": true,
"is_return_shipping": true,
"enable_shipping_rate": true,
"delivery_leadtime_minimum": 123,
"delivery_leadtime_maximum": 123,
"id": "<string>",
"fulfillment_type": "delivery",
"logo_dark": "<string>",
"logo_light": "<string>",
"is_default": false,
"maximum_weight": 123,
"shipping_rate_name": "<string>",
"shipping_rate_fixed_price": 123,
"shipping_rate_condition": {
"rate_based_on": "item-weight",
"rate_type": "weight-slabs",
"slabs": [
{
"weight": 123,
"shipping_rate": 123,
"condition": "less-or-equal"
}
]
},
"shipping_zone": [
{
"id": "<string>",
"name": "<string>"
}
],
"warehouses": [
{
"id": "<string>",
"name": "<string>"
}
],
"status": "active"
}
}
}Store
Update manual shipping method detail
Update manual shipping method detail
PUT
/
store
/
manual-shipping-methods
/
{id}
Update manual shipping method detail
curl --request PUT \
--url https://staging.api.commercengine.io/api/v1/{store_id}/admin/store/manual-shipping-methods/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"is_forward_shipping": true,
"is_return_shipping": true,
"enable_shipping_rate": true,
"delivery_leadtime_minimum": 123,
"delivery_leadtime_maximum": 123,
"shipping_zone_id": [
"<string>"
],
"warehouse_id": [
"<string>"
],
"is_default": false,
"maximum_weight": 123,
"shipping_rate_name": "<string>",
"shipping_rate_fixed_price": 123,
"shipping_rate_condition": {
"rate_based_on": "item-weight",
"rate_type": "weight-slabs",
"slabs": [
{
"weight": 123,
"shipping_rate": 123
}
]
}
}
'import requests
url = "https://staging.api.commercengine.io/api/v1/{store_id}/admin/store/manual-shipping-methods/{id}"
payload = {
"name": "<string>",
"is_forward_shipping": True,
"is_return_shipping": True,
"enable_shipping_rate": True,
"delivery_leadtime_minimum": 123,
"delivery_leadtime_maximum": 123,
"shipping_zone_id": ["<string>"],
"warehouse_id": ["<string>"],
"is_default": False,
"maximum_weight": 123,
"shipping_rate_name": "<string>",
"shipping_rate_fixed_price": 123,
"shipping_rate_condition": {
"rate_based_on": "item-weight",
"rate_type": "weight-slabs",
"slabs": [
{
"weight": 123,
"shipping_rate": 123
}
]
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
is_forward_shipping: true,
is_return_shipping: true,
enable_shipping_rate: true,
delivery_leadtime_minimum: 123,
delivery_leadtime_maximum: 123,
shipping_zone_id: ['<string>'],
warehouse_id: ['<string>'],
is_default: false,
maximum_weight: 123,
shipping_rate_name: '<string>',
shipping_rate_fixed_price: 123,
shipping_rate_condition: {
rate_based_on: 'item-weight',
rate_type: 'weight-slabs',
slabs: [{weight: 123, shipping_rate: 123}]
}
})
};
fetch('https://staging.api.commercengine.io/api/v1/{store_id}/admin/store/manual-shipping-methods/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://staging.api.commercengine.io/api/v1/{store_id}/admin/store/manual-shipping-methods/{id}",
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([
'name' => '<string>',
'is_forward_shipping' => true,
'is_return_shipping' => true,
'enable_shipping_rate' => true,
'delivery_leadtime_minimum' => 123,
'delivery_leadtime_maximum' => 123,
'shipping_zone_id' => [
'<string>'
],
'warehouse_id' => [
'<string>'
],
'is_default' => false,
'maximum_weight' => 123,
'shipping_rate_name' => '<string>',
'shipping_rate_fixed_price' => 123,
'shipping_rate_condition' => [
'rate_based_on' => 'item-weight',
'rate_type' => 'weight-slabs',
'slabs' => [
[
'weight' => 123,
'shipping_rate' => 123
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://staging.api.commercengine.io/api/v1/{store_id}/admin/store/manual-shipping-methods/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"is_forward_shipping\": true,\n \"is_return_shipping\": true,\n \"enable_shipping_rate\": true,\n \"delivery_leadtime_minimum\": 123,\n \"delivery_leadtime_maximum\": 123,\n \"shipping_zone_id\": [\n \"<string>\"\n ],\n \"warehouse_id\": [\n \"<string>\"\n ],\n \"is_default\": false,\n \"maximum_weight\": 123,\n \"shipping_rate_name\": \"<string>\",\n \"shipping_rate_fixed_price\": 123,\n \"shipping_rate_condition\": {\n \"rate_based_on\": \"item-weight\",\n \"rate_type\": \"weight-slabs\",\n \"slabs\": [\n {\n \"weight\": 123,\n \"shipping_rate\": 123\n }\n ]\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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))
}HttpResponse<String> response = Unirest.put("https://staging.api.commercengine.io/api/v1/{store_id}/admin/store/manual-shipping-methods/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"is_forward_shipping\": true,\n \"is_return_shipping\": true,\n \"enable_shipping_rate\": true,\n \"delivery_leadtime_minimum\": 123,\n \"delivery_leadtime_maximum\": 123,\n \"shipping_zone_id\": [\n \"<string>\"\n ],\n \"warehouse_id\": [\n \"<string>\"\n ],\n \"is_default\": false,\n \"maximum_weight\": 123,\n \"shipping_rate_name\": \"<string>\",\n \"shipping_rate_fixed_price\": 123,\n \"shipping_rate_condition\": {\n \"rate_based_on\": \"item-weight\",\n \"rate_type\": \"weight-slabs\",\n \"slabs\": [\n {\n \"weight\": 123,\n \"shipping_rate\": 123\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.api.commercengine.io/api/v1/{store_id}/admin/store/manual-shipping-methods/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"is_forward_shipping\": true,\n \"is_return_shipping\": true,\n \"enable_shipping_rate\": true,\n \"delivery_leadtime_minimum\": 123,\n \"delivery_leadtime_maximum\": 123,\n \"shipping_zone_id\": [\n \"<string>\"\n ],\n \"warehouse_id\": [\n \"<string>\"\n ],\n \"is_default\": false,\n \"maximum_weight\": 123,\n \"shipping_rate_name\": \"<string>\",\n \"shipping_rate_fixed_price\": 123,\n \"shipping_rate_condition\": {\n \"rate_based_on\": \"item-weight\",\n \"rate_type\": \"weight-slabs\",\n \"slabs\": [\n {\n \"weight\": 123,\n \"shipping_rate\": 123\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"success": true,
"content": {
"shipping_method": {
"name": "<string>",
"shipping_method_type": "manual",
"type": "manual",
"description": "<string>",
"is_connected": true,
"is_forward_shipping": true,
"is_return_shipping": true,
"enable_shipping_rate": true,
"delivery_leadtime_minimum": 123,
"delivery_leadtime_maximum": 123,
"id": "<string>",
"fulfillment_type": "delivery",
"logo_dark": "<string>",
"logo_light": "<string>",
"is_default": false,
"maximum_weight": 123,
"shipping_rate_name": "<string>",
"shipping_rate_fixed_price": 123,
"shipping_rate_condition": {
"rate_based_on": "item-weight",
"rate_type": "weight-slabs",
"slabs": [
{
"weight": 123,
"shipping_rate": 123,
"condition": "less-or-equal"
}
]
},
"shipping_zone": [
{
"id": "<string>",
"name": "<string>"
}
],
"warehouses": [
{
"id": "<string>",
"name": "<string>"
}
],
"status": "active"
}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
shipping method id
Body
application/json
Available options:
manual, local-pickup in days.
in days.
can be null if there is no limit on weight.
required if enable_shipping_rate = true
can be null if shipping_rate_condition is provided.
- ShippingRateBasedOnWeightSlabs
- ShippingRatePerKgFixedPrice
- ShippingRateBasedOnOrderValue
Show child attributes
Show child attributes
Available options:
active, inactive Was this page helpful?
⌘I