Skip to content

Send a test confirmation

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

POST/preorders/templates/confirmation/send_test

Costs 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-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

    Language of the copy, such as fr or pt-BR. Omit for the shop's default language.

  • emailstring, nullable

    One address to send the test to. Defaults to the shop's reply-to address.

  • offer_idstring, nullable

    Offer whose product is shown in the email. Defaults to the first enabled offer.

  • shopify_variant_idstring, nullable

    Variant shown in the email, as gid://shopify/ProductVariant/<id>; it must be in the offer. Defaults to the offer's first product.

Returns

  • sent_tostring
    Example: merchandising@example.com

Errors

404
not_found

The path is valid but nothing with that id exists in this store.

409
idempotency_key_in_progress

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

422
validation_failed

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

POST/preorders/templates/confirmation/send_test
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"
  }'
Response
{
  "sent_to": "merchandising@example.com"
}