Skip to content

Get storefront translations

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

GET/account/translations

Costs 1 rate-limit point · Rate limits

Read every translation override on the shop's notify-me button, signup form, and preorder button/modal text, plus the full enumeration of translatable field paths, each field's default-locale source text, and every locale the shop has actually published.

Read only. To write a translation, pass locale to PATCH /back_in_stock/settings/widget (Notify me button, signup form, opt-in email) or PATCH /preorders/settings/storefront_text (preorder button and modal). translations holds only the fields with an override, by locale, and is {} when there are none. published_locales always includes the alert language and can lag a change in Shopify by a few minutes.

Also searched asget widget translationssignup form translationsnotify me translationsshop translations

Returns

  • default_localestring
    Example: string
  • localesarray of strings
  • published_localesarray of strings
  • fieldsarray of strings
  • source_valuesobject
    Show 31 child attributesHide child attributes
    • notify_button.textstring
      Example: string
    • notify_button.resubscribe_textstring
      Example: string
    • notify_button.email_button_textnull
    • preorder_button.out_of_stock_textstring
      Example: string
    • preorder_button.add_to_cart_textstring
      Example: string
    • preorder_button.modal_continue_textstring
      Example: string
    • preorder_button.modal_cancel_textstring
      Example: string
    • signup_form.headerstring
      Example: string
    • signup_form.descriptionstring
      Example: string
    • signup_form.customer_name_placeholderstring
      Example: string
    • signup_form.customer_name_errorstring
      Example: string
    • signup_form.email_labelstring
      Example: string
    • signup_form.email_placeholderstring
      Example: string
    • signup_form.errorstring
      Example: string
    • signup_form.phone_labelstring
      Example: string
    • signup_form.phone_placeholderstring
      Example: string
    • signup_form.phone_errorstring
      Example: string
    • signup_form.quantity_labelstring
      Example: string
    • signup_form.promotion_consent_labelstring
      Example: string
    • signup_form.termsstring
      Example: string
    • signup_form.successstring
      Example: string
    • signup_form.button_textstring
      Example: string
    • signup_form.empty_errorstring
      Example: string
    • signup_form.duplicate_errorstring
      Example: string
    • signup_form.did_you_mean_errorstring
      Example: string
    • signup_form.mixed_cart_errorstring
      Example: string
    • signup_form.error_headingstring
      Example: string
    • optin.email_subjectstring
      Example: string
    • optin.email_bodystring
      Example: string
    • optin.success_textstring
      Example: string
    • review_trigger.textnull
  • translationsobject
    Show 2 child attributesHide child attributes
    • frobject
      Show 1 child attributeHide child attributes
      • notify_button.textstring
        Example: string
    • enobject
      Show 1 child attributeHide child attributes
      • notify_button.textstring
        Example: string

Errors

404
not_found

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

422
validation_failed

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

GET/account/translations
curl "https://app.stoqapp.com/api/v2/external/account/translations" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "default_locale": "string",
  "locales": [
    "string"
  ],
  "published_locales": [
    "string"
  ],
  "fields": [
    "string"
  ],
  "source_values": {
    "notify_button.text": "string",
    "notify_button.resubscribe_text": "string",
    "notify_button.email_button_text": null,
    "preorder_button.out_of_stock_text": "string",
    "preorder_button.add_to_cart_text": "string",
    "preorder_button.modal_continue_text": "string",
    "preorder_button.modal_cancel_text": "string",
    "signup_form.header": "string",
    "signup_form.description": "string",
    "signup_form.customer_name_placeholder": "string",
    "signup_form.customer_name_error": "string",
    "signup_form.email_label": "string",
    "signup_form.email_placeholder": "string",
    "signup_form.error": "string",
    "signup_form.phone_label": "string",
    "signup_form.phone_placeholder": "string",
    "signup_form.phone_error": "string",
    "signup_form.quantity_label": "string",
    "signup_form.promotion_consent_label": "string",
    "signup_form.terms": "string",
    "signup_form.success": "string",
    "signup_form.button_text": "string",
    "signup_form.empty_error": "string",
    "signup_form.duplicate_error": "string",
    "signup_form.did_you_mean_error": "string",
    "signup_form.mixed_cart_error": "string",
    "signup_form.error_heading": "string",
    "optin.email_subject": "string",
    "optin.email_body": "string",
    "optin.success_text": "string",
    "review_trigger.text": null
  },
  "translations": {
    "fr": {
      "notify_button.text": "string"
    },
    "en": {
      "notify_button.text": "string"
    }
  }
}