Skip to content

Get alert settings

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

GET/back_in_stock/settings/alerts

Costs 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_thresholdobject
    Show 2 child attributesHide child attributes
    • countinteger
      Example: 1
    • notifyboolean
      Example: true
  • signup_alertsobject
    Show 2 child attributesHide child attributes
    • enabledboolean
      Example: true
    • emailnull
  • scheduled_reportsobject
    Show 4 child attributesHide child attributes
    • dailyboolean
      Example: true
    • weeklyboolean
      Example: true
    • monthlyboolean
      Example: true
    • emailnull
  • notify_on_alert_sentboolean
    Example: true
  • merchant_emailsobject
    Show 2 child attributesHide child attributes
    • product_updatesboolean
      Example: true
    • theme_publishedboolean
      Example: true

Errors

404
not_found

The path is valid but nothing with that id exists in this store.

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/back_in_stock/settings/alerts
curl "https://app.stoqapp.com/api/v2/external/back_in_stock/settings/alerts" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "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
  }
}