Skip to content

Set several translations

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

POST/preorders/offers/{id}/translations/set_many

Costs 2 rate-limit points · Rate limits

Set many translation overrides for one locale on a preorder offer, atomically.

All-or-nothing. Pre-validates every field path before writing.

Also searched asset many translationstranslate offerbulk translatelocalize offertranslate to frenchadd translations

Path parameters

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

  • localestringRequired

    Language of the overrides, such as fr or pt-BR.

  • translationsobjectRequired

    Translated text keyed by field path, such as {"widget.button.text": "Précommander"}. All are saved or none.

    Show 2 child attributesHide child attributes
    • widget.button.textstring
      Example: Précommander
    • widget.badge.textstring
      Example: Précommande

Returns

  • default_localestring

    The shop's primary language, which the offer's own text is in.

  • localesarray of strings

    Languages with at least one saved translation on this offer.

  • published_localesarray of strings

    Languages worth checking for gaps: those published in the shop's Shopify markets plus the default language.

  • multi_language_enabledboolean

    Whether translations reach the storefront. Turned on with PATCH /account/languages.

  • fieldsarray of strings

    Every translatable field path, such as widget.button.text.

  • source_valuesobject

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

      Preorder button label (widget.button.button_text on the offer).

    • widget.disclaimer.textstring

      Disclaimer line under the button (widget.disclaimer.disclaimer_text).

    • widget.badge.textstring

      Preorder badge label (widget.badge.badge_text).

    • widget.billing_widget.titlestring

      Payment widget title stored on the offer itself, which is also the title of the payment option the offer row holds.

    • widget.billing_widget.descriptionstring

      Payment widget description stored on the offer itself, which is also the description of the payment option the offer row holds.

    • shipping.shipping_textstring

      Ship date text, the {{ date }} value (shipping.timeline.variant_shipping_text).

    • shipping.preorder_shipping_textstring

      Shipping line under the button (shipping.timeline.shipping_text).

    • payments.discount_textstring

      Discount text stored on the offer itself, for the payment option the offer row holds.

    • limits.quantity_limit_textstring

      Text printed with the remaining-units count (limits.limit_text).

    • limits.progress_bar_textstring

      Progress bar text (limits.progress_bar.progress_text).

    • checkout.terms.textstring

      Wording beside the terms checkbox (limits.terms.terms_text).

    • checkout.mixed_cart.error_messagestring

      Error shown when a blocked mixed cart reaches checkout (limits.cart.error_message).

    • countdown.textnull

      Countdown heading; the same text as countdown.ends_text.

    • countdown.starts_textnull

      Countdown heading shown before launch (countdown.starts_text).

    • countdown.ends_textnull

      Countdown heading shown during the preorder (countdown.ends_text).

    • countdown.unit_labels.daysstring

      Countdown days label (countdown.labels.days).

    • countdown.unit_labels.hoursstring

      Countdown hours label (countdown.labels.hours).

    • countdown.unit_labels.minutesstring

      Countdown minutes label (countdown.labels.minutes).

    • countdown.unit_labels.secondsstring

      Countdown seconds label (countdown.labels.seconds).

    • advanced.line_item_properties.custom_textnull

      Free text added to every preorder cart line (advanced.cart_attributes.custom_text).

    • payments.options.full.billing_titlestring

      Title of the full-payment option (payments.full.option_title). Null when the offer has no full-payment option.

    • payments.options.full.billing_descriptionstring

      Description of the full-payment option (payments.full.option_description).

    • payments.options.full.discount_textstring

      Discount text of the full-payment option (payments.full.discount_text).

    • payments.options.partial.billing_titlestring, nullable

      Title of the partial-payment option (payments.partial.option_title). Null when the offer has no partial-payment option.

    • payments.options.partial.billing_descriptionstring, nullable

      Description of the partial-payment option (payments.partial.option_description).

    • payments.options.partial.discount_textstring, nullable

      Discount text of the partial-payment option (payments.partial.discount_text).

  • translationsobject

    Saved translations keyed by locale, then by field path. Only locales and fields with saved text appear.

    Show 2 child attributesHide child attributes
    • frobject

      Saved fr translations, keyed by field path.

      Show 4 child attributesHide child attributes
      • widget.button.textstring

        Saved fr text for widget.button.text.

      • widget.disclaimer.textstring

        Saved fr text for widget.disclaimer.text.

      • checkout.terms.textstring

        Saved fr text for checkout.terms.text.

      • payments.options.partial.discount_textstring

        Saved fr text for payments.options.partial.discount_text.

    • zh_twobject

      Saved zh_tw translations, keyed by field path.

      Show 1 child attributeHide child attributes
      • widget.button.textstring

        Saved zh_tw text for widget.button.text.

Errors

404
not_found

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

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 action refused the request for a reason that is not a single bad field.

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.

POST/preorders/offers/{id}/translations/set_many
curl -X POST "https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/translations/set_many" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "locale": "fr",
    "translations": {
      "widget.button.text": "Précommander",
      "widget.badge.text": "Précommande"
    }
  }'
Response
{
  "default_locale": "en",
  "locales": [
    "fr"
  ],
  "published_locales": [
    "en",
    "fr",
    "de"
  ],
  "multi_language_enabled": true,
  "fields": [
    "widget.button.text",
    "widget.disclaimer.text",
    "widget.badge.text"
  ],
  "source_values": {
    "widget.button.text": "Preorder Now",
    "widget.disclaimer.text": "Expected to ship by August 2026",
    "widget.badge.text": "Pre-Order"
  },
  "translations": {
    "fr": {
      "widget.button.text": "Précommander",
      "widget.badge.text": "Précommande"
    }
  }
}