Skip to content

Check the app embed status

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

GET/account/setup

Costs 1 rate-limit point · Rate limits

Whether STOQ's app embed is on in the published theme. status is enabled, disabled, or unknown when the theme could not be read. enabled is true or false, and null when status is unknown, because then whether the embed is on is not known. theme_editor_url, the theme editor link that turns the embed on, is there whenever enabled is not true. The embed adds the Preorder and Notify me buttons to the storefront.

Each call reads the published theme's settings from Shopify, so it reflects the embed as saved in the theme editor. Read only: the API can't turn the embed on. Send the merchant to theme_editor_url, which opens the editor with the embed switched on; it only takes effect once they press Save. Status is unknown when the shop hasn't granted theme access or the theme couldn't be read.

Also searched asis the app embed onapp embedapp embed statustheme app extensionbuttons not showing on storefront

Returns

  • app_embedobject
    Show 3 child attributesHide child attributes
    • enabledboolean, nullable
      Example: false
    • statusstring
      Example: disabled
    • theme_editor_urlstring
      Example: https://admin.shopify.com/store/stride-supply/themes/curr…

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
curl "https://app.stoqapp.com/api/v2/external/account/setup" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "app_embed": {
    "enabled": false,
    "status": "disabled",
    "theme_editor_url": "https://admin.shopify.com/store/stride-supply/themes/current/editor?context=apps&template=product&activateAppId=00000000-0000-4000-8000-000000000000/main"
  }
}