Reset a preorder count
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/preorders/product_variants/{shopify_variant_id}/reset_preorder_countCosts 2 rate-limit points · Rate limits
Hard-reset the variant's preorder count to zero on every offer, retiring the orders counted so far.
Use recalculate_preorder_count for a recompute from real orders; this is a destructive zero.
Also searched aszero out preorder countclear preorder countreset count to zero
Path parameters
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.
Returns
variantobjectShow 9 child attributesHide child attributes
idstringExample:b81d4e2a-6c3f-4a95-9e07-1f5c8d2b6a34shopify_variant_idstringExample:gid://shopify/ProductVariant/47284734455864productobjectShow 3 child attributesHide child attributes
shopify_product_idstringExample:gid://shopify/Product/8784906035384titlestringExample:Classic SneakerstatusnullExample:active
variant_titlestringExample:Red / LargeskustringExample:CS-RED-Limage_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:0quantity_limit_reachedbooleanExample:false
preorder_units_soldintegerExample:31line_item_revenuestringExample:3410.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.
idempotency_key_in_progressAn earlier request with the same Idempotency-Key is still running. Wait, then resend the same request with the same key.
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 -X POST "https://app.stoqapp.com/api/v2/external/preorders/product_variants/{shopify_variant_id}/reset_preorder_count" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/preorders/product_variants/{shopify_variant_id}/reset_preorder_count", {
method: "POST",
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
},
});
const data = await res.json();import os
import requests
res = requests.post(
"https://app.stoqapp.com/api/v2/external/preorders/product_variants/{shopify_variant_id}/reset_preorder_count",
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}/reset_preorder_count")
req = Net::HTTP::Post.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": "b81d4e2a-6c3f-4a95-9e07-1f5c8d2b6a34",
"shopify_variant_id": "gid://shopify/ProductVariant/47284734455864",
"product": {
"shopify_product_id": "gid://shopify/Product/8784906035384",
"title": "Classic Sneaker",
"status": "active"
},
"variant_title": "Red / Large",
"sku": "CS-RED-L",
"image_url": "https://cdn.shopify.com/s/files/1/0712/3456/7890/files/classic-sneaker-red.jpg",
"offers": [
{
"id": "73a74948-2b57-4cc3-971f-2b441828c977",
"shipping_text": "Ships in early August",
"max_count": 100,
"quantity_limit": 100,
"preorder_count": 0,
"quantity_limit_reached": false
}
],
"preorder_units_sold": 31,
"line_item_revenue": "3410.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": [
"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
}
]
}