Skip to content

Get notification status

BetaAPI v2 is in public beta: endpoints, fields and behaviour can change before general availability. See the changelog

GET
/back_in_stock/signups/notification_status
curl --request GET \
--url 'https://app.stoqapp.com/api/v2/external/back_in_stock/signups/notification_status?shopify_variant_id=45000000001&count_by=customers' \
--header 'X-Auth-Token: <X-Auth-Token>'

Notification/waitlist status for one product variant: pending signups (count_by as on the dashboard), total alerts sent, the 5 most recent send batches (each with what triggered it), and the shop’s delivery settings – the usual reason a restock produced no send yet.

shopify_variant_id
required

Example

45000000001
count_by
Allowed values: customers signups

Example

customers

Success — the requested resource.

Media typeapplication/json
object

Example generated

{}

Missing or invalid X-Auth-Token.

Media typeapplication/json

Error envelope returned by every failed request.

object
errors
required
Array<string>

Example

{
"errors": [
"Unauthorized"
]
}

The request failed validation.

Media typeapplication/json

Error envelope returned by every failed request.

object
errors
required
Array<string>

Example

{
"errors": [
"name is required"
]
}

Rate limited — cost-weighted per token (read 1, write 2; 360 points / 60s). Check Retry-After.

Media typeapplication/json

Error envelope returned by every failed request.

object
errors
required
Array<string>

Example

{
"errors": [
"Rate limit exceeded"
]
}
Was this page helpful?

Still stuck? Ask Quinn or chat with support