# Shopify Product

## Overview

| Property | Value |
|----------|-------|
| **Status** | active |
| **Method** | `GET` |
| **Endpoint** | `/v2/shopify/product` |
| **Base URL** | `https://api.piloterr.com` |
| **Credit Cost** | 1 credit per call |
| **Documentation** | https://www.piloterr.com/library/shopify-product |

## Description

Extract full product details from any Shopify store product page, including title, variants, pricing, images, inventory, and options.

## Authentication

- **Key Name:** `x-api-key`
- **Location:** HTTP Header
- **Get an API key:** https://app.piloterr.com/register

## Example Request

```bash
curl --location --request GET 'https://api.piloterr.com/v2/shopify/product' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY'
```

## Example Response

### Lookup Decathlon Easybreath Mask product

```json
{
  "id": 7017883533374,
  "tags": "Adult, Boy's, DEAL, FAMILY: 10645, Gift_Ideas, Holiday Product List, Kids, mask-snorkel-fins-set, Men's, WATER_SPORTS, Women's",
  "image": {
    "id": 30763514069054,
    "alt": "{*blue-8732687*}",
    "src": "https://cdn.shopify.com/s/files/1/1330/6287/files/8732687-product_image-p2143297.jpg?v=1700515471",
    "width": 2000,
    "height": 2000,
    "position": 1,
    "created_at": "2023-11-15T10:22:37-08:00",
    "product_id": 7017883533374,
    "updated_at": "2023-11-20T13:24:31-08:00"
  },
  "title": "Adult's Easybreath Surface Mask Acoustic Valve - 540 Freetalk Jungle",
  "handle": "adults-easybreath-surface-mask-acoustic-valve-540-freetalk-blue-330093",
  "vendor": "Subea",
  "options": [
    {
      "id": 9022772510782,
      "name": "Color",
      "values": [
        "Royal Blue",
        "Blue"
      ],
      "position": 1,
      "product_id": 7017883533374
    },
    {
      "id": 9022772543550,
      "name": "Size",
      "values": [
        "S/M",
        "ML",
        "M /L"
      ],
      "position": 2,
      "product_id": 7017883533374
    }
  ],
  "variants": [
    {
      "id": 40088252186686,
      "sku": "4200766",
      "grams": 639,
      "price": "30.00",
      "title": "Royal Blue / S/M / 8613126",
      "weight": 0.639,
      "barcode": "3608390035854",
      "option1": "Royal Blue",
      "option2": "S/M",
      "taxable": true,
      "position": 1,
      "created_at": "2023-06-05T04:22:25-07:00",
      "product_id": 7017883533374,
      "updated_at": "2024-01-07T11:17:33-08:00",
      "weight_unit": "kg",
      "compare_at_price": "49.99",
      "inventory_policy": "deny",
      "requires_shipping": true,
      "inventory_quantity": 0,
      "fulfillment_service": "manual",
      "inventory_management": "shopify"
    }
  ],
  "body_html": "<h4>Description</h4><p>The Easybreath 540 full-face snorkel mask is designed for use by adults and teens. The mask comes in two different sizes (S/M and M/L) and fits snug to your head while still allowing you to easily communicate with your snorkeling partner.</p>",
  "created_at": "2022-07-11T23:04:31-07:00",
  "updated_at": "2024-01-07T11:17:33-08:00",
  "product_type": "Diving mask",
  "published_at": "2022-07-12T10:15:36-07:00",
  "published_scope": "web",
  "template_suffix": ""
}
```

## Documentation

## Overview
The Shopify Product API retrieves complete product data from any Shopify-powered storefront, including title, vendor, variants, pricing, images, inventory, and options.

## Quickstart
```
GET https://api.piloterr.com/v2/shopify/product?query=https://www.decathlon.com/products/simond-backpacking-sleeping-bag-mt500-41-f-synthetic-346446
```

## Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| `query` | string | yes | Full URL of a Shopify product page |

## Response fields
| Field | Type | Description |
|---|---|---|
| `title` | string | Product title |
| `vendor` | string | Brand/vendor name |
| `variants[].price` | string | Variant price |
| `variants[].compare_at_price` | string | Original price before discount |
| `variants[].inventory_quantity` | number | Current stock quantity |
| `options[].name` | string | Option name (Color, Size, etc.) |
| `image.src` | string | Main product image URL |
| `body_html` | string | Full HTML description |

## Notes
- Works with any public Shopify store.
- `compare_at_price` is non-null when the product is on sale.

## Main use cases
- Automate price and inventory tracking across Shopify stores
- Enrich competitor intelligence pipelines with live product data
- Build cross-store product comparison tools for Shopify merchants
- Power market research workflows with structured data from any Shopify storefront