Bulk products toggle inventory policy offers

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

POST/preorders/offers/{id}/products/bulk_toggle_inventory_policy

Costs 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

idstringRequired

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
Example: CONTINUE
One of CONTINUEDENY
shopify_variant_idsarray of strings
skip_quantity_limitedinteger
Example: 5

Errors

401

Missing or invalid X-Auth-Token.

404

The resource does not exist for this shop, or the action path is not registered.

409

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

422

The request failed validation.

429

Rate limited: cost-weighted per token (read 1, write 2; 360 points / 60s). Check Retry-After.

Every error has the same shape: see Errors.

POST/preorders/offers/{id}/products/bulk_toggle_inventory_policy

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": [
      "45000000001"
    ],
    "skip_quantity_limited": 5
  }'

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": [
      "45000000001"
    ],
    "skip_quantity_limited": 5
  }),
});
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": [
            "45000000001"
        ],
        "skip_quantity_limited": 5
    },
)
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: [
    "45000000001"
  ],
  skip_quantity_limited: 5
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)

Response

No body

{
  "job_id": "job_a1b2c3",
  "status_url": "/api/v2/external/jobs/job_a1b2c3"
}

{
  "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
    }
  ]
}