Update an offer's variant
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/preorders/offers/{id}/products/variants/{shopify_variant_id}Costs 2 rate-limit points · Rate limits
Set one variant's Limit, Shipping and per-batch limits on a preorder offer, as the Products table edits them.
Deep partial: absent fields are unchanged. null clears shipping_text (the offer's text shows) and removes max_count. :shopify_variant_id is the variant's Shopify gid (a numeric id also works). market_overrides is no longer accepted; set per-market values on the offer instead.
Also searched asoverride variant settingsset shipping text for variantset max count for variantper-variant overrides
Path parameters
idstringRequiredThe offer's ID, from
GET /preorders/offers.shopify_variant_idstringRequiredThe variant, as gid://shopify/ProductVariant/<id> or the numeric ID.
Headers
Idempotency-KeystringA fresh unique key for every write (a new UUID, say); reuse it only to retry that write. Keys are remembered for 1 hour: the same key and the same request within that hour returns the first result, with
Idempotent-Replayed: true, without running again; the same key with a different method, path or body is refused (422idempotency_key_reused); a retry while the first is still running gets 409idempotency_key_in_progress. Keys are per store. Server errors and rate limits are not kept, so their retry runs.
Request body
shipping_textstring, nullableShipping text for this variant only; null clears it so the offer's text shows.
max_countinteger, nullableQuantity limit for this variant, 1 or more; null removes it. Refused while the offer has batches on.
batch_limitsobjectThis variant's own quantity limit per batch, keyed by batch_id (from GET /preorders/offers/:id/batches). A batch left out is unchanged; null puts the variant back on the batch's quantity_limit; batch_limits: null clears every batch. Needs batches on and a quantity_limit on every batch. Values are whole numbers of 1 or more.
batch_ship_textsobjectThis variant's own ship text per batch, keyed by batch_id (from GET /preorders/offers/:id/batches), e.g. "Ships July 1" for one size while the batch ships June 10. A batch left out is unchanged; null or "" puts the variant back on the batch's shipping_text; batch_ship_texts: null clears every batch. Needs batches on.
Returns
idstringID of this variant's place on the offer.
shopify_variant_idstringThe variant, as gid://shopify/ProductVariant/<id>.
productobjectThe variant's product.
Show 3 child attributesHide child attributes
shopify_product_idstringThe product, as gid://shopify/Product/<id>.
titlestringProduct title.
statusnullProduct status in Shopify, such as active, draft, archived or unlisted. Null when not stored yet; include_statuses=true reads it from Shopify.
titlestringVariant name: product and variant title together, or the product title alone for a product's only variant.
variant_titlestringVariant title. Null for a product's only variant (Shopify's "Default Title").
skustringVariant SKU. Null when it has none.
discardedbooleantrue when the variant has been deleted from the catalog.
shipping_textstring, nullableThis variant's own shipping text. Null when it has none and the offer's text shows.
max_countinteger, nullableThis variant's own quantity limit. Null when it has none. Kept but not enforced while the offer has batches on.
quantity_limitinteger, nullableThe quantity limit that applies: max_count, or the batches' total on a batch offer. Null when unlimited. Read-only.
preorder_countintegerUnits preordered that count toward the quantity limit.
quantity_limit_reachedbooleantrue when preorder_count has reached quantity_limit, or the batch limit on a batch offer.
current_batch_idnullBatch the variant is selling in now. Null when the offer has batches off or the variant is in no batch.
created_atstringWhen the variant was added to the offer, ISO 8601 in UTC.
batch_limitsobjectThis variant's own quantity limit per batch, keyed by batch ID. Batches left out use the batch's quantity_limit.
batch_ship_textsobjectThis variant's own ship text per batch, keyed by batch ID. Batches left out use the batch's shipping_text.
batch_progressnullUnits sold and the limit per batch, and the batch on sale now. Null when the offer has batches off.
Errors
not_foundThe path is valid but nothing with that id exists in this store.
conflictThe request is well formed, but the resource's current state does not allow it.
idempotency_key_in_progressAn earlier request with the same Idempotency-Key is still running. Wait, then resend the same request with the same key.
invalid_paramsOne or more fields failed the action's schema.
validation_failedThe request failed validation.
shopify_errorA Shopify call the operation needs failed after the operation had started.
upstream_unavailableA service the answer depends on did not respond in time.
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 -X PATCH "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" \
-H "Content-Type: application/json" \
-d '{
"shipping_text": "Ships early September",
"max_count": 75
}'const res = await fetch("https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/products/variants/{shopify_variant_id}", {
method: "PATCH",
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"shipping_text": "Ships early September",
"max_count": 75
}),
});
const data = await res.json();import os
import requests
res = requests.patch(
"https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/products/variants/{shopify_variant_id}",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
json={
"shipping_text": "Ships early September",
"max_count": 75
},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/products/variants/{shopify_variant_id}")
req = Net::HTTP::Patch.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"], "Content-Type" => "application/json")
req.body = {
shipping_text: "Ships early September",
max_count: 75
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"id": "b1f0c6d2-3e4a-4c1b-9a77-2d5e8f1a6c30",
"shopify_variant_id": "gid://shopify/ProductVariant/44712349876501",
"product": {
"shopify_product_id": "gid://shopify/Product/8123456789013",
"title": "Trail Runner Sneaker",
"status": "active"
},
"title": "Trail Runner Sneaker",
"variant_title": "US 9 / Black",
"sku": "TRS-BLK-09",
"discarded": false,
"shipping_text": "Ships early September",
"max_count": 75,
"quantity_limit": 75,
"preorder_count": 18,
"quantity_limit_reached": false,
"current_batch_id": null,
"created_at": "2026-06-25T10:42:10Z",
"batch_limits": {},
"batch_ship_texts": {},
"batch_progress": null
}{
"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": [
"A request with this Idempotency-Key is still running"
],
"code": "idempotency_key_in_progress",
"details": [
{
"code": "idempotency_key_in_progress",
"message": "A request with this Idempotency-Key is still running",
"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
}
]
}