Skip to content

Update language settings

API v2 is in public beta: endpoints and fields can change before general availability. See the changelog

PATCH/account/languages

Costs 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-Keystring

    A 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 (422 idempotency_key_reused); a retry while the first is still running gets 409 idempotency_key_in_progress. Keys are per store. Server errors and rate limits are not kept, so their retry runs.

Request body

  • app_localestring

    The merchant dashboard's language. Does not change what customers see.

    One of bgcsdadeenesetfifrhuiditjakonbnlplpt-BRpt-PTrorusvtrvizhzh-TW
  • multi_language_enabledboolean

    Show the widget and send alerts in each customer's language. Off also turns product_translations_enabled off.

  • product_translations_enabledboolean

    Use Shopify's translated product and variant titles in alerts. Needs multi_language_enabled and the translations access the Settings page asks for.

Returns

  • default_localestring
    Example: en
  • app_localestring
    Example: en
  • multi_language_enabledboolean
    Example: true
  • product_translations_enabledboolean
    Example: true

Errors

404
not_found

The path is valid but nothing with that id exists in this store.

409
conflict

The request is well formed, but the resource's current state does not allow it.

409
idempotency_key_in_progress

An earlier request with the same Idempotency-Key is still running. Wait, then resend the same request with the same key.

422
invalid_params

One or more fields failed the action's schema.

422
validation_failed

The request failed validation.

502
shopify_error

A Shopify call the operation needs failed after the operation had started.

503
upstream_unavailable

A 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.

PATCH/account/languages
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
  }'
Response
{
  "default_locale": "en",
  "app_locale": "en",
  "multi_language_enabled": true,
  "product_translations_enabled": true
}