Skip to content

Get the setup guide

API v2 is in public beta: endpoints and fields can change before general availability. See the changelog

GET/account/setup_guide

Costs 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

Returns

  • back_in_stockobject
    Show 7 child attributesHide child attributes
    • chosenboolean
      Example: true
    • completed_atnull
    • stepsarray of objects
      Show 2 child attributesHide child attributes
      • stepstring
        Example: string
      • doneboolean
        Example: true
    • steps_doneinteger
      Example: 1
    • next_stepstring
      Example: string
    • shown_on_homeboolean
      Example: true
    • first_signup_idstring, nullable
      Example: string
  • preordersobject
    Show 6 child attributesHide child attributes
    • chosenboolean
      Example: true
    • completed_atstring, nullable
      Example: string
    • stepsarray of objects
      Show 2 child attributesHide child attributes
      • stepstring
        Example: string
      • doneboolean
        Example: true
    • steps_doneinteger
      Example: 1
    • next_stepstring, nullable
      Example: string
    • shown_on_homeboolean
      Example: true

Errors

422
validation_failed

The request failed validation.

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.

GET/account/setup_guide
curl "https://app.stoqapp.com/api/v2/external/account/setup_guide" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "back_in_stock": {
    "chosen": true,
    "completed_at": null,
    "steps": [
      {
        "step": "string",
        "done": true
      }
    ],
    "steps_done": 1,
    "next_step": "string",
    "shown_on_home": true,
    "first_signup_id": "string"
  },
  "preorders": {
    "chosen": true,
    "completed_at": "string",
    "steps": [
      {
        "step": "string",
        "done": true
      }
    ],
    "steps_done": 1,
    "next_step": "string",
    "shown_on_home": true
  }
}