Update Shipping Dimension
curl --request PUT \
--url https://production-api.puppetvendors.com/shipping/dimensions/{shippingDimensionsId} \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"type": "<string>",
"productId": "<string>",
"title": "<string>",
"dimensionUnit": "<string>",
"heightValue": 123,
"widthValue": 123,
"lengthValue": 123
}
'import requests
url = "https://production-api.puppetvendors.com/shipping/dimensions/{shippingDimensionsId}"
payload = {
"type": "<string>",
"productId": "<string>",
"title": "<string>",
"dimensionUnit": "<string>",
"heightValue": 123,
"widthValue": 123,
"lengthValue": 123
}
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
type: '<string>',
productId: '<string>',
title: '<string>',
dimensionUnit: '<string>',
heightValue: 123,
widthValue: 123,
lengthValue: 123
})
};
fetch('https://production-api.puppetvendors.com/shipping/dimensions/{shippingDimensionsId}', 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://production-api.puppetvendors.com/shipping/dimensions/{shippingDimensionsId}",
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([
'type' => '<string>',
'productId' => '<string>',
'title' => '<string>',
'dimensionUnit' => '<string>',
'heightValue' => 123,
'widthValue' => 123,
'lengthValue' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-access-token: <api-key>"
],
]);
$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://production-api.puppetvendors.com/shipping/dimensions/{shippingDimensionsId}"
payload := strings.NewReader("{\n \"type\": \"<string>\",\n \"productId\": \"<string>\",\n \"title\": \"<string>\",\n \"dimensionUnit\": \"<string>\",\n \"heightValue\": 123,\n \"widthValue\": 123,\n \"lengthValue\": 123\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-access-token", "<api-key>")
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://production-api.puppetvendors.com/shipping/dimensions/{shippingDimensionsId}")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"<string>\",\n \"productId\": \"<string>\",\n \"title\": \"<string>\",\n \"dimensionUnit\": \"<string>\",\n \"heightValue\": 123,\n \"widthValue\": 123,\n \"lengthValue\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.puppetvendors.com/shipping/dimensions/{shippingDimensionsId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"<string>\",\n \"productId\": \"<string>\",\n \"title\": \"<string>\",\n \"dimensionUnit\": \"<string>\",\n \"heightValue\": 123,\n \"widthValue\": 123,\n \"lengthValue\": 123\n}"
response = http.request(request)
puts response.read_bodyShipping Operations
Update Shipping Dimension
Update an existing shipping dimension preset
PUT
/
shipping
/
dimensions
/
{shippingDimensionsId}
Update Shipping Dimension
curl --request PUT \
--url https://production-api.puppetvendors.com/shipping/dimensions/{shippingDimensionsId} \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"type": "<string>",
"productId": "<string>",
"title": "<string>",
"dimensionUnit": "<string>",
"heightValue": 123,
"widthValue": 123,
"lengthValue": 123
}
'import requests
url = "https://production-api.puppetvendors.com/shipping/dimensions/{shippingDimensionsId}"
payload = {
"type": "<string>",
"productId": "<string>",
"title": "<string>",
"dimensionUnit": "<string>",
"heightValue": 123,
"widthValue": 123,
"lengthValue": 123
}
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
type: '<string>',
productId: '<string>',
title: '<string>',
dimensionUnit: '<string>',
heightValue: 123,
widthValue: 123,
lengthValue: 123
})
};
fetch('https://production-api.puppetvendors.com/shipping/dimensions/{shippingDimensionsId}', 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://production-api.puppetvendors.com/shipping/dimensions/{shippingDimensionsId}",
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([
'type' => '<string>',
'productId' => '<string>',
'title' => '<string>',
'dimensionUnit' => '<string>',
'heightValue' => 123,
'widthValue' => 123,
'lengthValue' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-access-token: <api-key>"
],
]);
$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://production-api.puppetvendors.com/shipping/dimensions/{shippingDimensionsId}"
payload := strings.NewReader("{\n \"type\": \"<string>\",\n \"productId\": \"<string>\",\n \"title\": \"<string>\",\n \"dimensionUnit\": \"<string>\",\n \"heightValue\": 123,\n \"widthValue\": 123,\n \"lengthValue\": 123\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-access-token", "<api-key>")
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://production-api.puppetvendors.com/shipping/dimensions/{shippingDimensionsId}")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"<string>\",\n \"productId\": \"<string>\",\n \"title\": \"<string>\",\n \"dimensionUnit\": \"<string>\",\n \"heightValue\": 123,\n \"widthValue\": 123,\n \"lengthValue\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://production-api.puppetvendors.com/shipping/dimensions/{shippingDimensionsId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"<string>\",\n \"productId\": \"<string>\",\n \"title\": \"<string>\",\n \"dimensionUnit\": \"<string>\",\n \"heightValue\": 123,\n \"widthValue\": 123,\n \"lengthValue\": 123\n}"
response = http.request(request)
puts response.read_bodyV2 Preview — This endpoint is part of the V2 API preview. Breaking changes may occur.
Overview
Update an existing shipping dimension preset. All fields are optional — only the provided fields are updated.Use Cases
- Correct packaging dimensions for a preset
- Rename a dimension preset
- Change the unit of measurement
Path Parameters
string
required
The ID of the shipping dimension preset to update.
Request Body
string
Dimension type. Must be
generic or productSpecific.string
Shopify product ID.
string
A human-readable name for the preset.
string
Unit of measurement. Must be one of:
in, cm, mm, ft, m, yd.number
Package height. Minimum 0.
number
Package width. Minimum 0.
number
Package length. Minimum 0.
Response
200
{
"success": true,
"data": {
"_id": "665a1b2e3d98f0001a2b3c52",
"type": "generic",
"title": "Medium Box (Updated)",
"dimensionUnit": "in",
"heightValue": 9,
"widthValue": 10,
"lengthValue": 12
}
}
Example
curl -X PUT "https://production-api.puppetvendors.com/shipping/dimensions/665a1b2e3d98f0001a2b3c52" \
-H "x-access-token: YOUR_VENDOR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"title": "Medium Box (Updated)",
"heightValue": 9
}'
Was this page helpful?
⌘I