Send a test notification
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/back_in_stock/templates/{key}/send_testCosts 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 (reply_to_address on GET /account/sending); 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
keystringRequiredWhich notification's template: signup_thank_you, restock_alert or reminder.
One ofsignup_thank_yourestock_alertreminder
Headers
Idempotency-KeystringA 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 (422idempotency_key_reused); a retry while the first is still running gets 409idempotency_key_in_progress. Keys are per store. Server errors and rate limits are not kept, so their retry runs.
Request body
localestringLanguage tag of the copy, e.g. "fr" or "pt-BR". Omit it for the shop's default language.
emailstring, nullableAddress to send the test to, one only. Default the shop's reply-to address.
shopify_variant_idstring, nullableShopify variant gid of the product shown in the test. Send with shopify_product_id or neither.
shopify_product_idstring, nullableShopify product gid of the product shown in the test. Send with shopify_variant_id or neither.
Returns
sent_tostringExample:owner@example.com
Errors
not_foundThe path is valid but nothing with that id exists in this store.
idempotency_key_in_progressAn earlier request with the same Idempotency-Key is still running. Wait, then resend the same request with the same key.
validation_failedThe 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.
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 '{
"email": "owner@example.com",
"shopify_variant_id": "gid://shopify/ProductVariant/47284734423096",
"shopify_product_id": "gid://shopify/Product/8784906035384"
}'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({
"email": "owner@example.com",
"shopify_variant_id": "gid://shopify/ProductVariant/47284734423096",
"shopify_product_id": "gid://shopify/Product/8784906035384"
}),
});
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={
"email": "owner@example.com",
"shopify_variant_id": "gid://shopify/ProductVariant/47284734423096",
"shopify_product_id": "gid://shopify/Product/8784906035384"
},
)
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 = {
email: "owner@example.com",
shopify_variant_id: "gid://shopify/ProductVariant/47284734423096",
shopify_product_id: "gid://shopify/Product/8784906035384"
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"sent_to": "owner@example.com"
}{
"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
}
]
}