---
title: "Get a variant"
description: "Read one Shopify variant as the Preorders > Products tab lists it: the offers it is in, with its shipping text, limit and count on each."
url: https://docs.stoqapp.com/v2-reference/preorders-product-variants/get-a-variant/
api: "API v2 reference"
method: GET
path: "/preorders/product_variants/{shopify_variant_id}"
---

# Get a variant

`GET https://app.stoqapp.com/api/v2/external/preorders/product_variants/{shopify_variant_id}`

Read one Shopify variant as the Preorders &gt; Products tab lists it: the offers it is in, with its shipping text, limit and count on each.

**Note:** :shopify_variant_id is a Shopify variant gid (a numeric id also works). The response is [`GET /preorders/products`](https://docs.stoqapp.com/v2-reference/preorders-products/list-products/) for this one variant: `variant` is a row and `offers` the offers it is in. `variant` also has the lifetime preorder_units_sold and line_item_revenue across every offer, without units on cancelled orders or units refunded before they shipped. max_count is the variant's own limit (what [`PATCH /preorders/products`](https://docs.stoqapp.com/v2-reference/preorders-products/update-products/) writes); quantity_limit is the read-only limit that applies, which on a batch offer is the batches' total.

## Path parameters

- `shopify_variant_id` (string, required): The variant, as gid://shopify/ProductVariant/&lt;id&gt; or the numeric ID.

## Returns

- `variant` (object)
  - `id` (string): e.g. `3f9a6c1e-8b2d-4e57-a0c4-6d1e9b7f2a85`
  - `shopify_variant_id` (string): e.g. `gid://shopify/ProductVariant/47284734423096`
  - `product` (object)
    - `shopify_product_id` (string): e.g. `gid://shopify/Product/8784906035384`
    - `title` (string): e.g. `Classic Sneaker`
    - `status` (string, nullable): e.g. `active`
  - `variant_title` (string, nullable): e.g. `Blue / Medium`
  - `sku` (string): e.g. `CS-BLU-M`
  - `image_url` (string): e.g. `https://cdn.shopify.com/s/files/1/0712/3456/7890/files/cl…`
  - `offers` (array of objects)
    - `id` (string): e.g. `73a74948-2b57-4cc3-971f-2b441828c977`
    - `shipping_text` (string): e.g. `Ships in early August`
    - `max_count` (integer): e.g. `100`
    - `quantity_limit` (integer): e.g. `100`
    - `preorder_count` (integer): e.g. `38`
    - `quantity_limit_reached` (boolean): e.g. `false`
  - `preorder_units_sold` (integer): e.g. `41`
  - `line_item_revenue` (string): e.g. `4510.00`
- `offers` (array of objects)
  - `id` (string): e.g. `73a74948-2b57-4cc3-971f-2b441828c977`
  - `internal_name` (string): e.g. `summer-2026`
  - `current_status` (string): e.g. `live`
  - `inventory` (object)
    - `stock_condition` (string): e.g. `out_of_stock`
  - `markets` (object)
    - `scope` (string): e.g. `all`
  - `shipping` (object)
    - `timeline` (object)
      - `scope` (string): e.g. `per_variant`
  - `widget` (object)
    - `disclaimer` (object)
      - `disclaimer_text` (string): e.g. `Ships in August. You're charged today.`
  - `payments` (object)
    - `options_offered` (string): e.g. `full`

Rate limit: this call costs 1 point ([rate limits](https://docs.stoqapp.com/docs/rate-limits/)).

## Example request

```sh
curl "https://app.stoqapp.com/api/v2/external/preorders/product_variants/{shopify_variant_id}" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

## 200

Success: example response shown.

```json
{
  "variant": {
    "id": "3f9a6c1e-8b2d-4e57-a0c4-6d1e9b7f2a85",
    "shopify_variant_id": "gid://shopify/ProductVariant/47284734423096",
    "product": {
      "shopify_product_id": "gid://shopify/Product/8784906035384",
      "title": "Classic Sneaker",
      "status": "active"
    },
    "variant_title": "Blue / Medium",
    "sku": "CS-BLU-M",
    "image_url": "https://cdn.shopify.com/s/files/1/0712/3456/7890/files/classic-sneaker-blue.jpg",
    "offers": [
      {
        "id": "73a74948-2b57-4cc3-971f-2b441828c977",
        "shipping_text": "Ships in early August",
        "max_count": 100,
        "quantity_limit": 100,
        "preorder_count": 38,
        "quantity_limit_reached": false
      }
    ],
    "preorder_units_sold": 41,
    "line_item_revenue": "4510.00"
  },
  "offers": [
    {
      "id": "73a74948-2b57-4cc3-971f-2b441828c977",
      "internal_name": "summer-2026",
      "current_status": "live",
      "inventory": {
        "stock_condition": "out_of_stock"
      },
      "markets": {
        "scope": "all"
      },
      "shipping": {
        "timeline": {
          "scope": "per_variant"
        }
      },
      "widget": {
        "disclaimer": {
          "disclaimer_text": "Ships in August. You're charged today."
        }
      },
      "payments": {
        "options_offered": "full"
      }
    }
  ]
}
```

## 401

Missing or invalid `X-Auth-Token`.

```json
{
  "errors": [
    "Invalid API key"
  ],
  "code": "auth_invalid",
  "details": [
    {
      "code": "auth_invalid",
      "message": "Invalid API key",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 404

The resource does not exist for this shop, or the action path is not registered.

```json
{
  "errors": [
    "Offer not found"
  ],
  "code": "not_found",
  "details": [
    {
      "code": "not_found",
      "message": "Offer not found",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 422

The request failed validation.

```json
{
  "errors": [
    "name is required"
  ],
  "code": "validation_failed",
  "details": [
    {
      "code": "validation_failed",
      "message": "name is required",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 429

Rate limited: cost-weighted per token (read 1, write 2; 360 points / 60s). Check `Retry-After`.

```json
{
  "errors": [
    "Rate limit exceeded"
  ],
  "code": "rate_limited",
  "details": [
    {
      "code": "rate_limited",
      "message": "Rate limit exceeded",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

