List sending history

GET

/back_in_stock/sending_history

curl --request GET \
  --url 'https://app.stoqapp.com/api/v2/external/back_in_stock/sending_history?status=incomplete&source=string&shopify_variant_id=45000000001&shopify_product_id=78000000001&page=string&per_page=string' \
  --header 'X-Auth-Token: <X-Auth-Token>'

• Production

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

Note: 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.

Authorizations

• ApiKeyAuth

Parameters

Query Parameters

status

Allowed values: incomplete active waiting completed

Example

incomplete

source

Example

string

shopify_variant_id

Example

45000000001

shopify_product_id

Example

78000000001

page

Example

string

per_page

Example

string

Responses

200

Success — the requested resource.

Media typeapplication/json

object

Example ^generated

{}

401

Missing or invalid X-Auth-Token.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

{
  "errors": [
    "Unauthorized"
  ]
}

422

The request failed validation.

Media typeapplication/json

Error envelope returned by every failed request.

object

errors

required

Array<string>

Example

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

429

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"
  ]
}