Get a template's translations
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/back_in_stock/templates/{key}/translationsCosts 1 rate-limit point · Rate limits
Read every translation of one back-in-stock notification's copy: the translatable field paths (as GET /back_in_stock/templates/:key names them), each one's default-language text, and the text per locale. key is "signup_thank_you", "restock_alert" or "reminder".
Write a translation with PATCH /back_in_stock/templates/:key and a body locale.
Also searched asback in stock template translationsrestock email translationsrestock sms translations
Path parameters
keystringRequiredWhich notification's template: signup_thank_you, restock_alert or reminder.
One ofsignup_thank_yourestock_alertreminder
Returns
keystringExample:stringdefault_localestringExample:stringlocalesarray of stringspublished_localesarray of stringsfieldsarray of stringssource_valuesobjectShow 11 child attributesHide child attributes
email.subjectstringExample:stringemail.preheadernullemail.headingstringExample:stringemail.bodystringExample:stringemail.footerstringExample:stringemail.button.textstringExample:stringemail.html.templatenullemail.reviews.titlestringExample:stringemail.unsubscribe_textstringExample:stringemail.consent_textstringExample:stringsms.bodystringExample:string
translationsobjectShow 1 child attributeHide child attributes
frobjectShow 2 child attributesHide child attributes
email.subjectstringExample:stringsms.bodystringExample:string
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/back_in_stock/templates/{key}/translations" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/back_in_stock/templates/{key}/translations", {
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/back_in_stock/templates/{key}/translations",
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/back_in_stock/templates/{key}/translations")
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",
"default_locale": "string",
"locales": [
"string"
],
"published_locales": [
"string"
],
"fields": [
"string"
],
"source_values": {
"email.subject": "string",
"email.preheader": null,
"email.heading": "string",
"email.body": "string",
"email.footer": "string",
"email.button.text": "string",
"email.html.template": null,
"email.reviews.title": "string",
"email.unsubscribe_text": "string",
"email.consent_text": "string",
"sms.body": "string"
},
"translations": {
"fr": {
"email.subject": "string",
"sms.body": "string"
}
}
}{
"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": [
"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
}
]
}