Skip to main content
GET
/
shipping
/
dimensions
List Shipping Dimensions
curl --request GET \
  --url https://staging-api.puppetvendors.com/shipping/dimensions \
  --header 'x-access-token: <api-key>'

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

Retrieve saved shipping dimension presets for the vendor. Dimensions can be generic (reusable across products) or product-specific. These presets pre-fill package dimensions when fetching shipping rates.

​
Use Cases

  • List available dimension presets for a rate-fetch UI
  • Filter product-specific dimensions for a particular product
  • Audit saved dimension configurations

​
Query Parameters

​
type
string
Filter by dimension type. Must be generic or productSpecific.
​
productId
string
Filter by Shopify product ID. Typically used with type=productSpecific.
​
title
string
Filter by dimension preset title.

​
Response

200
{
  "success": true,
  "data": [
    {
      "_id": "665a1b2e3d98f0001a2b3c50",
      "type": "generic",
      "title": "Small Box",
      "dimensionUnit": "in",
      "heightValue": 4,
      "widthValue": 6,
      "lengthValue": 8
    },
    {
      "_id": "665a1b2e3d98f0001a2b3c51",
      "type": "productSpecific",
      "productId": "7890123456",
      "title": "Widget Packaging",
      "dimensionUnit": "cm",
      "heightValue": 10,
      "widthValue": 15,
      "lengthValue": 20
    }
  ]
}

​
Example

curl -X GET "https://staging-api.puppetvendors.com/shipping/dimensions?type=generic" \
  -H "x-access-token: YOUR_VENDOR_TOKEN"