Send test for a template

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

POST/back_in_stock/templates/{key}/send_test

Costs 2 rate-limit points · Rate limits

Send a back-in-stock notification template to one email address as a test, rendered against a sample alert in the body locale (omit it for the shop default language). Matches the template page's Send test email button.

email defaults to the shop's reply-to address; one address only. shopify_variant_id and shopify_product_id (both gids, send both or neither) pick the product shown. Fails (422) when email sending is turned off for the shop.

Also searched assend test emailsend a test back in stock emailpreview the restock email in my inboxtest the signup thank you email

Path parameters

keystringRequired

Headers

Idempotency-Keystring
A fresh unique key for every write (a new UUID, say); reuse it only to retry that write. Keys are remembered for 1 hour: the same key and the same request within that hour returns the first result, with Idempotent-Replayed: true, without running again; the same key with a different method, path or body is refused (422 idempotency_key_reused); a retry while the first is still running gets 409 idempotency_key_in_progress. Keys are per store. Server errors and rate limits are not kept, so their retry runs.

Request body

localestring
Example: fr
emailstring, nullable
Example: shopper@example.com
shopify_variant_idstring, nullable
Example: 45000000001
shopify_product_idstring, nullable
Example: 78000000001

Errors

401

Missing or invalid X-Auth-Token.

404

The resource does not exist for this shop, or the action path is not registered.

409

An earlier request with the same Idempotency-Key is still running. Wait, then resend the same request with the same key.

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.

POST/back_in_stock/templates/{key}/send_test

curl -X POST "https://app.stoqapp.com/api/v2/external/back_in_stock/templates/{key}/send_test" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "locale": "fr",
    "email": "shopper@example.com",
    "shopify_variant_id": "45000000001",
    "shopify_product_id": "78000000001"
  }'

const res = await fetch("https://app.stoqapp.com/api/v2/external/back_in_stock/templates/{key}/send_test", {
  method: "POST",
  headers: {
    "X-Auth-Token": process.env.STOQ_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "locale": "fr",
    "email": "shopper@example.com",
    "shopify_variant_id": "45000000001",
    "shopify_product_id": "78000000001"
  }),
});
const data = await res.json();

import os
import requests

res = requests.post(
    "https://app.stoqapp.com/api/v2/external/back_in_stock/templates/{key}/send_test",
    headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
    json={
        "locale": "fr",
        "email": "shopper@example.com",
        "shopify_variant_id": "45000000001",
        "shopify_product_id": "78000000001"
    },
)
data = res.json()

require "net/http"
require "json"

uri = URI("https://app.stoqapp.com/api/v2/external/back_in_stock/templates/{key}/send_test")
req = Net::HTTP::Post.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"], "Content-Type" => "application/json")
req.body = {
  locale: "fr",
  email: "shopper@example.com",
  shopify_variant_id: "45000000001",
  shopify_product_id: "78000000001"
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)

Response

No body

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

{
  "errors": [
    "Invalid API key"
  ],
  "code": "auth_invalid",
  "details": [
    {
      "code": "auth_invalid",
      "message": "Invalid API key",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}

{
  "errors": [
    "Offer not found"
  ],
  "code": "not_found",
  "details": [
    {
      "code": "not_found",
      "message": "Offer not found",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}

{
  "errors": [
    "A request with this Idempotency-Key is still running"
  ],
  "code": "idempotency_key_in_progress",
  "details": [
    {
      "code": "idempotency_key_in_progress",
      "message": "A request with this Idempotency-Key is still running",
      "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
    }
  ]
}