Skip to content

List sent notifications

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

GET/back_in_stock/notifications

Costs 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

  • channelstring

    Only notifications sent on this channel.

    One of emailsms
  • statusstring

    Only notifications that went out (sent) or that were held back (blocked).

    One of sentblocked
  • group_bystring

    Set to product to get counts per product instead of individual notifications.

    One of product
  • shopify_variant_idstring

    Only notifications for this Shopify variant, as a gid or a numeric id.

  • shopify_product_idstring

    Only notifications for this Shopify product, as a gid or a numeric id.

  • fromstring

    Only notifications created at or after this ISO 8601 date or date-time; a bare date starts at midnight in the shop's time zone.

  • tostring

    Only 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.

  • pageinteger

    Page of results to return, starting at 1.

    Default 1
  • per_pageinteger

    Results per page, 1 to 200. Default 50.

    Default 50

Returns

  • notificationsarray of objects
    Show 14 child attributesHide child attributes
    • idstring
      Example: string
    • statusstring
      Example: string
    • blocked_reasonstring, nullable
      Example: string
    • blocked_reason_codestring, nullable
      Example: string
    • blocked_reason_labelstring, nullable
      Example: string
    • channelstring
      Example: string
    • contactstring, nullable
      Example: string
    • shopify_variant_idstring
      Example: string
    • shopify_product_idstring
      Example: string
    • product_titlestring, nullable
      Example: string
    • variant_titlestring, nullable
      Example: string
    • signup_idstring
      Example: string
    • attempted_atstring
      Example: 2026-01-15T09:30:00Z
    • sent_atstring, nullable
      Example: string
  • summaryobject
    Show 4 child attributesHide child attributes
    • totalinteger
      Example: 1
    • sentinteger
      Example: 1
    • blockedinteger
      Example: 1
    • blocked_by_reasonarray of objects
      Show 4 child attributesHide child attributes
      • blocked_reason_codestring
        Example: string
      • blocked_reason_labelstring
        Example: string
      • countinteger
        Example: 1
      • example_reasonstring
        Example: string
  • metaobject

    Pagination for the list.

    Show 4 child attributesHide child attributes
    • total_countinteger

      Items matching the filters, across all pages.

    • pageinteger

      Page returned, starting at 1.

    • per_pageinteger

      Most items per page.

    • total_pagesinteger

      Pages available at this per_page; 0 when nothing matches.

  • productsarray of objects
    Show 6 child attributesHide child attributes
    • shopify_product_idstring
      Example: string
    • product_titlestring
      Example: string
    • totalinteger
      Example: 1
    • sentinteger
      Example: 1
    • blockedinteger
      Example: 1
    • blocked_by_reasonarray of objects
      Show 3 child attributesHide child attributes
      • blocked_reason_codestring
        Example: string
      • blocked_reason_labelstring
        Example: string
      • countinteger
        Example: 1

Errors

404
not_found

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

422
invalid_params

One or more fields failed the action's schema.

422
validation_failed

The 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.

GET/back_in_stock/notifications
curl "https://app.stoqapp.com/api/v2/external/back_in_stock/notifications" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "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
        }
      ]
    }
  ]
}