---
title: "Get widget"
description: "Read the widget configuration for a preorder offer."
url: https://docs.stoqapp.com/v2-reference/preorders-offers/get-widget/
api: "API v2 reference"
method: GET
path: "/preorders/offers/{id}/widget"
---

# Get widget

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

Read the widget configuration for a preorder offer.

**Note:** `button.text_color` and `background_color` only show while `custom_colors_enabled` is true; otherwise the theme's button colors are used. The disclaimer and the badge show only while `show_disclaimer` and `show_badge` are true. The payment and savings breakdown is `payments.show_payment_widget`, not part of this section. `locale` returns the texts in that language. Edit with [`PATCH /preorders/offers/:id/widget`](https://docs.stoqapp.com/v2-reference/preorders-offers/update-widget/).

## Path parameters

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

## Query parameters

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

## Returns

- `button` (object): Text and colors of the preorder button.
  - `button_text` (string): Preorder button label.
  - `custom_colors_enabled` (boolean): true uses text_color and background_color; false uses the theme's own button colors.
  - `text_color` (string): Button text color, as hex. Used when custom_colors_enabled is true.
  - `background_color` (string): Button background color, as hex. Used when custom_colors_enabled is true.
- `disclaimer` (object): The disclaimer line shown under the preorder button.
  - `show_disclaimer` (boolean): Whether the disclaimer line shows under the button.
  - `disclaimer_text` (string): Text of the disclaimer line.
  - `text_color` (string): Disclaimer text color, as hex.
  - `background_color` (string): Disclaimer background color, as hex.
  - `border_radius` (integer): Disclaimer corner radius in pixels.
- `badge` (object): The preorder badge shown on product pages and product cards.
  - `show_badge` (boolean): Whether the preorder badge shows.
  - `badge_text` (string): Label printed on the preorder badge.
  - `text_color` (string): Badge text color, as hex.
  - `background_color` (string): Badge background color, as hex.

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

## Examples

### Get widget

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

### Get widget filtered by locale

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

## 200

Success: example response shown.

```json
{
  "button": {
    "button_text": "Preorder Now",
    "custom_colors_enabled": true,
    "text_color": "#ffffff",
    "background_color": "#8700d3"
  },
  "disclaimer": {
    "show_disclaimer": true,
    "disclaimer_text": "Expected to ship by August 2026",
    "text_color": "#FFFFFF",
    "background_color": "#1F2937",
    "border_radius": 4
  },
  "badge": {
    "show_badge": true,
    "badge_text": "Pre-Order",
    "text_color": "#FFFFFF",
    "background_color": "#000000"
  }
}
```

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

