Bulk set inventory policy
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/preorders/products/bulk_toggle_inventory_policyCosts 2 rate-limit points · Rate limits
Turn 'Continue selling when out of stock' on (CONTINUE) or off (DENY) for variants on the store-wide Preorders > Products tab, whatever offers they are in.
shopify_variant_ids are up to 100 Shopify variant gids, as the tab selects them a page at a time; ones STOQ has no row for come back under skipped_shopify_variant_ids. With CONTINUE, variants that have reached their quantity limit on any offer are left out (skipped_quantity_limit_shopify_variant_ids), as the tab's 'Skip products that have reached their quantity limit' (checked by default) does; skip_quantity_limited: false includes them. Fails with 422 quantity_limit_reached when every variant is left out. Before turning it off, GET /preorders/products/inventory_policy_conflicts names the other offers that need it on. Finishes before the response. For one offer's variants use /preorders/offers/:id/products/bulk_toggle_inventory_policy.
Also searched astoggle continue sellingturn on continue sellingturn off continue sellingset inventory policyallow oversellingstop overselling
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
policystringRequiredCONTINUE keeps selling the variants when out of stock; DENY stops.
One ofCONTINUEDENYshopify_variant_idsarray of stringsShopify variant gids, at most 100.
skip_quantity_limitedbooleanCONTINUE only: leave out variants at their quantity limit. Default true, as the tab checkbox.
Defaulttrue
Returns
policystringExample:CONTINUEshopify_variant_idsarray of stringsskipped_shopify_variant_idsarray of stringsskipped_quantity_limit_shopify_variant_idsarray of strings
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.
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/products/bulk_toggle_inventory_policy" \
-H "X-Auth-Token: $STOQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"policy": "CONTINUE",
"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/products/bulk_toggle_inventory_policy", {
method: "POST",
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"policy": "CONTINUE",
"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/products/bulk_toggle_inventory_policy",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
json={
"policy": "CONTINUE",
"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/products/bulk_toggle_inventory_policy")
req = Net::HTTP::Post.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"], "Content-Type" => "application/json")
req.body = {
policy: "CONTINUE",
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){
"policy": "CONTINUE",
"shopify_variant_ids": [
"gid://shopify/ProductVariant/47284734423096",
"gid://shopify/ProductVariant/47284734488632"
],
"skipped_shopify_variant_ids": [],
"skipped_quantity_limit_shopify_variant_ids": [
"gid://shopify/ProductVariant/47284734455864"
]
}{
"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
}
]
}