Skip to content

Get inventory settings

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

GET/preorders/offers/{id}/inventory

Costs 1 rate-limit point · Rate limits

Read the inventory configuration for a preorder offer.

stock_condition decides when the Preorder button shows: out_of_stock (the default) once the variant is out of stock with Shopify's Continue selling on, in_stock only while it has stock, any_stock_level whenever it can be bought. in_stock and any_stock_level need products.selection custom; switching selection to a collection, tags or all products sets it back to out_of_stock. reserve only applies to out_of_stock; the other two always deduct stock at sale. Edit with PATCH /preorders/offers/:id/inventory.

Also searched asget inventory settingsshow inventoryview inventory policyview reservation timingview stock handling

Path parameters

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

Errors

404
not_found

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

422
invalid_params

One or more fields failed the action's schema.

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.

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