> ## Documentation Index
> Fetch the complete documentation index at: https://allbay.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Variáveis Globais

> Objetos disponíveis nas páginas do tema — e em quais páginas cada um tem dados.

Estas variáveis existem em **todas** as páginas. Algumas só têm dados em certas rotas
(indicado em cada uma); cada página também recebe variáveis próprias (ver [Páginas](https://allbay.mintlify.site/editor/paginas.md)).

> [!NOTE]
>
> Campos sem valor costumam vir **ausentes** ou `null`. Teste antes de usar:
> `{% if store.custom_domain %}…{% endif %}`.

## `store`: a loja

```liquid theme={null}
{{ store.name }} · {{ store.currency }}
```

| Campo | Tipo | Descrição |
| - | - | - |
| `name` | string | Nome da loja |
| `currency` | string | Moeda (`BRL`, `USD`, `EUR`) |
| `subdomain` | string? | Subdomínio |
| `custom_domain` | string? | Domínio próprio — só quando está **ativo** e o nível da loja inclui domínio próprio |
| `canonical_origin` | string? | Endereço principal da loja |
| `type` | string | Sempre `STANDALONE` |
| `maintenance` | bool | Loja pausada |
| `auth` / `show_login` | bool | Login habilitado |
| `require_document` | bool | Exige documento no checkout |
| `require_address` | bool | Exige endereço |
| `require_discord` | bool | Exige Discord |
| `phone_mode` | string | `DISABLED` / `OPTIONAL` / `REQUIRED` (`phone_mode_id`: 0/1/2) |
| `terms` | string? | Termos da loja (HTML) |
| `theme` | objeto | O mesmo objeto de [`theme`](#theme-aparência) |

> [!NOTE]
>
> Existe também `shop` (`name`, `slug`, `id`, `logo_url`, `banner_url`). Prefira **`store`**,
> que traz os dados completos.

## `theme`: aparência

| Campo | Tipo |
| - | - |
| `primary_color`, `secondary_color`, `accent_color`, `buttons_color` | `#rrggbb` (sempre presentes) |
| `theme_mode` | `light` / `dark` |
| `logo`, `banner`, `favicon` | URL de imagem pronta (ver [Imagens](https://allbay.mintlify.site/editor/imagens.md)) |
| `description` | string? |
| `background_image`, `hero_image` | URL de imagem pronta (ausente se não configurada) |
| `floating_categories`, `show_search`, `show_sales` | bool |
| `fixed_aspect_ratio`, `contact_link` | — |

Campos que o dono não configurou ficam **ausentes**.

> [!WARNING]
>
> `theme.logo` vem em tamanho pequeno (64 px). Para mostrar o logo grande, use um campo de
> imagem do [schema](https://allbay.mintlify.site/editor/schema.md).

## `config` e `settings`

`config` junta, nesta ordem (o seguinte vence o anterior): a paleta do tema, as seções da
home e os valores do [schema](https://allbay.mintlify.site/editor/schema.md). A chave em `config` é **exatamente** a chave
do campo no schema — use só letras, números e `_` (`primary_color`).

Quando o tema tem o próprio `config/settings_schema.json`, `settings` traz os valores já
validados: chaves não declaradas são descartadas e os `default` preenchidos. Sem esse arquivo
(como no Vega), `settings` traz os valores salvos como estão — sem `default`.
Os termos da loja também ficam em `settings.terms_content` quando o tema não define esse campo.

```liquid theme={null}
<style>:root{ --primary: {{ config.primary_color | hex_to_hsl }}; }</style>
{{ config.headline }}
{% if config.hero_image %}<img src="{{ config.hero_image }}" alt="">{% endif %}
```

Imagens do schema já chegam como **URL pronta** — não passe por `cdn_url`.

## `user`, `customer`, `logged_in`

| Global | Tipo | Descrição |
| - | - | - |
| `logged_in` | bool | Cliente autenticado? |
| `customer` | objeto? | `id`, `name`, `avatar_url`, `initial`, `email`?, `discord_id`? |
| `user` | objeto? | O mesmo que `customer`, mais `avatar` (= `avatar_url`) |

`user`/`customer` são `null` sem login; `email` e `discord_id` ficam ausentes quando vazios.

```liquid theme={null}
{% if logged_in %}Olá, {{ user.name }}{% else %}<a href="/login">Entrar</a>{% endif %}
```

## `categories` e `category`

`categories` é a árvore de categorias (2 níveis); `category` é a categoria atual na página
de coleção.

| Campo | Descrição |
| - | - |
| `id`, `name`, `slug`, `emoji`, `parent_id` | Identificação |
| `image`, `banner`, `image_url`, `banner_url`, `icon_url` | Imagens prontas (ver [Imagens](https://allbay.mintlify.site/editor/imagens.md)) |
| `product_count` / `packages_count` | Quantidade de produtos |
| `sub_categories[]` | Subcategorias |
| `products[]` | Produtos (cards) — preenchido só nas **24 primeiras** categorias, até 50 cada |
| `hide_category`, `hide_subcategory`, `display_limit` | Opções de exibição |

> [!NOTE]
>
> Se houver produtos sem categoria, aparece no fim uma categoria **"Todos"** (`slug: "todos"`).

## Produtos: `products`, `packages`, `product`

* `products` — **lista** de produtos (cards).
* `packages` — **envelope** `{ data: [...], size, total }` com a mesma lista.
* `product` / `package` — o produto da página de produto (mesmo objeto).

Com dados em: home, `/products` e busca (até **100** produtos) e coleção (até **50**), sem
paginação no servidor.

**Card de produto** (`products`, `packages.data`, `category.products`):

| Campo | Tipo | |
| - | - | - |
| `id`, `name`, `slug` | string | |
| `description` | resumo curto | |
| `price`, `comparison_price` | número (em reais, para \` | money\`) |
| `pricing` | `{ price, min, compare_at, percent_discount }` | |
| `stock` | `{ quantity, available, min_amount }` (`quantity` é `null` se ilimitado) | |
| `available`, `stock_count`, `stock_unlimited` | estoque simplificado | |
| `image`, `banner`, `image_url`, `banner_url` | imagem pronta | |
| `has_variants`, `is_auto_delivery`, `sales_count` | — | |
| `feedback_stats` | `{ average, total }` ou `null` | |
| `category_ids` | categorias do produto | |

**Produto completo** (`product` / `package`, só na página de produto) — tudo do card, mais:

| Campo | Tipo |
| - | - |
| `description`, `short_description` | HTML / texto |
| `gallery[]`, `images[]` | imagens (podem conter **vídeo**) |
| `variants[]`, `default_variant` | variações |
| `variables[]` (alias `fields[]`) | campos de checkout do produto |
| `auto_deliver` | bool |

## `socials` e `gateways`

* `socials` — todas as redes, `null` quando não configurada: `instagram`, `discord`,
  `youtube`, `twitter`, `facebook`, `tiktok`, `whatsapp`, `telegram`.
* `gateways` — métodos de pagamento **disponíveis agora** na loja. Campos: `name` (`PIX` ou `CREDITCARD`), `display`, `method`, `provider`, `fee`, `fee_percent`, `fee_fixed`, `is_percentage_fee`, `require_document`, `require_address`, `require_phone`, `max_installments`.

```liquid theme={null}
{% assign pix = gateways | where: "name", "PIX" | first %}
```

## Rotas específicas

| Global | Onde tem dados |
| - | - |
| `sections`, `showcase`, `recent_feedbacks` | home |
| `collection` (`{ handle }`), `active_filters` | coleção |
| `cart` (`{ items, items_count, total }`, vazio no servidor; o SDK preenche no navegador) | `/checkout` |
| `order`, `allowed`, `order_feedback`, `chat_delivery` | pedido e pagamento |
| `orders` (`{ data, meta }`) | `/account/*` |
| `posts` (`{ data, meta }`) | `/blog` |
| `post` | `/post/:slug` |
| `terms` (HTML ou `null`) | todas |

**`order`:** `status` (`APPROVED`, `PENDING`, `REJECTED`, `CANCELED`, `REFUNDED`,
`CHARGEDBACK`), `price`, `price_display`, `gateway`, `gateway_display`, `pix_code`,
`qr_code` (imagem SVG em data-URI), `packages[]`, `deliveries[]`, `client_name`,
`client_email`, `promo_code`, `created_at`, `access_token`.

**`posts`:** `{ data, meta }`, com `meta` = `total`, `per_page`, `current_page`, `last_page`, `first_page`, `next_page_url`, `previous_page_url`. **`post`:** `title`, `slug`, `content` (HTML),
`image`, `excerpt`, `author`, `reading_time`, `published_at` (data por extenso, pt-BR) e
`published_at_iso`.

## Requisição

* `query` — parâmetros da URL (`query.page`, …; o primeiro valor de cada chave).
* `pathname` — o caminho **canônico** da página (ex.: `/collections/x` mesmo que o
  visitante tenha aberto `/category/x`; `/404` na página de erro).

## Scripts e estilos da plataforma

O SDK da AllBay é **injetado automaticamente** em toda página. Se quiser controlar a posição:

```liquid theme={null}
<link rel="stylesheet" href="{{ allbay_style }}">
<script src="{{ allbay_script }}"></script>
```

Para o CSS do Tailwind do tema, use a tag [`{% tailwindcss %}`](https://allbay.mintlify.site/editor/tags#tailwindcss).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.