---
title: "Get an offer's variant"
description: "Read one variant on a preorder offer: its row in the offer's Products table."
url: https://docs.stoqapp.com/v2-reference/preorders-offers/get-an-offers-variant/
api: "API v2 reference"
method: GET
path: "/preorders/offers/{id}/products/variants/{shopify_variant_id}"
---

# Get an offer's variant

`GET https://app.stoqapp.com/api/v2/external/preorders/offers/{id}/products/variants/{shopify_variant_id}`

Read one variant on a preorder offer: its row in the offer's Products table.

**Note:** :shopify_variant_id is the Shopify variant gid (a numeric id also works).

## Path parameters

- `id` (string, required): The offer's ID, from [`GET /preorders/offers`](https://docs.stoqapp.com/v2-reference/preorders-offers/list-offers/).
- `shopify_variant_id` (string, required): The variant, as gid://shopify/ProductVariant/&lt;id&gt; or the numeric ID.

## Returns

- `id` (string): ID of this variant's place on the offer.
- `shopify_variant_id` (string): The variant, as gid://shopify/ProductVariant/&lt;id&gt;.
- `product` (object): The variant's product.
  - `shopify_product_id` (string): The product, as gid://shopify/Product/&lt;id&gt;.
  - `title` (string): Product title.
  - `status` (string, nullable): Product status in Shopify, such as active, draft, archived or unlisted. Null when not stored yet; include_statuses=true reads it from Shopify.
- `title` (string): Variant name: product and variant title together, or the product title alone for a product's only variant.
- `variant_title` (string, nullable): Variant title. Null for a product's only variant (Shopify's &quot;Default Title&quot;).
- `sku` (string): Variant SKU. Null when it has none.
- `discarded` (boolean): true when the variant has been deleted from the catalog.
- `shipping_text` (string): This variant's own shipping text. Null when it has none and the offer's text shows.
- `max_count` (integer): This variant's own quantity limit. Null when it has none. Kept but not enforced while the offer has batches on.
- `quantity_limit` (integer): The quantity limit that applies: max_count, or the batches' total on a batch offer. Null when unlimited. Read-only.
- `preorder_count` (integer): Units preordered that count toward the quantity limit.
- `quantity_limit_reached` (boolean): true when preorder_count has reached quantity_limit, or the batch limit on a batch offer.
- `current_batch_id` (string, nullable): Batch the variant is selling in now. Null when the offer has batches off or the variant is in no batch.
- `created_at` (string): When the variant was added to the offer, ISO 8601 in UTC.
- `batch_limits` (object): This variant's own quantity limit per batch, keyed by batch ID. Batches left out use the batch's quantity_limit.
- `batch_ship_texts` (object): This variant's own ship text per batch, keyed by batch ID. Batches left out use the batch's shipping_text.
- `batch_progress` (object, nullable): Units sold and the limit per batch, and the batch on sale now. Null when the offer has batches off.
  - `current_batch_id` (string): Batch the variant is selling in now.
  - `batches` (array of objects): Every batch, in selling order.
    - `batch_id` (string): Batch ID.
    - `position` (integer): Place in the selling order, from 1.
    - `quantity_limit` (integer): Limit enforced for this variant in the batch: its own batch_limits value, or the batch's.
    - `default_quantity_limit` (integer): The batch's own quantity_limit.
    - `count` (integer): Units of this variant sold in the batch.

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/offers/73a74948-2b57-4cc3-971f-2b441828c977/products/variants/{shopify_variant_id}" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

## 200

Success: the requested resource.

```json
{
  "id": "string",
  "shopify_variant_id": "string",
  "product": {
    "shopify_product_id": "string",
    "title": "string",
    "status": "string"
  },
  "title": "string",
  "variant_title": "string",
  "sku": "string",
  "discarded": true,
  "shipping_text": "string",
  "max_count": 1,
  "quantity_limit": 1,
  "preorder_count": 1,
  "quantity_limit_reached": true,
  "current_batch_id": "string",
  "created_at": "2026-01-15T09:30:00Z",
  "batch_limits": {},
  "batch_ship_texts": {},
  "batch_progress": {
    "current_batch_id": "string",
    "batches": [
      {
        "batch_id": "string",
        "position": 1,
        "quantity_limit": 1,
        "default_quantity_limit": 1,
        "count": 1
      }
    ]
  }
}
```

## 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
    }
  ]
}
```

