Get setup
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/account/setup';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/account/setup \ --header 'X-Auth-Token: <X-Auth-Token>'The shop’s setup state: whether STOQ’s app embed is on in the published theme (with the theme editor link that turns it on when it is off), and the getting-started steps for back in stock and preorders: each step’s state, how many are done, the next one, and whether setup is complete.
Authorizations
Section titled “Authorizations”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