---
updatedAt: 2025-04-24T20:27:48.000Z
agentTools:
  projectIndex: https://api-docs.shippedsuite.com/llms.txt
---

# /v1/products/{external_id}

Returns a specific Product

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Shipped Suite API",
    "description": "API provides access to Shipped Suite functions",
    "contact": {
      "name": "Steven Ou",
      "email": "steven@invisiblecommerce.com"
    },
    "version": "v1"
  },
  "servers": [
    {
      "url": "//api.shippedsuite.com/"
    }
  ],
  "security": [
    {
      "secretKey": []
    }
  ],
  "tags": [
    {
      "name": "Products",
      "description": "Operations about Products"
    }
  ],
  "paths": {
    "/v1/products/{external_id}": {
      "get": {
        "tags": [
          "Products"
        ],
        "description": "Returns a specific Product",
        "operationId": "getV1ProductsExternalId",
        "parameters": [
          {
            "name": "external_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Returns a specific Product",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Product"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Product": {
        "required": [
          "brand",
          "category",
          "external_id",
          "images",
          "name",
          "status",
          "variants"
        ],
        "type": "object",
        "properties": {
          "external_id": {
            "type": "string",
            "description": "Unique ID of Product in partner platform",
            "example": "12443"
          },
          "brand": {
            "type": "string",
            "description": "Name of the Product's brand",
            "example": "Nike"
          },
          "name": {
            "type": "string",
            "description": "Name of the Product",
            "example": "Nike Air Max 90 SE"
          },
          "description": {
            "type": "string",
            "description": "Product description",
            "example": "Brushzees is the new shape of clean. Redesigned grooves and ridges on our new daily dental treat helps remove plaque and tartar like never before. Engineered for the ways dogs grip and chew, they turn playtime into fresher breath and cleaner teeth, giving dogs a reason to jump for joy.\n\n• Natural\n• Gluten Free\n• Vegetarian\n"
          },
          "category": {
            "type": "string",
            "description": "Product category",
            "example": "Men's Shoes"
          },
          "status": {
            "type": "string",
            "description": "Status of the product",
            "example": "active"
          },
          "custom_path": {
            "type": "string",
            "description": "Custom URL path for the product, must start with /",
            "example": "/catalog/nike-air-max-90-se"
          },
          "variants": {
            "type": "array",
            "description": "Collection of Variants belonging to the Product",
            "items": {
              "$ref": "#/components/schemas/Variant"
            }
          },
          "images": {
            "type": "array",
            "description": "Collection of Images belonging to the Product",
            "items": {
              "$ref": "#/components/schemas/Image"
            }
          }
        },
        "description": "Product model"
      },
      "Variant": {
        "required": [
          "external_id",
          "name",
          "price"
        ],
        "type": "object",
        "properties": {
          "external_id": {
            "type": "string",
            "description": "Unique ID of Variant in partner platform",
            "example": "12443"
          },
          "name": {
            "type": "string",
            "description": "Name of the Variant",
            "example": "Size: 9"
          },
          "sku": {
            "type": "string",
            "description": "Variant SKU",
            "example": "DN4155-001"
          },
          "barcode": {
            "type": "string",
            "description": "Variant barcode",
            "example": "079100522392"
          },
          "price": {
            "type": "number",
            "description": "Variant price",
            "example": 140
          },
          "compare_at_price": {
            "type": "number",
            "description": "Variant comparison price, e.g. MSRP",
            "example": 160
          },
          "position": {
            "type": "integer",
            "description": "Position of Variant within all of Product's Variants",
            "format": "int32",
            "example": 3
          },
          "option1": {
            "type": "string",
            "description": "Variant value for Product's first option",
            "example": "9"
          },
          "option2": {
            "type": "string",
            "description": "Variant value for Product's second option"
          },
          "option3": {
            "type": "string",
            "description": "Variant value for Product's third option"
          },
          "inventory_quantity": {
            "type": "integer",
            "description": "Quantity of Variant in stock",
            "format": "int32",
            "example": 38
          },
          "weight_unit": {
            "type": "string",
            "description": "Unit of measurement for Variant weight",
            "example": "lbs"
          },
          "weight": {
            "type": "number",
            "description": "Weight of Variant",
            "example": 2.43
          },
          "product_type": {
            "type": "string",
            "description": "The type of product",
            "example": "physical"
          },
          "custom_path": {
            "type": "string",
            "description": "Custom URL path for the variant, must start with /",
            "example": "/catalog/nike-air-max-90-se/size-9"
          }
        }
      },
      "Image": {
        "required": [
          "external_id",
          "url"
        ],
        "type": "object",
        "properties": {
          "external_id": {
            "type": "string",
            "description": "Unique ID of Image in partner platform",
            "example": "12443"
          },
          "url": {
            "type": "string",
            "description": "URL of the Image",
            "example": "https://cdn.shopify.com/s/files/1/0526/7436/3584/products/64as7essnzr5suqy2kllmc2l8r85.jpg?v=1616565488\n"
          },
          "position": {
            "type": "integer",
            "description": "Position of the Image relative to all of the Product's Images",
            "format": "int32",
            "example": 1
          },
          "width": {
            "type": "integer",
            "description": "Width of the Image in pixels",
            "format": "int32",
            "example": 2000
          },
          "height": {
            "type": "integer",
            "description": "Height of the Image in pixels",
            "format": "int32",
            "example": 2000
          }
        }
      }
    },
    "securitySchemes": {
      "secretKey": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header"
      }
    }
  },
  "x-original-swagger-version": "2.0"
}
```