Bulk set offer policy
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/preorders/offers/{id}/products/bulk_toggle_inventory_policyCosts 2 rate-limit points · Rate limits
Flip the Shopify inventory policy on variants attached to a preorder offer (CONTINUE or DENY). Pass the explicit shopify_variant_ids for a partial change; omitting shopify_variant_ids applies the policy to EVERY attached variant, so only omit it when the merchant asked for all of them.
Returns 202 with a job; Shopify is updated in batches, so poll job.status_url until it is completed. shopify_variant_ids are Shopify variant gids; ones not on this offer are skipped and returned in skipped_shopify_variant_ids, and the call fails with 422 if none are. With CONTINUE, variants at their quantity limit are left out, as the dashboard's 'Skip variants that have reached their quantity limit' (checked by default) does; skip_quantity_limited: false includes them.
Also searched asflip inventory policytoggle continue selling on variantsset inventory policy for variantsenable oversell on these variantsdisable oversell on these variants
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
policystringRequiredCONTINUE keeps selling the variants when out of stock; DENY stops.
One ofCONTINUEDENYshopify_variant_idsarray of stringsWhich attached variants to flip: Shopify variant gids. Variants not attached to this offer are skipped. Omitting this applies the policy to EVERY attached variant, so only omit it when the merchant asked for all of them.
skip_quantity_limitedbooleanCONTINUE only: leave out variants that have reached their quantity limit. Default true, as the dashboard checkbox.
Defaulttrue
Returns
policystringInventory policy being set: CONTINUE keeps selling when out of stock; DENY stops.
One ofCONTINUEDENYvariant_countintegerVariants whose inventory policy is being changed.
skipped_shopify_variant_idsarray of stringsVariants asked for that are not on the offer, as sent. They are left alone.
jobobjectBackground job updating Shopify; poll status_url until it is completed.
Show 3 child attributesHide child attributes
job_idstringJob ID.
statusstringJob status when the response was sent, queued.
status_urlstringPath to poll for the job's progress.
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 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/offers/73a74948-2b57-4cc3-971f-2b441828c977/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/44712349876501",
"gid://shopify/ProductVariant/44712349909269"
]
}'const res = await fetch("https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/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/44712349876501",
"gid://shopify/ProductVariant/44712349909269"
]
}),
});
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/bulk_toggle_inventory_policy",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
json={
"policy": "CONTINUE",
"shopify_variant_ids": [
"gid://shopify/ProductVariant/44712349876501",
"gid://shopify/ProductVariant/44712349909269"
]
},
)
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/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/44712349876501",
"gid://shopify/ProductVariant/44712349909269"
]
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"policy": "CONTINUE",
"variant_count": 1,
"skipped_shopify_variant_ids": [
"gid://shopify/ProductVariant/44712349909269"
],
"job": {
"job_id": "7f3e9a12-4c6b-4d81-b2e0-5a9c1d8e6f34",
"status": "queued",
"status_url": "/api/v2/external/preorders/product_variants/jobs/7f3e9a12-4c6b-4d81-b2e0-5a9c1d8e6f34"
}
}{
"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
}
]
}