Skip to main content
POST
/
shipping
/
dimensions
Create Shipping Dimension
curl --request POST \
  --url https://staging-api.puppetvendors.com/shipping/dimensions \
  --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://staging-api.puppetvendors.com/shipping/dimensions"

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.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
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://staging-api.puppetvendors.com/shipping/dimensions', 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.puppetvendors.com/shipping/dimensions",
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([
'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://staging-api.puppetvendors.com/shipping/dimensions"

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("POST", 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.post("https://staging-api.puppetvendors.com/shipping/dimensions")
.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://staging-api.puppetvendors.com/shipping/dimensions")

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

request = Net::HTTP::Post.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_body
V2 Preview — This endpoint is part of the V2 API preview. Breaking changes may occur.

Overview

Create a new shipping dimension preset. Presets can be generic (reusable) or product-specific. These are used to pre-fill package dimensions when fetching shipping rates.

Use Cases

  • Save commonly used box sizes for quick rate lookups
  • Define product-specific packaging dimensions
  • Standardize packaging across the vendor’s catalogue

Request Body

type
string
required
Dimension type. Must be generic or productSpecific.
productId
string
Shopify product ID. Required when type is productSpecific.
title
string
A human-readable name for the preset (e.g. “Small Box”).
dimensionUnit
string
required
Unit of measurement. Must be one of: in, cm, mm, ft, m, yd.
heightValue
number
required
Package height. Minimum 0.
widthValue
number
required
Package width. Minimum 0.
lengthValue
number
required
Package length. Minimum 0.

Response

200
{
  "success": true,
  "data": {
    "_id": "665a1b2e3d98f0001a2b3c52",
    "type": "generic",
    "title": "Medium Box",
    "dimensionUnit": "in",
    "heightValue": 8,
    "widthValue": 10,
    "lengthValue": 12
  }
}

Example

curl -X POST "https://staging-api.puppetvendors.com/shipping/dimensions" \
  -H "x-access-token: YOUR_VENDOR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "generic",
    "title": "Medium Box",
    "dimensionUnit": "in",
    "heightValue": 8,
    "widthValue": 10,
    "lengthValue": 12
  }'