Skip to content

Get an offer's variant

API v2 is in public beta: endpoints and fields can change before general availability. See the changelog

GET/preorders/offers/{id}/products/variants/{shopify_variant_id}

Costs 1 rate-limit point · Rate limits

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

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

Also searched asshow variant settings on offerview per-variant overridesget variant on offervariant settings

Path parameters

  • idstringRequired

    The offer's ID, from GET /preorders/offers.

  • shopify_variant_idstringRequired

    The variant, as gid://shopify/ProductVariant/<id> or the numeric ID.

Returns

  • idstring

    ID of this variant's place on the offer.

  • shopify_variant_idstring

    The variant, as gid://shopify/ProductVariant/<id>.

  • productobject

    The variant's product.

    Show 3 child attributesHide child attributes
    • shopify_product_idstring

      The product, as gid://shopify/Product/<id>.

    • titlestring

      Product title.

    • statusstring, nullable

      Product status in Shopify, such as active, draft, archived or unlisted. Null when not stored yet; include_statuses=true reads it from Shopify.

  • titlestring

    Variant name: product and variant title together, or the product title alone for a product's only variant.

  • variant_titlestring, nullable

    Variant title. Null for a product's only variant (Shopify's "Default Title").

  • skustring

    Variant SKU. Null when it has none.

  • discardedboolean

    true when the variant has been deleted from the catalog.

  • shipping_textstring

    This variant's own shipping text. Null when it has none and the offer's text shows.

  • max_countinteger

    This variant's own quantity limit. Null when it has none. Kept but not enforced while the offer has batches on.

  • quantity_limitinteger

    The quantity limit that applies: max_count, or the batches' total on a batch offer. Null when unlimited. Read-only.

  • preorder_countinteger

    Units preordered that count toward the quantity limit.

  • quantity_limit_reachedboolean

    true when preorder_count has reached quantity_limit, or the batch limit on a batch offer.

  • current_batch_idstring, nullable

    Batch the variant is selling in now. Null when the offer has batches off or the variant is in no batch.

  • created_atstring

    When the variant was added to the offer, ISO 8601 in UTC.

  • batch_limitsobject

    This variant's own quantity limit per batch, keyed by batch ID. Batches left out use the batch's quantity_limit.

  • batch_ship_textsobject

    This variant's own ship text per batch, keyed by batch ID. Batches left out use the batch's shipping_text.

  • batch_progressobject, nullable

    Units sold and the limit per batch, and the batch on sale now. Null when the offer has batches off.

    Show 2 child attributesHide child attributes
    • current_batch_idstring

      Batch the variant is selling in now.

    • batchesarray of objects

      Every batch, in selling order.

      Show 5 child attributesHide child attributes
      • batch_idstring

        Batch ID.

      • positioninteger

        Place in the selling order, from 1.

      • quantity_limitinteger

        Limit enforced for this variant in the batch: its own batch_limits value, or the batch's.

      • default_quantity_limitinteger

        The batch's own quantity_limit.

      • countinteger

        Units of this variant sold in the batch.

Errors

404
not_found

The path is valid but nothing with that id exists in this store.

422
validation_failed

The request failed validation.

Any request can also fail with auth_invalid (401) or rate_limited (429).

Every error has the same shape: see Errors and the list of error codes.

GET/preorders/offers/{id}/products/variants/{shopify_variant_id}
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"
Response
{
  "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
      }
    ]
  }
}