Bulk update variants
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/preorders/offers/{id}/products/variants/bulk_update_settingsCosts 2 rate-limit points · Rate limits
Set the same shipping text, max preorder count or per-batch limits on many variants of a preorder offer.
shopify_variant_ids is required (1 to 250 variant gids attached to the offer). The other fields follow PATCH /preorders/offers/:id/products/variants/:shopify_variant_id: absent is unchanged, null clears. Variants not attached to the offer are skipped and returned in skipped_shopify_variant_ids; the call fails with 422 if none are attached.
Path parameters
idstringRequiredThe offer's ID, from
GET /preorders/offers.
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 these variants; null clears it so the offer's text shows.
max_countinteger, nullableQuantity limit for these variants, 1 or more; null removes it. Refused while the offer has batches on.
shopify_variant_idsarray of stringsThe attached variants to change: gid://shopify/ProductVariant/<id>, 1 to 250.
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
updated_countintegerVariants on the offer whose settings were changed.
skipped_shopify_variant_idsarray of stringsVariants asked for that are not on the offer, as sent. They are left alone.
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.
job_in_progressAn earlier bulk change on the same resource is still running.
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.
quantity_limit_reachedEvery targeted variant has reached its preorder quantity limit, so STOQ keeps it from selling.
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/offers/73a74948-2b57-4cc3-971f-2b441828c977/products/variants/bulk_update_settings" \
-H "X-Auth-Token: $STOQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"shopify_variant_ids": [
"gid://shopify/ProductVariant/44712349876501",
"gid://shopify/ProductVariant/44712349909269"
],
"shipping_text": "Ships early September",
"max_count": 100
}'const res = await fetch("https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/products/variants/bulk_update_settings", {
method: "POST",
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"shopify_variant_ids": [
"gid://shopify/ProductVariant/44712349876501",
"gid://shopify/ProductVariant/44712349909269"
],
"shipping_text": "Ships early September",
"max_count": 100
}),
});
const data = await res.json();import os
import requests
res = requests.post(
"https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/products/variants/bulk_update_settings",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
json={
"shopify_variant_ids": [
"gid://shopify/ProductVariant/44712349876501",
"gid://shopify/ProductVariant/44712349909269"
],
"shipping_text": "Ships early September",
"max_count": 100
},
)
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/bulk_update_settings")
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/44712349876501",
"gid://shopify/ProductVariant/44712349909269"
],
shipping_text: "Ships early September",
max_count: 100
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"updated_count": 2,
"skipped_shopify_variant_ids": []
}{
"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
}
]
}