Get a send's progress
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
GET
/back_in_stock/sending_history/{id}Costs 1 rate-limit point · Rate limits
Read one back-in-stock send's progress by the id a notify endpoint returned.
404 once a completed send that reached no signups has been cleaned up.
Also searched assend statussend progresscheck send jobis the bulk send done
Path parameters
idstringRequiredThe send's ID, from
GET /back_in_stock/sending_historyor a notify call.
Returns
Errors
404
not_foundThe path is valid but nothing with that id exists in this store.
422
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.
GET/back_in_stock/sending_history/{id}
curl "https://app.stoqapp.com/api/v2/external/back_in_stock/sending_history/string" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/back_in_stock/sending_history/string", {
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/string",
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/string")
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)Response
{
"id": "string",
"shopify_product_id": "string",
"shopify_variant_id": "string",
"product_title": "string",
"variant_title": "string",
"shopify_location_id": "string",
"source": "string",
"channel": null,
"status": "string",
"limit": null,
"signups_count": 1,
"sent_count": 1,
"created_at": "2026-01-15T09:30:00Z"
}{
"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
}
]
}