List notification sends
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/back_in_stock/sending_historyCosts 1 rate-limit point · Rate limits
List back-in-stock sends, newest first: each restock or manual send working through a variant's waitlist, with its progress (the dashboard's Bulk requests page).
source is webhook (automatic restock alert), bulk_send (sent from the dashboard or API), bulk_resend, flow_action, events_inventory, events_products or reconciliation. status is active, waiting (between batches) or completed. sent_count of signups_count is the progress. source narrows to sends whose source contains it, as the page's source search. shopify_variant_id / shopify_product_id (gids) narrow to that variant's or product's sends; status=incomplete (active or waiting) with one of them answers whether a send is still running, as the waitlist page's banner shows.
Also searched assending historybulk requestsbulk sendssend jobsrestock sendsis the send finishednotification send progress
Query parameters
statusstringOnly sends in this state; incomplete means active or waiting.
One ofincompleteactivewaitingcompletedsourcestringOnly sends whose source contains this text, e.g. webhook or bulk_send.
shopify_variant_idstringOnly sends for this Shopify variant, as a gid.
shopify_product_idstringOnly sends for this Shopify product, as a gid.
pageintegerPage of results to return, starting at 1.
Default1per_pageintegerResults per page, 1 to 100. Default 25.
Default25
Returns
sendsarray of objectsShow 13 child attributesHide child attributes
idstringExample:c3e8a1f4-7b2d-4e9a-8c51-0f6d2b9e7a13shopify_product_idstringExample:gid://shopify/Product/8784906035384shopify_variant_idstringExample:gid://shopify/ProductVariant/47284734423096product_titlestringExample:Trail Shoevariant_titlestringExample:Blue / Mediumshopify_location_idstringsourcestring, nullableExample:webhookchannelnullExample:emailstatusstringExample:waitinglimitnullExample:42signups_countintegerExample:42sent_countintegerExample:20created_atstringExample:2026-06-25T14:02:11Z
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.
Errors
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/sending_history" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/back_in_stock/sending_history", {
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/sending_history",
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/sending_history")
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/sending_history?status=incomplete&shopify_variant_id=45000000001&shopify_product_id=78000000001" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/back_in_stock/sending_history?status=incomplete&shopify_variant_id=45000000001&shopify_product_id=78000000001", {
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/sending_history?status=incomplete&shopify_variant_id=45000000001&shopify_product_id=78000000001",
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/sending_history?status=incomplete&shopify_variant_id=45000000001&shopify_product_id=78000000001")
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){
"sends": [
{
"id": "c3e8a1f4-7b2d-4e9a-8c51-0f6d2b9e7a13",
"shopify_product_id": "gid://shopify/Product/8784906035384",
"shopify_variant_id": "gid://shopify/ProductVariant/47284734423096",
"product_title": "Trail Shoe",
"variant_title": "Blue / Medium",
"shopify_location_id": null,
"source": "webhook",
"channel": "email",
"status": "waiting",
"limit": 42,
"signups_count": 42,
"sent_count": 20,
"created_at": "2026-06-25T14:02:11Z"
},
{
"id": "7d2f9b4e-1a6c-4e83-b5d0-2c8a6f1e9b37",
"shopify_product_id": "gid://shopify/Product/8784906035384",
"shopify_variant_id": "gid://shopify/ProductVariant/47284734423096",
"product_title": "Trail Shoe",
"variant_title": "Blue / Medium",
"shopify_location_id": null,
"source": "bulk_send",
"channel": "sms",
"status": "completed",
"limit": 20,
"signups_count": 20,
"sent_count": 20,
"created_at": "2026-06-18T10:15:40Z"
}
],
"meta": {
"total_count": 2,
"page": 1,
"per_page": 25,
"total_pages": 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
}
]
}