Skip to content

Get a sent notification

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

GET/back_in_stock/notifications/{id}

Costs 1 rate-limit point · Rate limits

Read one back-in-stock notification (a single send-log entry).

Find ids in GET /back_in_stock/notifications, or as each entry's id in GET /back_in_stock/signups/:id/history. status is sent or blocked. For a blocked send, blocked_reason is the stored text, and blocked_reason_code groups it into a stable code (for example plan_limit, email_bounced, customer_unsubscribed_email) with a readable blocked_reason_label; code and label are null on a sent row. channel, contact and signup_id come from the signup the send was for. An unknown id gives 404 not_found.

Also searched asshow notificationget notificationlook up sent restock alertnotification details

Path parameters

Returns

The notification object.

Errors

404
not_found

The path is valid but nothing with that id exists in this store.

422
validation_failed

The 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/notifications/{id}
curl "https://app.stoqapp.com/api/v2/external/back_in_stock/notifications/string" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "id": "string",
  "status": "string",
  "blocked_reason": null,
  "blocked_reason_code": null,
  "blocked_reason_label": null,
  "channel": "string",
  "contact": "string",
  "shopify_variant_id": "string",
  "shopify_product_id": "string",
  "product_title": null,
  "variant_title": null,
  "signup_id": "string",
  "attempted_at": "2026-01-15T09:30:00Z",
  "sent_at": "2026-01-15T09:30:00Z"
}