Get inventory settings
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/preorders/offers/{id}/inventoryCosts 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
idstringRequiredThe offer's ID, from
GET /preorders/offers.
Returns
stock_conditionstringWhen 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 ofout_of_stockin_stockany_stock_levelreservestringWhen inventory is deducted: on_sale at checkout, on_fulfillment at fulfillment.
One ofon_saleon_fulfillment
Errors
not_foundThe path is valid but nothing with that id exists in this store.
invalid_paramsOne or more fields failed the action's schema.
validation_failedThe 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.
curl "https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/inventory" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/inventory", {
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
},
});
const data = await res.json();import os
import requests
res = requests.get(
"https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/inventory",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/inventory")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"stock_condition": "out_of_stock",
"reserve": "on_sale"
}{
"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": [
"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
}
]
}