Get setup guide

GET

/account/setup_guide

curl --request GET \
  --url https://app.stoqapp.com/api/v2/external/account/setup_guide \
  --header 'X-Auth-Token: <X-Auth-Token>'

• Production

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.

Note: 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; Dismiss on Home is remembered by that browser only, so it is not here.

Authorizations

• ApiKeyAuth

Responses

200

Success — the requested resource.

Media typeapplication/json

object

Example ^generated

{}

401

Missing or invalid X-Auth-Token.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "Unauthorized"
  ]
}

422

The request failed validation.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "name is required"
  ]
}

429

Rate limited — cost-weighted per token (read 1, write 2; 360 points / 60s). Check Retry-After.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "Rate limit exceeded"
  ]
}