Send a test confirmation
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/preorders/templates/confirmation/send_testCosts 2 rate-limit points · Rate limits
Send the preorder confirmation email to one email address as a test, rendered in the body locale (omit it for the shop default language) against one of the shop's own preorder offer products. Matches the preorder 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. offer_id (from GET /preorders/offers) and shopify_variant_id (a ProductVariant gid) pick the offer and product shown; omit both for the first product of the first enabled offer. Fails (422) when email sending is turned off, when the shop has no product in a preorder offer, or when the variant is not in the offer; 404 when the offer is not found or the shop has no single preorder confirmation template.
Also searched assend test preorder emailsend a test preorder confirmationpreview the preorder email in my inbox
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 of the copy, such as fr or pt-BR. Omit for the shop's default language.
emailstring, nullableOne address to send the test to. Defaults to the shop's reply-to address.
offer_idstring, nullableOffer whose product is shown in the email. Defaults to the first enabled offer.
shopify_variant_idstring, nullableVariant shown in the email, as gid://shopify/ProductVariant/<id>; it must be in the offer. Defaults to the offer's first product.
Returns
sent_tostringExample:merchandising@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/preorders/templates/confirmation/send_test" \
-H "X-Auth-Token: $STOQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"email": "merchandising@example.com",
"offer_id": "73a74948-2b57-4cc3-971f-2b441828c977",
"shopify_variant_id": "gid://shopify/ProductVariant/47284734423096"
}'const res = await fetch("https://app.stoqapp.com/api/v2/external/preorders/templates/confirmation/send_test", {
method: "POST",
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"email": "merchandising@example.com",
"offer_id": "73a74948-2b57-4cc3-971f-2b441828c977",
"shopify_variant_id": "gid://shopify/ProductVariant/47284734423096"
}),
});
const data = await res.json();import os
import requests
res = requests.post(
"https://app.stoqapp.com/api/v2/external/preorders/templates/confirmation/send_test",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
json={
"email": "merchandising@example.com",
"offer_id": "73a74948-2b57-4cc3-971f-2b441828c977",
"shopify_variant_id": "gid://shopify/ProductVariant/47284734423096"
},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.stoqapp.com/api/v2/external/preorders/templates/confirmation/send_test")
req = Net::HTTP::Post.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"], "Content-Type" => "application/json")
req.body = {
email: "merchandising@example.com",
offer_id: "73a74948-2b57-4cc3-971f-2b441828c977",
shopify_variant_id: "gid://shopify/ProductVariant/47284734423096"
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"sent_to": "merchandising@example.com"
}{
"errors": [
"Invalid API key"
],
"code": "auth_invalid",
"details": [
{
"code": "auth_invalid",
"message": "Invalid API key",
"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
}
]
}