Retrieve availability
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/preorders/product_variants/availabilityCosts 1 rate-limit point · Rate limits
Resolve which preorder offer applies to Shopify variants for a buyer country, with its stock condition and schedule. Beta.
country is the buyer's ISO 3166-1 alpha-2 country. status live means an offer applies and its limit is not reached, sold_out that its limit is reached; the caller still checks live inventory per stock_condition (in_stock: quantity above 0; out_of_stock: 0 or below with continue selling; any_stock_level: either). Unknown or deleted variants are not_enrolled; malformed ids are listed in errors. include[]=offer_details adds the offer's shipping_text, max_count, quantity_limit, preorder_count and quantity_limit_reached to preorder, as GET /preorders/products lists them; shipping_text is the text the buyer sees.
Also searched asvariant availabilityis variant on preorderpreorder availability by countryresolve preorder for country
Query parameters
countrystringRequiredshopify_variant_idsarrayincludestring
Errors
Missing or invalid X-Auth-Token.
The request failed validation.
Rate limited: cost-weighted per token (read 1, write 2; 360 points / 60s). Check Retry-After.
Every error has the same shape: see Errors.
curl "https://app.stoqapp.com/api/v2/external/preorders/product_variants/availability?country=US" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/preorders/product_variants/availability?country=US", {
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/product_variants/availability?country=US",
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/product_variants/availability?country=US")
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)curl "https://app.stoqapp.com/api/v2/external/preorders/product_variants/availability?country=US&shopify_variant_ids=45000000001" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/preorders/product_variants/availability?country=US&shopify_variant_ids=45000000001", {
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/product_variants/availability?country=US&shopify_variant_ids=45000000001",
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/product_variants/availability?country=US&shopify_variant_ids=45000000001")
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){
"errors": [
"Invalid API key"
],
"code": "auth_invalid",
"details": [
{
"code": "auth_invalid",
"message": "Invalid API key",
"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
}
]
}