Skip to main content
GET
/
products
/
{productId}
Get Product
curl --request GET \
  --url https://staging-api.puppetvendors.com/products/{productId} \
  --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 the full details of a single product, including its variants, images, media, and metafields. Vendor tokens can only access their own products. Accepts a Shopify numeric ID, Shopify GID, or MongoDB ObjectId.

​
Use Cases

  • Load all product data for an edit form
  • Check variant-level inventory and pricing
  • Read metafield values attached to a product

​
Required Scope

products:read

​
Path Parameters

​
productId
string
required
The product identifier. Accepts any of these formats:
  • MongoDB ObjectId (e.g. 507f1f77bcf86cd799439013)
  • Shopify numeric ID (e.g. 7890123456789)
  • Shopify GID (e.g. gid://shopify/Product/7890123456789)

​
Response

200
{
  "success": true,
  "data": {
    "_id": "507f1f77bcf86cd799439013",
    "shopifyId": "7890123456789",
    "graphqlProductId": "gid://shopify/Product/7890123456789",
    "title": "Organic Cotton Tee",
    "handle": "organic-cotton-tee",
    "descriptionHtml": "<p>A soft, breathable tee made from 100% organic cotton.</p>",
    "productType": "T-Shirts",
    "vendor": "Acme Apparel",
    "status": "active",
    "tags": ["organic", "cotton", "summer"],
    "options": [
      {
        "name": "Size",
        "values": ["S", "M", "L", "XL"]
      },
      {
        "name": "Color",
        "values": ["White", "Black", "Navy"]
      }
    ],
    "variants": [
      {
        "id": "gid://shopify/ProductVariant/44012345678901",
        "title": "S / White",
        "sku": "ACME-TEE-S-WHT",
        "price": "29.99",
        "compareAtPrice": "39.99",
        "barcode": "194251038522",
        "inventoryQuantity": 42,
        "weight": 0.3,
        "weightUnit": "kg"
      }
    ],
    "images": [
      {
        "src": "https://cdn.shopify.com/s/files/1/0123/4567/8901/products/tee-white.jpg",
        "alt": "Organic cotton tee in white"
      }
    ],
    "metafields": [
      {
        "namespace": "custom",
        "key": "care_instructions",
        "value": "Machine wash cold",
        "type": "single_line_text_field"
      }
    ],
    "createdAt": "2026-03-10T08:30:00.000Z",
    "updatedAt": "2026-05-15T14:22:00.000Z"
  }
}
404
{
  "success": false,
  "error": {
    "message": "Product not found",
    "code": "NOT_FOUND"
  }
}

​
Example

curl -X GET "https://staging-api.puppetvendors.com/products/507f1f77bcf86cd799439013" \
  -H "x-access-token: YOUR_VENDOR_JWT"