---
title: "Get storefront text"
description: "The shop-wide preorder storefront text: the currency format, the button's out-of-stock and add-to-cart text, and the preorder modal's continue and cancel buttons and error heading. Shared by every preorder offer. ?locale"
url: https://docs.stoqapp.com/v2-reference/preorders-settings/get-storefront-text/
api: "API v2 reference"
method: GET
path: "/preorders/settings/storefront_text"
---

# Get storefront text

`GET https://app.stoqapp.com/api/v2/external/preorders/settings/storefront_text`

The shop-wide preorder storefront text: the currency format, the button's out-of-stock and add-to-cart text, and the preorder modal's continue and cancel buttons and error heading. Shared by every preorder offer. `?locale=` reads one language (omitted: the shop's default language).

**Note:** Change it with [`PATCH /preorders/settings/storefront_text`](https://docs.stoqapp.com/v2-reference/preorders-settings/update-storefront-text/). A language with no translation of a field returns the shop default's text for it, and `locale` echoes the language asked for. currency_format is the same in every language. The Preorder button's own text and the offer's messages are set per offer ([`PATCH /preorders/offers/:id/widget`](https://docs.stoqapp.com/v2-reference/preorders-offers/update-widget/)).

## Query parameters

- `locale` (string): Language of the text, such as fr or pt-BR. Omit for the shop's default language.

## Returns

- `currency_format` (string): e.g. `string`
- `button` (object)
  - `out_of_stock_text` (string): e.g. `string`
  - `add_to_cart_text` (string): e.g. `string`
- `modal` (object)
  - `continue_button_text` (string): e.g. `string`
  - `cancel_button_text` (string): e.g. `string`
  - `error_heading` (string): e.g. `string`
- `locale` (string): e.g. `string`

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

## Examples

### Get storefront text

```sh
curl "https://app.stoqapp.com/api/v2/external/preorders/settings/storefront_text" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

### Get storefront text filtered by locale

```sh
curl "https://app.stoqapp.com/api/v2/external/preorders/settings/storefront_text?locale=fr" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

## 200

Success: the requested resource.

```json
{
  "currency_format": "string",
  "button": {
    "out_of_stock_text": "string",
    "add_to_cart_text": "string"
  },
  "modal": {
    "continue_button_text": "string",
    "cancel_button_text": "string",
    "error_heading": "string"
  },
  "locale": "string"
}
```

## 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
    }
  ]
}
```

## 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
    }
  ]
}
```

