List sent notifications
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/back_in_stock/notificationsCosts 1 rate-limit point · Rate limits
List back-in-stock notifications (the send log) in this shop, paginated.
status=blocked surfaces sends that did not go out, with blocked_reason (the stored text), blocked_reason_code and blocked_reason_label. Every response has a summary (total, sent, blocked, blocked_by_reason) that counts every row matching the filters, not only this page. group_by=product returns counts per product (sent, blocked, and blocked by reason code) instead of rows, paginated by product. A bare from/to date is that whole day in the shop's time zone.
Also searched aslist notificationsback in stock send logrestock notifications sentwho got notifiednotification historyshow sent restock alerts
Query parameters
channelstringOnly notifications sent on this channel.
One ofemailsmsstatusstringOnly notifications that went out (sent) or that were held back (blocked).
One ofsentblockedgroup_bystringSet to product to get counts per product instead of individual notifications.
One ofproductshopify_variant_idstringOnly notifications for this Shopify variant, as a gid or a numeric id.
shopify_product_idstringOnly notifications for this Shopify product, as a gid or a numeric id.
fromstringOnly notifications created at or after this ISO 8601 date or date-time; a bare date starts at midnight in the shop's time zone.
tostringOnly notifications created at or before this ISO 8601 date or date-time; a bare date runs to the end of that day in the shop's time zone.
pageintegerPage of results to return, starting at 1.
Default1per_pageintegerResults per page, 1 to 200. Default 50.
Default50
Returns
notificationsarray of objectsShow 14 child attributesHide child attributes
idstringExample:stringstatusstringExample:stringblocked_reasonstring, nullableExample:stringblocked_reason_codestring, nullableExample:stringblocked_reason_labelstring, nullableExample:stringchannelstringExample:stringcontactstring, nullableExample:stringshopify_variant_idstringExample:stringshopify_product_idstringExample:stringproduct_titlestring, nullableExample:stringvariant_titlestring, nullableExample:stringsignup_idstringExample:stringattempted_atstringExample:2026-01-15T09:30:00Zsent_atstring, nullableExample:string
summaryobjectShow 4 child attributesHide child attributes
totalintegerExample:1sentintegerExample:1blockedintegerExample:1blocked_by_reasonarray of objectsShow 4 child attributesHide child attributes
blocked_reason_codestringExample:stringblocked_reason_labelstringExample:stringcountintegerExample:1example_reasonstringExample:string
metaobjectPagination for the list.
Show 4 child attributesHide child attributes
total_countintegerItems matching the filters, across all pages.
pageintegerPage returned, starting at 1.
per_pageintegerMost items per page.
total_pagesintegerPages available at this per_page; 0 when nothing matches.
productsarray of objectsShow 6 child attributesHide child attributes
shopify_product_idstringExample:stringproduct_titlestringExample:stringtotalintegerExample:1sentintegerExample:1blockedintegerExample:1blocked_by_reasonarray of objectsShow 3 child attributesHide child attributes
blocked_reason_codestringExample:stringblocked_reason_labelstringExample:stringcountintegerExample:1
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 action refused the request for a reason that is not a single bad field.
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/notifications" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/back_in_stock/notifications", {
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/notifications",
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/notifications")
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)curl "https://app.stoqapp.com/api/v2/external/back_in_stock/notifications?channel=email&status=sent&group_by=product" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/back_in_stock/notifications?channel=email&status=sent&group_by=product", {
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/notifications?channel=email&status=sent&group_by=product",
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/notifications?channel=email&status=sent&group_by=product")
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){
"notifications": [
{
"id": "string",
"status": "string",
"blocked_reason": "string",
"blocked_reason_code": "string",
"blocked_reason_label": "string",
"channel": "string",
"contact": "string",
"shopify_variant_id": "string",
"shopify_product_id": "string",
"product_title": "string",
"variant_title": "string",
"signup_id": "string",
"attempted_at": "2026-01-15T09:30:00Z",
"sent_at": "string"
}
],
"summary": {
"total": 1,
"sent": 1,
"blocked": 1,
"blocked_by_reason": [
{
"blocked_reason_code": "string",
"blocked_reason_label": "string",
"count": 1,
"example_reason": "string"
}
]
},
"meta": {
"total_count": 1,
"page": 1,
"per_page": 1,
"total_pages": 1
},
"products": [
{
"shopify_product_id": "string",
"product_title": "string",
"total": 1,
"sent": 1,
"blocked": 1,
"blocked_by_reason": [
{
"blocked_reason_code": "string",
"blocked_reason_label": "string",
"count": 1
}
]
}
]
}{
"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
}
]
}