Bulk Toggle Inventory Policy

POST

/preorders/products/bulk_toggle_inventory_policy

curl --request POST \
  --url https://app.stoqapp.com/api/v2/external/preorders/products/bulk_toggle_inventory_policy \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <X-Auth-Token>' \
  --data '{ "policy": "CONTINUE", "shopify_variant_ids": [ "45000000001" ], "skip_quantity_limited": 5 }'

• Production

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.

Note: 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.

Authorizations

• ApiKeyAuth

Request Body^required

Media typeapplication/json

object

policy

required

Allowed values: CONTINUE DENY

shopify_variant_ids

skip_quantity_limited

Example

{
  "policy": "CONTINUE",
  "shopify_variant_ids": [
    "45000000001"
  ],
  "skip_quantity_limited": 5
}

Responses

200

Success — the updated resource.

Media typeapplication/json

object

Example ^generated

{}

202

Accepted — async/bulk work was queued. Poll the returned job.

Media typeapplication/json

Returned for async/bulk work — poll the job until it reaches a terminal state.

object

job_id

string

status_url

string

Example

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

401

Missing or invalid X-Auth-Token.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "Unauthorized"
  ]
}

422

The request failed validation.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "name is required"
  ]
}

429

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

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "Rate limit exceeded"
  ]
}