Retrieve the setup guide
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/account/setup_guideCosts 1 rate-limit point · Rate limits
The setup guide on the dashboard's Home page, for back_in_stock and preorders: whether the merchant chose that product on the welcome page (chosen), each step in order with done, steps_done, next_step (null once the guide is complete) and completed_at (set when every step is done or the guide was skipped). Back in stock: app_embed, design_widget, first_signup, first_alert_sent, with first_signup_id while the guide is open. Preorders: app_embed, first_offer, first_product, first_order.
Same steps and rules as the Home page guide. Reading it marks a guide complete once all its steps are done, as the dashboard does. The app embed itself (status and the theme editor link) is GET /account/setup. Home shows a guide only when chosen and not completed more than a day ago (shown_on_home); a completed guide leaves Home by itself, so it needs no skip. Dismiss on Home is remembered by that browser only, so it is not here. If the merchant still sees a guide that shown_on_home says is hidden, ask what the card says and where it shows; never guess a cause such as a cache, and never name a card title or button this read does not give.
Also searched assetup guideonboardingonboarding stepsgetting startedsetup progresswhat is left to set upis stoq set up
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/account/setup_guide" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/account/setup_guide", {
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/account/setup_guide",
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/account/setup_guide")
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
}
]
}