Update inventory

PATCH

/preorders/offers/{id}/inventory

curl --request PATCH \
  --url https://app.stoqapp.com/api/v2/external/preorders/offers/example/inventory \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <X-Auth-Token>' \
  --data '{ "continue_selling": { "enabled": true, "auto_apply_to_new_variants": true } }'

• Production

Update inventory settings on a preorder offer.

Note: Deep partial. provider ‘stoq’ = the offer shows the Preorder button only when the product is OUT OF STOCK (the ‘Show Preorder when product is out of stock’ mode; needs Shopify’s ‘Continue selling when out of stock’ on the variants). provider ‘shopify’ = the button shows for IN-STOCK products (the ‘Show Preorder for in-stock products’ mode). Setting provider to ‘shopify’ will force product_variants_source to ‘custom’ via the model callback. Continue-selling is toggled via this PATCH: continue_selling.enabled and continue_selling.auto_apply_to_new_variants BOTH map to the single underlying inventory_policy_auto_enable flag — the auto-flip-on-attach intent (newly-attached variants get their Shopify inventory_policy flipped to CONTINUE). When both fields are present, auto_apply_to_new_variants wins. Neither field flips EXISTING variants — to flip variants that are already attached, use POST …/products/bulk_toggle_inventory_policy, or pass the update_inventory_policy flag to the offer lifecycle enable/disable actions.

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

id

required

string

Request Body^required

Media typeapplication/json

object

provider

Allowed values: stoq shopify

reservation

object

timing

Allowed values: on_sale on_fulfillment

continue_selling

object

enabled

boolean

auto_apply_to_new_variants

boolean

Example

{
  "continue_selling": {
    "enabled": true,
    "auto_apply_to_new_variants": true
  }
}

Responses

200

Success — example response shown.

Media typeapplication/json

object

Example

{
  "provider": "stoq",
  "reservation": {
    "timing": "on_sale"
  },
  "continue_selling": {
    "enabled": true,
    "auto_apply_to_new_variants": true
  }
}

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

404

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

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "Offer not found"
  ]
}

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