Skip to content

Update inventory settings

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

PATCH/preorders/offers/{id}/inventory

Costs 2 rate-limit points · Rate limits

Update any subset of the inventory settings on a preorder offer.

Deep partial: absent fields are unchanged. Continue selling for newly attached variants is products.eligible_inventory_policy, part of the products section.

Also searched asedit inventorychange inventory settingsmodify inventoryenable continue selling for the whole offerallow oversellingenable oversellauto continue sellingauto-apply continue selling on attachdisable continue sellingstop auto continue sellingdisable oversellprevent overselling on attachenable auto apply continue sellingauto continue selling on attachauto-flip new variants to continueapply oversell to new variantsdisable auto apply continue sellingstop auto continue selling on attachdon't auto-flip new variantsno oversell on new variantsset inventory providerswitch inventory provideruse shopify inventoryuse stoq inventoryset reservation timingchange inventory reservationset when inventory is heldreserve on salereserve on fulfillmentalways show preorderpreorder regardless of stock

Path parameters

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

  • stock_conditionstring

    When the Preorder button shows: out_of_stock when the product is out of stock (needs Shopify's 'Continue selling when out of stock' on the variants); in_stock only while the product is in stock (at 0 it stops showing); any_stock_level whenever the variant can be bought, in or out of stock, never changing the inventory policy: "even when in stock" or "in stock too" is any_stock_level. in_stock and any_stock_level need specific products.

    One of out_of_stockin_stockany_stock_level
  • reservestring

    When to deduct from inventory: on_sale is at checkout, on_fulfillment is at fulfillment. in_stock and any_stock_level always deduct on_sale.

    One of on_saleon_fulfillment

Returns

  • stock_conditionstring

    When the Preorder button shows: out_of_stock when the variant is out of stock with Continue selling on, in_stock only while it is in stock, any_stock_level whenever the variant can be bought.

    One of out_of_stockin_stockany_stock_level
  • reservestring

    When inventory is deducted: on_sale at checkout, on_fulfillment at fulfillment.

    One of on_saleon_fulfillment
  • also_changedarray of objects

    Settings this write changed on its own because they depend on what you changed (turning one option off can reset another). Absent when nothing else changed.

    Show 5 child attributesHide child attributes
    • field_pathstring

      Dotted path of the changed field in this response, when it is one.

    • settingstring

      The setting that changed, as the dashboard names it.

    • fromstring

      Its value before the write.

    • tostring

      Its value after the write.

    • reasonstring

      Why it changed.

Errors

404
not_found

The path is valid but nothing with that id exists in this store.

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.

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.

PATCH/preorders/offers/{id}/inventory
curl -X PATCH "https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/inventory" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "reserve": "on_fulfillment"
  }'
Response
{
  "stock_condition": "out_of_stock",
  "reserve": "on_fulfillment"
}