Skip to content

Bulk set inventory policy

API v2 is in public beta: endpoints and fields can change before general availability. See the changelog

POST/preorders/products/bulk_toggle_inventory_policy

Costs 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-Keystring

    A 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 (422 idempotency_key_reused); a retry while the first is still running gets 409 idempotency_key_in_progress. Keys are per store. Server errors and rate limits are not kept, so their retry runs.

Request body

  • policystringRequired

    CONTINUE keeps selling the variants when out of stock; DENY stops.

    One of CONTINUEDENY
  • shopify_variant_idsarray of strings

    Shopify variant gids, at most 100.

  • skip_quantity_limitedboolean

    CONTINUE only: leave out variants at their quantity limit. Default true, as the tab checkbox.

    Default true

Returns

  • policystring
    Example: CONTINUE
  • shopify_variant_idsarray of strings
  • skipped_shopify_variant_idsarray of strings
  • skipped_quantity_limit_shopify_variant_idsarray of strings

Errors

409
idempotency_key_in_progress

An earlier request with the same Idempotency-Key is still running. Wait, then resend the same request with the same key.

422
invalid_params

One or more fields failed the action's schema.

422
quantity_limit_reached

Every targeted variant has reached its preorder quantity limit, so STOQ keeps it from selling.

422
validation_failed

The 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.

POST/preorders/products/bulk_toggle_inventory_policy
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"
    ]
  }'
Response
{
  "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"
  ]
}