Get availability
BetaAPI v2 is in public beta: endpoints, fields and behaviour can change before general availability. See the changelog
const url = 'https://app.stoqapp.com/api/v2/external/preorders/product_variants/availability?country=US&variant_ids=45000000001';const options = {method: 'GET', headers: {'X-Auth-Token': '<X-Auth-Token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://app.stoqapp.com/api/v2/external/preorders/product_variants/availability?country=US&variant_ids=45000000001' \ --header 'X-Auth-Token: <X-Auth-Token>'Resolve whether Shopify variants are on preorder for a buyer country: the preorder that applies, remaining allowance and customer-facing shipping text. Beta.
Note: country is the buyer’s ISO 3166-1 alpha-2 country. enabled is true when a preorder applies and has allowance; the caller still checks live inventory per preorder_type. Unknown or deleted variants are not_enrolled; malformed ids are listed in errors.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Example
USExample
[ "45000000001"]Responses
Section titled “Responses”Success — the requested resource.
object
Example generated
{}Missing or invalid X-Auth-Token.
Error envelope returned by every failed request.
object
Example
{ "errors": [ "Unauthorized" ]}The request failed validation.
Error envelope returned by every failed request.
object
Example
{ "errors": [ "name is required" ]}Rate limited — cost-weighted per token (read 1, write 2; 360 points / 60s). Check Retry-After.
Error envelope returned by every failed request.
object
Example
{ "errors": [ "Rate limit exceeded" ]}Thanks for letting us know.
Still stuck? Ask Quinn or chat with support