Check variant 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
countrystringRequiredBuyer's country as an ISO 3166-1 alpha-2 code, such as US.
shopify_variant_idsstringComma-separated variants to check, up to 100, as numeric IDs or gid://shopify/ProductVariant/<id>; an array also works.
includestringExtra detail to add; offer_details adds the offer's shipping text and quantity limits. Comma-separated or an array.
Returns
countrystringExample:USproduct_variantsarray of objectsShow 4 child attributesHide child attributes
shopify_variant_idstringExample:gid://shopify/ProductVariant/47284734423096statusstringExample:livestock_conditionstring, nullableExample:out_of_stockpreorderobject, nullableShow 7 child attributesHide child attributes
idstringExample:73a74948-2b57-4cc3-971f-2b441828c977scheduleobjectShow 2 child attributesHide child attributes
start_datestring, nullableend_datestring, nullable
shipping_textstring, nullablemax_countinteger, nullablequantity_limitinteger, nullablepreorder_countintegerquantity_limit_reachedboolean
errorsarray of objectsShow 2 child attributesHide child attributes
shopify_variant_idstringerrorstring
Errors
invalid_paramsOne or more fields failed the action's schema.
validation_failedThe action refused the request for a reason that is not a single bad field.
upstream_unavailableA service the answer depends on did not respond in time.
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/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){
"country": "US",
"product_variants": [
{
"shopify_variant_id": "gid://shopify/ProductVariant/47284734423096",
"status": "live",
"stock_condition": "out_of_stock",
"preorder": {
"id": "73a74948-2b57-4cc3-971f-2b441828c977",
"schedule": {
"start_date": null,
"end_date": null
}
}
},
{
"shopify_variant_id": "gid://shopify/ProductVariant/47284734521400",
"status": "not_enrolled",
"stock_condition": null,
"preorder": null
}
],
"errors": []
}{
"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
}
]
}