Get alert settings
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/back_in_stock/settings/alertsCosts 1 rate-limit point · Rate limits
Read back-in-stock merchant alert and scheduled report settings.
These emails go to the merchant, never to shoppers. scheduled_reports.email is the main merchant address: it gets the daily, weekly and monthly reports, the waitlist-threshold alert (one email per variant once its waitlist reaches signups_threshold.count) and the alerts-sent email. signup_alerts.email is used only for the every-signup alert. Change these with PATCH /back_in_stock/settings/alerts.
Also searched asget alert settingsshow alertsview signup thresholdview scheduled reportsalerts
Returns
signups_thresholdobjectShow 2 child attributesHide child attributes
countintegerExample:1notifybooleanExample:true
signup_alertsobjectShow 2 child attributesHide child attributes
enabledbooleanExample:trueemailnull
scheduled_reportsobjectShow 4 child attributesHide child attributes
dailybooleanExample:trueweeklybooleanExample:truemonthlybooleanExample:trueemailnull
notify_on_alert_sentbooleanExample:truemerchant_emailsobjectShow 2 child attributesHide child attributes
product_updatesbooleanExample:truetheme_publishedbooleanExample:true
Errors
not_foundThe path is valid but nothing with that id exists in this store.
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/back_in_stock/settings/alerts" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/back_in_stock/settings/alerts", {
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/back_in_stock/settings/alerts",
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/back_in_stock/settings/alerts")
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){
"signups_threshold": {
"count": 1,
"notify": true
},
"signup_alerts": {
"enabled": true,
"email": null
},
"scheduled_reports": {
"daily": true,
"weekly": true,
"monthly": true,
"email": null
},
"notify_on_alert_sent": true,
"merchant_emails": {
"product_updates": true,
"theme_published": true
}
}{
"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
}
]
}