Skip to content

List notification sends

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

GET/back_in_stock/sending_history

Costs 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

  • statusstring

    Only sends in this state; incomplete means active or waiting.

    One of incompleteactivewaitingcompleted
  • sourcestring

    Only sends whose source contains this text, e.g. webhook or bulk_send.

  • shopify_variant_idstring

    Only sends for this Shopify variant, as a gid.

  • shopify_product_idstring

    Only sends for this Shopify product, as a gid.

  • pageinteger

    Page of results to return, starting at 1.

    Default 1
  • per_pageinteger

    Results per page, 1 to 100. Default 25.

    Default 25

Returns

  • sendsarray of objects
    Show 13 child attributesHide child attributes
    • idstring
      Example: c3e8a1f4-7b2d-4e9a-8c51-0f6d2b9e7a13
    • shopify_product_idstring
      Example: gid://shopify/Product/8784906035384
    • shopify_variant_idstring
      Example: gid://shopify/ProductVariant/47284734423096
    • product_titlestring
      Example: Trail Shoe
    • variant_titlestring
      Example: Blue / Medium
    • shopify_location_idstring
    • sourcestring, nullable
      Example: webhook
    • channelnull
      Example: email
    • statusstring
      Example: waiting
    • limitnull
      Example: 42
    • signups_countinteger
      Example: 42
    • sent_countinteger
      Example: 20
    • created_atstring
      Example: 2026-06-25T14:02:11Z
  • 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.

Errors

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