Get a variant
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/preorders/product_variants/{shopify_variant_id}Costs 1 rate-limit point · Rate limits
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.
:shopify_variant_id is a Shopify variant gid (a numeric id also works). The response is GET /preorders/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 writes); quantity_limit is the read-only limit that applies, which on a batch offer is the batches' total.
Also searched asshow preorder context for variantlook up variant preordersvariant preorder stateget preorder variantshow variant in preorderswhich offers is this variant inwhat offers contain this variant
Path parameters
shopify_variant_idstringRequiredThe variant, as gid://shopify/ProductVariant/<id> or the numeric ID.
Returns
variantobjectShow 9 child attributesHide child attributes
idstringExample:3f9a6c1e-8b2d-4e57-a0c4-6d1e9b7f2a85shopify_variant_idstringExample:gid://shopify/ProductVariant/47284734423096productobjectShow 3 child attributesHide child attributes
shopify_product_idstringExample:gid://shopify/Product/8784906035384titlestringExample:Classic Sneakerstatusstring, nullableExample:active
variant_titlestring, nullableExample:Blue / MediumskustringExample:CS-BLU-Mimage_urlstringExample:https://cdn.shopify.com/s/files/1/0712/3456/7890/files/cl…offersarray of objectsShow 6 child attributesHide child attributes
idstringExample:73a74948-2b57-4cc3-971f-2b441828c977shipping_textstringExample:Ships in early Augustmax_countintegerExample:100quantity_limitintegerExample:100preorder_countintegerExample:38quantity_limit_reachedbooleanExample:false
preorder_units_soldintegerExample:41line_item_revenuestringExample:4510.00
offersarray of objectsShow 8 child attributesHide child attributes
idstringExample:73a74948-2b57-4cc3-971f-2b441828c977internal_namestringExample:summer-2026current_statusstringExample:liveinventoryobjectShow 1 child attributeHide child attributes
stock_conditionstringExample:out_of_stock
marketsobjectShow 1 child attributeHide child attributes
scopestringExample:all
shippingobjectShow 1 child attributeHide child attributes
timelineobjectShow 1 child attributeHide child attributes
scopestringExample:per_variant
widgetobjectShow 1 child attributeHide child attributes
disclaimerobjectShow 1 child attributeHide child attributes
disclaimer_textstringExample:Ships in August. You're charged today.
paymentsobjectShow 1 child attributeHide child attributes
options_offeredstringExample:full
Errors
not_foundThe path is valid but nothing with that id exists in this store.
validation_failedThe 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.
curl "https://app.stoqapp.com/api/v2/external/preorders/product_variants/{shopify_variant_id}" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/preorders/product_variants/{shopify_variant_id}", {
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
},
});
const data = await res.json();import os
import requests
res = requests.get(
"https://app.stoqapp.com/api/v2/external/preorders/product_variants/{shopify_variant_id}",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.stoqapp.com/api/v2/external/preorders/product_variants/{shopify_variant_id}")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"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"
}
}
]
}{
"errors": [
"Invalid API key"
],
"code": "auth_invalid",
"details": [
{
"code": "auth_invalid",
"message": "Invalid API key",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"Offer not found"
],
"code": "not_found",
"details": [
{
"code": "not_found",
"message": "Offer not found",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"name is required"
],
"code": "validation_failed",
"details": [
{
"code": "validation_failed",
"message": "name is required",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited",
"details": [
{
"code": "rate_limited",
"message": "Rate limit exceeded",
"path": null,
"value": null,
"expected": null
}
]
}