Check the app embed status
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/account/setupCosts 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_embedobjectShow 3 child attributesHide child attributes
enabledboolean, nullableExample:falsestatusstringExample:disabledtheme_editor_urlstringExample:https://admin.shopify.com/store/stride-supply/themes/curr…
Errors
validation_failedThe 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.
curl "https://app.stoqapp.com/api/v2/external/account/setup" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/account/setup", {
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",
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")
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){
"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"
}
}{
"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
}
]
}