Get shipping email
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/preorders/templates/shipping_updateCosts 1 rate-limit point · Rate limits
Read the preorder shipping-update notification's email copy (it has no SMS). ?locale= picks the language (omit it for the shop default).
Change the copy with PATCH /preorders/templates/shipping_update. It is the default for the email that POST /preorders/orders/:id/send_shipping_update and /preorders/orders/bulk_send_shipping_update send, and that the reschedule_fulfillment and bulk_reschedule_fulfillment order actions send with send_shipping_update: true; each call can override subject, heading and body. STOQ never sends it on its own. A language with no translation of a field returns the shop default's text for it.
Also searched asshipping update email copy
Query parameters
localestringLanguage of the copy, such as fr or pt-BR. Omit for the shop's default language.
Returns
keystringExample:stringlocalestringExample:stringemailobjectShow 6 child attributesHide child attributes
subjectstringExample:stringheadingstringExample:stringbodystringExample:stringklaviyo_flow_namestring, nullableExample:stringklaviyo_flow_verifiedbooleanExample:trueintegrationnull
Errors
not_foundThe path is valid but nothing with that id exists in this store.
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/shipping_update" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/preorders/templates/shipping_update", {
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/shipping_update",
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/shipping_update")
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/shipping_update?locale=fr" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/preorders/templates/shipping_update?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/shipping_update?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/shipping_update?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",
"heading": "string",
"body": "string",
"klaviyo_flow_name": "string",
"klaviyo_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
}
]
}