Retrieve the sending history

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
One of incompleteactivewaitingcompleted
sourcestring
shopify_variant_idstring
shopify_product_idstring
pagestring
per_pagestring

Errors

401

Missing or invalid X-Auth-Token.

422

The request failed validation.

429

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

Every error has the same shape: see Errors.

Example

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"

const res = await fetch("https://app.stoqapp.com/api/v2/external/back_in_stock/sending_history", {
  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",
    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")
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)

GET/back_in_stock/sending_history

curl "https://app.stoqapp.com/api/v2/external/back_in_stock/sending_history?status=incomplete&shopify_variant_id=45000000001&shopify_product_id=78000000001" \
  -H "X-Auth-Token: $STOQ_API_KEY"

const res = await fetch("https://app.stoqapp.com/api/v2/external/back_in_stock/sending_history?status=incomplete&shopify_variant_id=45000000001&shopify_product_id=78000000001", {
  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?status=incomplete&shopify_variant_id=45000000001&shopify_product_id=78000000001",
    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?status=incomplete&shopify_variant_id=45000000001&shopify_product_id=78000000001")
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

No body

{
  "errors": [
    "Invalid API key"
  ],
  "code": "auth_invalid",
  "details": [
    {
      "code": "auth_invalid",
      "message": "Invalid API key",
      "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
    }
  ]
}