Notify Variants

POST

/back_in_stock/signups/notify_variants

curl --request POST \
  --url https://app.stoqapp.com/api/v2/external/back_in_stock/signups/notify_variants \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <X-Auth-Token>' \
  --data '{ "shopify_variant_ids": [ "45000000001" ] }'

• Production

Send back-in-stock notifications to everyone waiting on up to 10 variants, as the products table’s Send notifications bulk action does.

Note: Sends to pending signups only, on every channel, regardless of stock. A variant whose channel cannot send (plan limit, channel off, awaiting review, or a provider that cannot deliver) is skipped and its reason listed in errors; the others still send. 202 with one send per variant queued (its id is the job id for GET /back_in_stock/sending_history/:id) and providers per channel. 422 when nothing was queued.

Authorizations

• ApiKeyAuth

Request Body^required

Media typeapplication/json

object

shopify_variant_ids

required

Array<string>

Example

{
  "shopify_variant_ids": [
    "45000000001"
  ]
}

Responses

200

Success — the updated resource.

Media typeapplication/json

object

Example ^generated

{}

202

Accepted — async/bulk work was queued. Poll the returned job.

Media typeapplication/json

Returned for async/bulk work — poll the job until it reaches a terminal state.

object

job_id

string

status_url

string

Example

{
  "job_id": "job_a1b2c3",
  "status_url": "/api/v2/external/jobs/job_a1b2c3"
}

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