Bulk recalculate counts
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/preorders/product_variants/bulk_recalculate_preorder_countsCosts 2 rate-limit points · Rate limits
Recompute preorder_count for many variants in one job (max 5000).
Runs POST /preorders/product_variants/:shopify_variant_id/recalculate_preorder_count for each variant in the background, for when preorder counts drifted from orders across many variants. shopify_variant_ids takes gids or numeric ids, duplicates dropped; an empty list or more than 5000 fails with 422 validation_failed. Returns 202 with job_id and status_url: poll GET /preorders/product_variants/jobs/:job_id until state is completed. Variants STOQ doesn't know, or that fail, are skipped without failing the job, and the job doesn't name them.
Also searched asrecalculate counts for variantsbulk fix preorder countsrecalculate many variantsbatch recompute counts
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
shopify_variant_idsarray of stringsVariants to process in one background job, up to 5000, as numeric IDs or gid://shopify/ProductVariant/<id>.
Returns
job_idstringId of the background job doing the work.
status_urlstringPath of the endpoint that reports this job's progress; poll it until the job finishes. Results are kept for 24 hours.
variant_countintegerExample:3
Errors
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 action refused the request for a reason that is not a single bad field.
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/bulk_recalculate_preorder_counts" \
-H "X-Auth-Token: $STOQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"shopify_variant_ids": [
"gid://shopify/ProductVariant/47284734423096",
"gid://shopify/ProductVariant/47284734455864",
"gid://shopify/ProductVariant/47284734488632"
]
}'const res = await fetch("https://app.stoqapp.com/api/v2/external/preorders/product_variants/bulk_recalculate_preorder_counts", {
method: "POST",
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"shopify_variant_ids": [
"gid://shopify/ProductVariant/47284734423096",
"gid://shopify/ProductVariant/47284734455864",
"gid://shopify/ProductVariant/47284734488632"
]
}),
});
const data = await res.json();import os
import requests
res = requests.post(
"https://app.stoqapp.com/api/v2/external/preorders/product_variants/bulk_recalculate_preorder_counts",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
json={
"shopify_variant_ids": [
"gid://shopify/ProductVariant/47284734423096",
"gid://shopify/ProductVariant/47284734455864",
"gid://shopify/ProductVariant/47284734488632"
]
},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.stoqapp.com/api/v2/external/preorders/product_variants/bulk_recalculate_preorder_counts")
req = Net::HTTP::Post.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"], "Content-Type" => "application/json")
req.body = {
shopify_variant_ids: [
"gid://shopify/ProductVariant/47284734423096",
"gid://shopify/ProductVariant/47284734455864",
"gid://shopify/ProductVariant/47284734488632"
]
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"job_id": "bulk_recalculate_preorder_count_3f1a9c7e2b5d8e40",
"status_url": "/api/v2/external/preorders/product_variants/jobs/bulk_recalculate_preorder_count_3f1a9c7e2b5d8e40",
"variant_count": 3
}{
"errors": [
"Invalid API key"
],
"code": "auth_invalid",
"details": [
{
"code": "auth_invalid",
"message": "Invalid API key",
"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
}
]
}