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
}
'

Documentation Index

Fetch the complete documentation index at: https://dev.puppetvendors.com/llms.txt

Use this file to discover all available pages before exploring further.

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
  }'