---
title: "Get translations"
description: "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"
url: https://docs.stoqapp.com/v2-reference/preorders-offers/get-translations/
api: "API v2 reference"
method: GET
path: "/preorders/offers/{id}/translations"
---

# Get translations

`GET https://app.stoqapp.com/api/v2/external/preorders/offers/{id}/translations`

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

**Note:** Overrides reach the storefront only while `multi_language_enabled` is true ([`PATCH /account/languages`](https://docs.stoqapp.com/v2-reference/account-languages/update-language-settings/)); 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.

## Path parameters

- `id` (string, required): The offer's ID, from [`GET /preorders/offers`](https://docs.stoqapp.com/v2-reference/preorders-offers/list-offers/).

## Returns

- `default_locale` (string): The shop's primary language, which the offer's own text is in.
- `locales` (array of anys): Languages with at least one saved translation on this offer.
- `published_locales` (array of strings): Languages worth checking for gaps: those published in the shop's Shopify markets plus the default language.
- `multi_language_enabled` (boolean): Whether translations reach the storefront. Turned on with PATCH /account/languages.
- `fields` (array of strings): Every translatable field path, such as widget.button.text.
- `source_values` (object): The offer's text in the default language, keyed by field path. Null where the field is empty.
  - `widget.button.text` (string): Preorder button label (widget.button.button_text on the offer).
  - `widget.disclaimer.text` (string): Disclaimer line under the button (widget.disclaimer.disclaimer_text).
  - `widget.badge.text` (string): Preorder badge label (widget.badge.badge_text).
  - `widget.billing_widget.title` (string): Payment widget title stored on the offer itself, which is also the title of the payment option the offer row holds.
  - `widget.billing_widget.description` (string): Payment widget description stored on the offer itself, which is also the description of the payment option the offer row holds.
  - `shipping.shipping_text` (string): Ship date text, the {{ date }} value (shipping.timeline.variant_shipping_text).
  - `shipping.preorder_shipping_text` (string): Shipping line under the button (shipping.timeline.shipping_text).
  - `payments.discount_text` (string): Discount text stored on the offer itself, for the payment option the offer row holds.
  - `limits.quantity_limit_text` (string): Text printed with the remaining-units count (limits.limit_text).
  - `limits.progress_bar_text` (string): Progress bar text (limits.progress_bar.progress_text).
  - `checkout.terms.text` (string): Wording beside the terms checkbox (limits.terms.terms_text).
  - `checkout.mixed_cart.error_message` (string): Error shown when a blocked mixed cart reaches checkout (limits.cart.error_message).
  - `countdown.text` (null): Countdown heading; the same text as countdown.ends_text.
  - `countdown.starts_text` (null): Countdown heading shown before launch (countdown.starts_text).
  - `countdown.ends_text` (null): Countdown heading shown during the preorder (countdown.ends_text).
  - `countdown.unit_labels.days` (string): Countdown days label (countdown.labels.days).
  - `countdown.unit_labels.hours` (string): Countdown hours label (countdown.labels.hours).
  - `countdown.unit_labels.minutes` (string): Countdown minutes label (countdown.labels.minutes).
  - `countdown.unit_labels.seconds` (string): Countdown seconds label (countdown.labels.seconds).
  - `advanced.line_item_properties.custom_text` (null): Free text added to every preorder cart line (advanced.cart_attributes.custom_text).
  - `payments.options.full.billing_title` (string): Title of the full-payment option (payments.full.option_title). Null when the offer has no full-payment option.
  - `payments.options.full.billing_description` (string): Description of the full-payment option (payments.full.option_description).
  - `payments.options.full.discount_text` (string): Discount text of the full-payment option (payments.full.discount_text).
  - `payments.options.partial.billing_title` (null): Title of the partial-payment option (payments.partial.option_title). Null when the offer has no partial-payment option.
  - `payments.options.partial.billing_description` (null): Description of the partial-payment option (payments.partial.option_description).
  - `payments.options.partial.discount_text` (null): Discount text of the partial-payment option (payments.partial.discount_text).
- `translations` (object): Saved translations keyed by locale, then by field path. Only locales and fields with saved text appear.

Rate limit: this call costs 1 point ([rate limits](https://docs.stoqapp.com/docs/rate-limits/)).

## Example request

```sh
curl "https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/translations" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

## 200

Success: the requested resource.

```json
{
  "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": {}
}
```

## 401

Missing or invalid `X-Auth-Token`.

```json
{
  "errors": [
    "Invalid API key"
  ],
  "code": "auth_invalid",
  "details": [
    {
      "code": "auth_invalid",
      "message": "Invalid API key",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 404

The resource does not exist for this shop, or the action path is not registered.

```json
{
  "errors": [
    "Offer not found"
  ],
  "code": "not_found",
  "details": [
    {
      "code": "not_found",
      "message": "Offer not found",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 422

The request failed validation.

```json
{
  "errors": [
    "name is required"
  ],
  "code": "validation_failed",
  "details": [
    {
      "code": "validation_failed",
      "message": "name is required",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 429

Rate limited: cost-weighted per token (read 1, write 2; 360 points / 60s). Check `Retry-After`.

```json
{
  "errors": [
    "Rate limit exceeded"
  ],
  "code": "rate_limited",
  "details": [
    {
      "code": "rate_limited",
      "message": "Rate limit exceeded",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

