Update language settings
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/account/languagesCosts 2 rate-limit points · Rate limits
Update the shop's language settings: the dashboard language (app_locale), multi-language alerts and widget, and translated product titles in alerts.
Deep partial: absent fields are unchanged. app_locale only changes the merchant dashboard. multi_language_enabled false also turns product_translations_enabled off. product_translations_enabled true needs the read_translations access the Settings page asks for; the call fails until it is granted. To change the alert language (default_locale), use POST /account/languages/reset_locale, which also resets that language's copy, as the dashboard does.
Also searched aschange dashboard languageuse stoq in frenchturn on multi languagesend alerts in the customer's languageuse translated product titlestranslate product titles
Headers
Idempotency-KeystringA 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 (422idempotency_key_reused); a retry while the first is still running gets 409idempotency_key_in_progress. Keys are per store. Server errors and rate limits are not kept, so their retry runs.
Request body
app_localestringThe merchant dashboard's language. Does not change what customers see.
One ofbgcsdadeenesetfifrhuiditjakonbnlplpt-BRpt-PTrorusvtrvizhzh-TWmulti_language_enabledbooleanShow the widget and send alerts in each customer's language. Off also turns product_translations_enabled off.
product_translations_enabledbooleanUse Shopify's translated product and variant titles in alerts. Needs multi_language_enabled and the translations access the Settings page asks for.
Returns
default_localestringExample:enapp_localestringExample:enmulti_language_enabledbooleanExample:trueproduct_translations_enabledbooleanExample:true
Errors
not_foundThe path is valid but nothing with that id exists in this store.
conflictThe request is well formed, but the resource's current state does not allow it.
idempotency_key_in_progressAn earlier request with the same Idempotency-Key is still running. Wait, then resend the same request with the same key.
invalid_paramsOne or more fields failed the action's schema.
validation_failedThe request failed validation.
shopify_errorA Shopify call the operation needs failed after the operation had started.
upstream_unavailableA service the answer depends on did not respond in time.
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 -X PATCH "https://app.stoqapp.com/api/v2/external/account/languages" \
-H "X-Auth-Token: $STOQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"multi_language_enabled": true,
"product_translations_enabled": true
}'const res = await fetch("https://app.stoqapp.com/api/v2/external/account/languages", {
method: "PATCH",
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"multi_language_enabled": true,
"product_translations_enabled": true
}),
});
const data = await res.json();import os
import requests
res = requests.patch(
"https://app.stoqapp.com/api/v2/external/account/languages",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
json={
"multi_language_enabled": True,
"product_translations_enabled": True
},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.stoqapp.com/api/v2/external/account/languages")
req = Net::HTTP::Patch.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"], "Content-Type" => "application/json")
req.body = {
multi_language_enabled: true,
product_translations_enabled: true
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"default_locale": "en",
"app_locale": "en",
"multi_language_enabled": true,
"product_translations_enabled": true
}{
"errors": [
"Invalid API key"
],
"code": "auth_invalid",
"details": [
{
"code": "auth_invalid",
"message": "Invalid API key",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"A request with this Idempotency-Key is still running"
],
"code": "idempotency_key_in_progress",
"details": [
{
"code": "idempotency_key_in_progress",
"message": "A request with this Idempotency-Key is still running",
"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
}
]
}