Get channel settings
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/back_in_stock/settings/channelsCosts 1 rate-limit point · Rate limits
Read back-in-stock notification channel settings.
Each switch decides both whether shoppers can sign up on that channel and whether alerts go out on it. Whether automatic restock alerts send at all is a separate switch: enabled on GET /back_in_stock/notification_settings/restock_alert. The email sender and SMS number are under GET /account/sending. Change these with PATCH /back_in_stock/settings/channels.
Also searched asget channelsshow channelsview notification channelswhich channels are enabledchannels
Returns
emailobjectShow 1 child attributeHide child attributes
enabledbooleanExample:true
smsobjectShow 1 child attributeHide child attributes
enabledbooleanExample: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/channels" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/back_in_stock/settings/channels", {
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/channels",
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/channels")
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){
"email": {
"enabled": true
},
"sms": {
"enabled": 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
}
]
}