Get confirmation email
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/preorders/templates/confirmationCosts 1 rate-limit point · Rate limits
Read the preorder confirmation notification's email and SMS copy. ?locale= picks the language (omit it for the shop default); the response names it in locale. Whether it sends is GET /preorders/notification_settings/confirmation.
Change the copy with PATCH /preorders/templates/confirmation. The copy uses Liquid variables such as {{order.name}} and {{shop.name}}. A language with no translation of a field returns the shop default's text for it. integration is set when the shop sends that channel through Klaviyo, Postscript or Shopify Flow, and klaviyo_flow_name is the Klaviyo flow it uses then. 404 not_found when the shop has no single preorder confirmation template.
Also searched aspreorder confirmation email copypreorder confirmation sms copyget preorder templateshow preorder emaillocalized preorder notification template
Query parameters
localestringLanguage of the copy, such as fr or pt-BR. Omit for the shop's default language.
Returns
keystringExample:stringlocalestringExample:stringemailobjectShow 14 child attributesHide child attributes
subjectstringExample:stringpreheadernullheadingstringExample:stringbodystringExample:stringfooterstringExample:stringbuttonobjectShow 4 child attributesHide child attributes
textstringExample:stringbackground_colorstringExample:stringtext_colorstringExample:stringradiusintegerExample:1
colorsobjectShow 3 child attributesHide child attributes
backgroundstringExample:stringsectionstringExample:stringtextstringExample:string
radiusintegerExample:1cssnullreviewsobjectShow 4 child attributesHide child attributes
enabledbooleanExample:truecountintegerExample:1min_ratingintegerExample:1titlestringExample:string
socialobjectShow 8 child attributesHide child attributes
facebooknullinstagramnullpinterestnulltwitternulltiktoknullwhatsappnullyoutubenullicon_colorstringExample:string
klaviyo_flow_namestring, nullableExample:stringklaviyo_flow_verifiedbooleanExample:trueintegrationnull
smsobjectShow 5 child attributesHide child attributes
bodystringExample:stringklaviyo_flow_namestring, nullableExample:stringklaviyo_flow_verifiedbooleanExample:truepostscript_flow_verifiedbooleanExample:trueintegrationnull
Errors
not_foundThe path is valid but nothing with that id exists in this store.
invalid_paramsOne or more fields failed the action's schema.
validation_failedThe request failed validation.
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 "https://app.stoqapp.com/api/v2/external/preorders/templates/confirmation" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/preorders/templates/confirmation", {
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
},
});
const data = await res.json();import os
import requests
res = requests.get(
"https://app.stoqapp.com/api/v2/external/preorders/templates/confirmation",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.stoqapp.com/api/v2/external/preorders/templates/confirmation")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)curl "https://app.stoqapp.com/api/v2/external/preorders/templates/confirmation?locale=fr" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/preorders/templates/confirmation?locale=fr", {
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
},
});
const data = await res.json();import os
import requests
res = requests.get(
"https://app.stoqapp.com/api/v2/external/preorders/templates/confirmation?locale=fr",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.stoqapp.com/api/v2/external/preorders/templates/confirmation?locale=fr")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"key": "string",
"locale": "string",
"email": {
"subject": "string",
"preheader": null,
"heading": "string",
"body": "string",
"footer": "string",
"button": {
"text": "string",
"background_color": "string",
"text_color": "string",
"radius": 1
},
"colors": {
"background": "string",
"section": "string",
"text": "string"
},
"radius": 1,
"css": null,
"reviews": {
"enabled": true,
"count": 1,
"min_rating": 1,
"title": "string"
},
"social": {
"facebook": null,
"instagram": null,
"pinterest": null,
"twitter": null,
"tiktok": null,
"whatsapp": null,
"youtube": null,
"icon_color": "string"
},
"klaviyo_flow_name": "string",
"klaviyo_flow_verified": true,
"integration": null
},
"sms": {
"body": "string",
"klaviyo_flow_name": "string",
"klaviyo_flow_verified": true,
"postscript_flow_verified": true,
"integration": null
}
}{
"errors": [
"Invalid API key"
],
"code": "auth_invalid",
"details": [
{
"code": "auth_invalid",
"message": "Invalid API key",
"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
}
]
}