Get a notification
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/back_in_stock/notification_settings/{key}Costs 1 rate-limit point · Rate limits
Read whether one back-in-stock notification sends and, for the reminder, when. key is "signup_thank_you", "restock_alert" or "reminder".
GET /back_in_stock/notification_settings reads all three at once; PATCH this path to change one. For restock_alert, enabled is the shop's "Send automatic notification" switch: false means no automatic alerts go out when stock returns. after_n_days is returned for reminder only. A key the shop has no notification for gives 404 not_found; a key outside the three gives 422 invalid_params. The copy is GET /back_in_stock/templates/:key.
Also searched asis the reminder onis the restock alert onreminder timing
Path parameters
keystringRequiredWhich notification: signup_thank_you, restock_alert or reminder.
One ofsignup_thank_yourestock_alertreminder
Returns
The notification setting object.
Errors
not_foundThe path is valid but nothing with that id exists in this store.
invalid_paramsOne or more fields failed the action's schema.
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/notification_settings/{key}" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/back_in_stock/notification_settings/{key}", {
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/notification_settings/{key}",
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/notification_settings/{key}")
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){
"key": "string",
"enabled": true,
"after_n_days": 1
}{
"errors": [
"Invalid API key"
],
"code": "auth_invalid",
"details": [
{
"code": "auth_invalid",
"message": "Invalid API key",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"Offer not found"
],
"code": "not_found",
"details": [
{
"code": "not_found",
"message": "Offer not found",
"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
}
]
}