Get translations
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/preorders/offers/{id}/translationsCosts 1 rate-limit point · Rate limits
Read every translation override on a preorder offer, plus the full enumeration of translatable field paths, each field's default-locale source text, and every locale the shop has actually published (not just ones with an override already).
Overrides reach the storefront only while multi_language_enabled is true (PATCH /account/languages); until then shoppers see source_values, the default-language text. fields are the paths set, set_many and unset take, which are not the offer's own field names (checkout.terms.text is limits.terms.terms_text). locales lists only languages with an override, in stored form (pt-BR is pt_br); published_locales are the languages published in Shopify plus the default.
Also searched asget translationsshow translationsview translationslist translationsview localized texti18nlocalization
Path parameters
idstringRequiredThe offer's ID, from
GET /preorders/offers.
Returns
default_localestringThe shop's primary language, which the offer's own text is in.
localesarray of anysLanguages with at least one saved translation on this offer.
published_localesarray of stringsLanguages worth checking for gaps: those published in the shop's Shopify markets plus the default language.
multi_language_enabledbooleanWhether translations reach the storefront. Turned on with PATCH /account/languages.
fieldsarray of stringsEvery translatable field path, such as widget.button.text.
source_valuesobjectThe offer's text in the default language, keyed by field path. Null where the field is empty.
Show 26 child attributesHide child attributes
widget.button.textstringPreorder button label (widget.button.button_text on the offer).
widget.disclaimer.textstringDisclaimer line under the button (widget.disclaimer.disclaimer_text).
widget.badge.textstringPreorder badge label (widget.badge.badge_text).
widget.billing_widget.titlestringPayment widget title stored on the offer itself, which is also the title of the payment option the offer row holds.
widget.billing_widget.descriptionstringPayment widget description stored on the offer itself, which is also the description of the payment option the offer row holds.
shipping.shipping_textstringShip date text, the {{ date }} value (shipping.timeline.variant_shipping_text).
shipping.preorder_shipping_textstringShipping line under the button (shipping.timeline.shipping_text).
payments.discount_textstringDiscount text stored on the offer itself, for the payment option the offer row holds.
limits.quantity_limit_textstringText printed with the remaining-units count (limits.limit_text).
limits.progress_bar_textstringProgress bar text (limits.progress_bar.progress_text).
checkout.terms.textstringWording beside the terms checkbox (limits.terms.terms_text).
checkout.mixed_cart.error_messagestringError shown when a blocked mixed cart reaches checkout (limits.cart.error_message).
countdown.textnullCountdown heading; the same text as countdown.ends_text.
countdown.starts_textnullCountdown heading shown before launch (countdown.starts_text).
countdown.ends_textnullCountdown heading shown during the preorder (countdown.ends_text).
countdown.unit_labels.daysstringCountdown days label (countdown.labels.days).
countdown.unit_labels.hoursstringCountdown hours label (countdown.labels.hours).
countdown.unit_labels.minutesstringCountdown minutes label (countdown.labels.minutes).
countdown.unit_labels.secondsstringCountdown seconds label (countdown.labels.seconds).
advanced.line_item_properties.custom_textnullFree text added to every preorder cart line (advanced.cart_attributes.custom_text).
payments.options.full.billing_titlestringTitle of the full-payment option (payments.full.option_title). Null when the offer has no full-payment option.
payments.options.full.billing_descriptionstringDescription of the full-payment option (payments.full.option_description).
payments.options.full.discount_textstringDiscount text of the full-payment option (payments.full.discount_text).
payments.options.partial.billing_titlenullTitle of the partial-payment option (payments.partial.option_title). Null when the offer has no partial-payment option.
payments.options.partial.billing_descriptionnullDescription of the partial-payment option (payments.partial.option_description).
payments.options.partial.discount_textnullDiscount text of the partial-payment option (payments.partial.discount_text).
translationsobjectSaved translations keyed by locale, then by field path. Only locales and fields with saved text appear.
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/offers/73a74948-2b57-4cc3-971f-2b441828c977/translations" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/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/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/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/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/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){
"default_locale": "string",
"locales": [
null
],
"published_locales": [
"string"
],
"multi_language_enabled": true,
"fields": [
"string"
],
"source_values": {
"widget.button.text": "string",
"widget.disclaimer.text": "string",
"widget.badge.text": "string",
"widget.billing_widget.title": "string",
"widget.billing_widget.description": "string",
"shipping.shipping_text": "string",
"shipping.preorder_shipping_text": "string",
"payments.discount_text": "string",
"limits.quantity_limit_text": "string",
"limits.progress_bar_text": "string",
"checkout.terms.text": "string",
"checkout.mixed_cart.error_message": "string",
"countdown.text": null,
"countdown.starts_text": null,
"countdown.ends_text": null,
"countdown.unit_labels.days": "string",
"countdown.unit_labels.hours": "string",
"countdown.unit_labels.minutes": "string",
"countdown.unit_labels.seconds": "string",
"advanced.line_item_properties.custom_text": null,
"payments.options.full.billing_title": "string",
"payments.options.full.billing_description": "string",
"payments.options.full.discount_text": "string",
"payments.options.partial.billing_title": null,
"payments.options.partial.billing_description": null,
"payments.options.partial.discount_text": null
},
"translations": {}
}{
"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
}
]
}