Ereemby

https://ereemby.com/
Admin
Ereemby is an e-commerce platform that enables users to quickly set up and manage online stores with...
Tokens:84,184
Snippets:741
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install dependencies

Source: https://ereemby.gitbook.io/docs/desenvolvedores/webhooks.md

Initialize a Node.js project and install the Express framework.

```bash
npm init -y
npm i express
```

--------------------------------

### Run and expose server

Source: https://ereemby.gitbook.io/docs/desenvolvedores/webhooks.md

Commands to start the local server and expose it to the internet using ngrok.

```bash
node server.js
```

```bash
ngrok http 3000
```

--------------------------------

### Render product card

Source: https://ereemby.gitbook.io/docs/sistema-de-temas/variaveis/catalog/products.md

Example of rendering a product card with name and price within a loop.

```liquid
{% for product in catalog.products %}
  <article class="produto">
    <h3>{{ product.name }}</h3>
    <p>R$ {{ product.price }}</p>
  </article>
{% endfor %}
```

--------------------------------

### Query documentation via HTTP GET

Source: https://ereemby.gitbook.io/docs/llms.txt

Perform a targeted query by appending ask and goal parameters to a documentation URL.

```http
GET https://ereemby.gitbook.io/docs/informacoes-gerais/aplicativo.md?ask=<question>&goal=<end_goal>
```

--------------------------------

### GET /product/{productId}

Source: https://ereemby.gitbook.io/docs/desenvolvedores/documentacao-api-publica/gestao-de-catalogo/produtos.md

Consulta os detalhes de um produto específico.

```APIDOC
## GET /product/{productId}

### Description
Consulta os detalhes de um produto específico.

### Method
GET

### Endpoint
https://api.ereemby.app/api/v1/product/{productId}
```

--------------------------------

### GET /product/catalog

Source: https://ereemby.gitbook.io/docs/desenvolvedores/documentacao-api-publica/gestao-de-catalogo.md

Retorna uma lista paginada de produtos, categorias ou variantes do catálogo.

```APIDOC
## GET /product/catalog

### Description
Retorna uma lista paginada de produtos, categorias ou variantes do catálogo.

### Method
GET

### Endpoint
https://api.ereemby.app/api/v1/product/catalog

### Parameters
#### Query Parameters
- **category** (string) - Optional - Filtra os produtos pelo ID de uma categoria específica.
- **type** (string) - Optional - Define o tipo de conteúdo retornado: `all` (tudo), `category` (só categorias), `products` (só produtos), `variants` (só variantes). Default: `all`.
- **page** (integer) - Optional - Número da página para paginação dos resultados. Default: 1.
- **search** (string) - Optional - Pesquisa produtos por nome (busca parcial).

### Response
#### Success Response (200)
- **CatalogResponse** (object) - Catálogo retornado com sucesso.

#### Error Response (401)
- **Unauthorized** - Header x-api-key ausente ou inválido.

#### Error Response (429)
- **RateLimit** - Limite de taxa excedido (2 req/s).
```

--------------------------------

### GET /product/{productId}

Source: https://ereemby.gitbook.io/docs/desenvolvedores/documentacao-api-publica/gestao-de-catalogo/produtos.md

Retorna os dados completos de um produto específico pelo seu ID. Requer autenticação via header x-api-key.

```APIDOC
## GET /product/{productId}

### Description
Retorna os dados completos de um produto específico pelo seu ID.

### Method
GET

### Endpoint
https://api.ereemby.app/api/v1/product/{productId}

### Parameters
#### Path Parameters
- **productId** (string) - Required - ID único do produto.

### Response
#### Success Response (200)
- **id** (string) - ID do produto
- **name** (string) - Nome do produto
- **description** (string) - Descrição do produto
- **price** (number) - Preço do produto
- **compare_price** (number) - Preço de comparação
- **image** (string) - URL da imagem
- **slug** (string) - Slug do produto
- **category_id** (string) - ID da categoria
- **status** (boolean) - Status do produto
- **automatic** (boolean) - Indica se é automático
- **stock** (integer) - Quantidade em estoque
- **created_at** (string) - Data de criação
- **updated_at** (string) - Data de atualização
```

--------------------------------

### GET /product/stock/{productId}

Source: https://ereemby.gitbook.io/docs/desenvolvedores/documentacao-api-publica/gestao-de-catalogo/gerenciamento-de-estoque.md

Retorna os itens de estoque associados a um produto específico.

```APIDOC
## GET /product/stock/{productId}

### Description
Retorna os itens de estoque associados a um produto específico.

### Method
GET

### Endpoint
/product/stock/{productId}

### Parameters
#### Path Parameters
- **productId** (string) - Required - ID do produto para buscar o estoque

### Response
#### Success Response (200)
- **estoque** (array) - Lista de itens de estoque do produto

#### Response Example
{
  "estoque": [
    {
      "id": "string",
      "estoque": "string"
    }
  ]
}
```

--------------------------------

### GET /product/catalog

Source: https://ereemby.gitbook.io/docs/desenvolvedores/documentacao-api-publica/gestao-de-catalogo.md

Recupera uma lista paginada de produtos, categorias ou variantes do catálogo da loja.

```APIDOC
## GET /product/catalog

### Description
Retorna uma lista paginada de produtos, categorias ou variantes do catálogo.

### Method
GET

### Endpoint
/product/catalog

### Parameters
#### Headers
- **x-api-key** (string) - Required - Chave de API gerada no painel da Ereemby.

### Response
#### Success Response (200)
- **categories** (array) - Lista de categorias do catálogo.
- **pagination** (object) - Informações de paginação.

#### Response Example
{
  "categories": [],
  "pagination": {}
}
```

--------------------------------

### GET /tags

Source: https://ereemby.gitbook.io/docs/desenvolvedores/documentacao-api-publica/tags.md

Lists all tags available in the store.

```APIDOC
## GET /tags

### Description
Listar tags.

### Method
GET

### Endpoint
https://api.ereemby.app/api/v1/tags
```

--------------------------------

### GET /tags

Source: https://ereemby.gitbook.io/docs/desenvolvedores/documentacao-api-publica/tags.md

Lista todas as tags da loja associadas à API key fornecida.

```APIDOC
## GET /tags

### Description
Lista todas as tags da loja da API key.

### Method
GET

### Endpoint
https://api.ereemby.app/api/v1/tags

### Response
#### Success Response (200)
- **tags** (array) - Lista de objetos Tag contendo id, name, color, icon, private_view_chat e add_to_chat.

#### Response Example
[
  {
    "id": 1,
    "name": "Promoção",
    "color": "#FF0000",
    "icon": null,
    "private_view_chat": false,
    "add_to_chat": true
  }
]
```

--------------------------------

### GET /products/{productId}/variants

Source: https://ereemby.gitbook.io/docs/desenvolvedores/documentacao-api-publica/gestao-de-catalogo/variantes.md

Retorna todas as variantes associadas a um produto específico.

```APIDOC
## GET /products/{productId}/variants

### Description
Retorna todas as variantes associadas a um produto.

### Method
GET

### Endpoint
https://api.ereemby.app/api/v1/products/{productId}/variants

### Parameters
#### Path Parameters
- **productId** (string) - Required - ID único do produto.

### Response
#### Success Response (200)
- **Variantes** (object) - Variantes retornadas com sucesso.
```

--------------------------------

### Iterar sobre coleções com for

Source: https://ereemby.gitbook.io/docs/sistema-de-temas/sintaxe-liquid-basica.md

Exemplo básico de como percorrer uma lista de produtos e exibir suas propriedades.

```liquid
{% for product in catalog.products %}
  <h3>{{ product.name }}</h3>
  <span>R$ {{ product.value }}</span>
{% endfor %}
```

--------------------------------

### Comandos de inicialização do Ereemby CLI

Source: https://ereemby.gitbook.io/docs/sistema-de-temas/editor-local.md

Comandos utilizados para instalar o CLI, autenticar o tema e baixar os arquivos do projeto para o ambiente local.

```bash
npm install ereemby-cli -g
ereemby login <token-do-tema>
ereemby pull
```

--------------------------------

### PUT /product/stock/{productId}

Source: https://ereemby.gitbook.io/docs/desenvolvedores/documentacao-api-publica/gestao-de-catalogo/gerenciamento-de-estoque.md

Atualiza completamente a lista de chaves de estoque de um produto, substituindo as existentes.

```APIDOC
## PUT /product/stock/{productId}

### Description
Atualiza completamente a lista de chaves de estoque de um produto, substituindo as existentes.

### Method
PUT

### Endpoint
/product/stock/{productId}

### Parameters
#### Path Parameters
- **productId** (string) - Required - ID do produto para atualizar o estoque

#### Request Body
- **id** (string) - Required - O identificador único do produto.
- **stock** (array) - Required - Uma lista de chaves ou códigos de estoque (ex: licenças, seriais, etc) para associar ao produto.

### Response
#### Success Response (200)
- **estoques** (array) - Lista de itens de estoque atualizados.
```

--------------------------------

### Expor API Local com ngrok

Source: https://ereemby.gitbook.io/docs/informacoes-gerais/notificacoes/notificacoes-de-vendas-proprio.md

Comando para expor o servidor local na porta 3000 para a internet, permitindo o recebimento de webhooks durante o desenvolvimento.

```bash
ngrok http 3000
```

--------------------------------

### GET /product/variant/stock/{variantId}

Source: https://ereemby.gitbook.io/docs/desenvolvedores/documentacao-api-publica/gestao-de-catalogo/gerenciamento-de-estoque.md

Retorna os itens de estoque associados a uma variante específica.

```APIDOC
## GET /product/variant/stock/{variantId}

### Description
Retorna os itens de estoque associados a uma variante específica.

### Method
GET

### Endpoint
/product/variant/stock/{variantId}

### Parameters
#### Path Parameters
- **variantId** (string) - Required - ID da variante para buscar o estoque

### Response
#### Success Response (200)
- **estoque** (array) - Lista de itens de estoque da variante

#### Response Example
{
  "estoque": [
    {
      "id": "string",
      "produto": "string",
      "tipo": "string",
      "estoque": "string",
      "pos": 0,
      "createdAt": "2023-01-01T00:00:00Z",
      "updatedAt": "2023-01-01T00:00:00Z"
    }
  ]
}
```

--------------------------------

### Listar variantes de um produto

Source: https://ereemby.gitbook.io/docs/sistema-de-temas/variaveis/catalog/variants.md

Exemplo básico para iterar sobre os produtos e suas respectivas variantes.

```liquid
{% for product in catalog.products %}
  <h3>{{ product.name }}</h3>
  <ul>
    {% for variant in product.variants %}
      <li>{{ variant.name }}, R$ {{ variant.price }}</li>
    {% endfor %}
  </ul>
{% endfor %}
```

--------------------------------

### GET /docs/informacoes-gerais/aplicativo.md

Source: https://ereemby.gitbook.io/docs/llms.txt

Performs a query against the documentation index to retrieve an answer based on a natural language question.

```APIDOC
## GET /docs/informacoes-gerais/aplicativo.md

### Description
Perform an HTTP GET request on the documentation index with the `ask` parameter, and the optional `goal` parameter to retrieve a direct answer and relevant excerpts.

### Method
GET

### Endpoint
https://ereemby.gitbook.io/docs/informacoes-gerais/aplicativo.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to tailor the answer.
```

--------------------------------

### GET /api/v1/bot

Source: https://ereemby.gitbook.io/docs/desenvolvedores/documentacao-api-publica/bot-de-suporte.md

Recupera uma lista de todos os bots associados à conta.

```APIDOC
## GET /api/v1/bot

### Description
Lista todos os bots configurados.

### Method
GET

### Endpoint
/api/v1/bot

### Response
#### Success Response (200)
- **bots** (array) - Lista de objetos contendo os bots.

#### Response Example
{
  "bots": [
    {
      "id": "uuid",
      "name": "string",
      "icon": "uri",
      "createdAt": "date-time"
    }
  ]
}
```

--------------------------------

### Exibir informações básicas do produto

Source: https://ereemby.gitbook.io/docs/sistema-de-temas/variaveis/product.md

Exemplo básico de renderização de nome, preço e estoque do produto.

```liquid
<h1>{{ product.name }}</h1>
<p>R$ {{ product.price }}</p>
<p>{{ product.stock_amount }} em estoque</p>
```

--------------------------------

### Configurar servidor MCP no Codex CLI e IDE

Source: https://ereemby.gitbook.io/docs/desenvolvedores/mcp.md

Adiciona o servidor ao arquivo de configuração TOML do Codex, habilitando o suporte a servidores remotos.

```toml
[features]
experimental_use_rmcp_client = true

[mcp_servers.ereemby_docs]
url = "https://ereemby.gitbook.io/docs/~gitbook/mcp"
```

--------------------------------

### POST /product/stock/{productId}

Source: https://ereemby.gitbook.io/docs/desenvolvedores/documentacao-api-publica/gestao-de-catalogo/gerenciamento-de-estoque.md

Adiciona novas chaves de estoque a um produto existente, sem remover as atuais.

```APIDOC
## POST /product/stock/{productId}

### Description
Adiciona novas chaves de estoque a um produto existente, sem remover as atuais.

### Method
POST

### Endpoint
/product/stock/{productId}

### Parameters
#### Path Parameters
- **productId** (string) - Required - ID do produto para adicionar estoque

#### Request Body
- **id** (string) - Required - O identificador único do produto.
- **stock** (array) - Required - Uma lista de chaves ou códigos de estoque (ex: licenças, seriais, etc) para associar ao produto.

### Request Example
{
  "id": "prod_123",
  "stock": ["key_001", "key_002"]
}

### Response
#### Success Response (200)
- **estoques** (array) - Lista de itens de estoque atualizados.
- **total** (integer) - Total de itens de estoque.

#### Response Example
{
  "estoques": [
    {
      "id": "stock_item_1",
      "produto": "prod_123",
      "estoque": "key_001",
      "pos": 1,
      "updatedAt": "2023-10-27T10:00:00Z",
      "createdAt": "2023-10-27T10:00:00Z"
    }
  ],
  "total": 1
}
```

--------------------------------

### GET /api/v1/sale

Source: https://ereemby.gitbook.io/docs/desenvolvedores/documentacao-api-publica/vendas.md

Recupera os detalhes de uma venda específica através do seu identificador único.

```APIDOC
## GET /api/v1/sale

### Description
Retorna os detalhes de uma venda específica.

### Method
GET

### Endpoint
/api/v1/sale

### Parameters
#### Query Parameters
- **id** (string) - Required - ID da venda

### Response
#### Success Response (200)
- **id** (string) - ID da venda
- **nome** (string) - Nome do produto
- **quantidade** (integer) - Quantidade vendida
- **total** (number) - Valor total da venda
- **metodo** (string) - Método de pagamento
- **status** (string) - Status da venda
- **qr** (string) - Base64 do QRCode
- **copiaecola** (string) - Código copia e cola do pagamento
- **email** (string) - Email do cliente
- **createdAt** (string) - Data de criação
```

--------------------------------

### Exemplos de uso da função

Source: https://ereemby.gitbook.io/docs/sistema-de-temas/funcoes/feedbacks.md

Exemplos práticos de como chamar a função com diferentes configurações de filtros.

```js
const feedbacks = await getFeedbacksPaginationRequest({
    page: 2,
    order: 'recent'
})
```

```js
const feedbacks = await getFeedbacksPaginationRequest({
    page: 1,
    star: 5,
    order: 'old',
    comment: true
})
```

--------------------------------

### Consultar catálogo via cURL

Source: https://ereemby.gitbook.io/docs/desenvolvedores/documentacao-api-publica/gestao-de-catalogo.md

Exemplo de requisição GET para o endpoint de catálogo utilizando a chave de API no cabeçalho.

```bash
curl -sS \
  -H "x-api-key: SUA_CHAVE_DE_API" \
  "https://api.ereemby.app/api/v1/product/catalog"
```

--------------------------------

### Implementar WhatsApp robusto

Source: https://ereemby.gitbook.io/docs/sistema-de-temas/variaveis/social.md

Padrão que aceita tanto números puros quanto URLs completas, garantindo a formatação correta do link.

```liquid
{% if social.whatsapp %}
  {% assign wpp = social.whatsapp %}
  {% if wpp contains 'wa.me' or wpp contains 'http' %}
    <a href="{{ wpp }}" target="_blank">WhatsApp</a>
  {% else %}
    <a href="https://wa.me/{{ wpp }}" target="_blank">WhatsApp</a>
  {% endif %}
{% endif %}
```

--------------------------------

### Iterate over catalog products

Source: https://ereemby.gitbook.io/docs/sistema-de-temas/variaveis/catalog/products.md

Basic loop to display product names from the catalog.

```liquid
{% for product in catalog.products %}
  {{ product.name }}
{% endfor %}
```

--------------------------------

### GET /api/v1/sales

Source: https://ereemby.gitbook.io/docs/desenvolvedores/documentacao-api-publica/vendas.md

Retorna uma lista paginada de vendas com filtros opcionais para busca, status, período e origem.

```APIDOC
## GET /api/v1/sales

### Description
Retorna uma lista de vendas com filtros opcionais.

### Method
GET

### Endpoint
/api/v1/sales

### Parameters
#### Query Parameters
- **page** (integer) - Required - Número da página (sempre maior ou igual a 1)
- **search** (string) - Optional - Filtrar por nome do produto ou nome do cliente
- **status** (string) - Optional - Status do pedido: s (Aprovado), p (Pendente), r (Reembolso), semestoque (Produto sem estoque)
- **order** (string) - Optional - Campo para ordenação (ex: createdAt)
- **start** (string) - Optional - Data de início (ISO 8601)
- **end** (string) - Optional - Data de fim (ISO 8601)
- **coupon** (string) - Optional - Filtrar por nome do cupom
- **affiliate** (string) - Optional - Filtrar por ID do afiliado
- **method** (string) - Optional - Método de pagamento (pix, card, ltc)
- **utm** (string) - Optional - Filtrar por UTM source da campanha

### Response
#### Success Response (200)
- **totalItens** (integer) - Total de itens encontrados
- **totalPaginas** (integer) - Total de páginas disponíveis
- **paginaAtual** (integer) - Página atual
- **itens** (array) - Lista de vendas
```

--------------------------------

### Configurar servidor MCP no Cursor

Source: https://ereemby.gitbook.io/docs/desenvolvedores/mcp.md

Adiciona o servidor ao arquivo de configuração JSON do Cursor, podendo ser global ou por projeto.

```json
{
  "mcpServers": {
    "ereemby-docs": {
      "url": "https://ereemby.gitbook.io/docs/~gitbook/mcp"
    }
  }
}
```

--------------------------------

### Exemplo completo de configuração de tema

Source: https://ereemby.gitbook.io/docs/sistema-de-temas/checkout.md

Estrutura JSON completa contendo todas as definições de estilo, cores, tipografia e animações para o checkout.

```json
{
  "header": {
    "logo": null,
    "alignment": "left"
  },
  "colors": {
    "background": "#08090B",
    "container": "#0D0E11",
    "accent": "#ffba09",
    "border": "#1B1B20",
    "title": "#f1f5f9",
    "paragraph": "#8A8A8A",
    "error": "#ff493f",
    "pending": "#ffba09",
    "success": "#21c985"
  },
  "buttons": {
    "background": "#f1f5f9",
    "text": "#070707",
    "border": "transparent"
  },
  "inputs": {
    "background": "#0D0E11",
    "border": "#1B1B20",
    "borderFocus": "#ffba09",
    "text": "#f1f5f9",
    "placeholder": "#8A8A8A"
  },
  "typography": {
    "headings": "Inter",
    "body": "Inter",
    "sizeGeneral": 0,
    "sizeTitle": 0,
    "sizeBody": 0,
    "titleWeight": 500,
    "titleSpacing": 0,
    "bodyWeight": 400,
    "bodySpacing": 0,
    "ctaTransform": "normal"
  },
  "animations": {
    "entrance": {
      "preset": "none",
      "duration": 500,
      "easing": "ease-out",
      "stagger": 60
    },
    "buttonHover": {
      "preset": "none",
      "intensity": 50,
      "duration": 200
    },
    "cardHover": {
      "preset": "none",
      "intensity": 50,
      "duration": 200
    }
  },
  "background": {
    "type": "solid",
    "solid": "#08090B",
    "gradient": {
      "rotation": 135,
      "stops": ["#08090B", "#1B1B20"]
    },
    "orbs": {
      "baseColor": "#08090B",
      "items": [
        { "color": "#ffba09", "position": "top-left", "size": 55, "blur": 70 },
        { "color": "#3e81ed", "position": "bottom-right", "size": 55, "blur": 70 }
      ]
    },
    "image": {
      "url": null,
      "fit": "cover",
      "position": "center",
      "repeat": false,
      "opacity": 100,
      "blur": 0
    },
    "overlay": 0,
    "vignette": 0,
    "grain": 0
  },
  "options": {
    "showStoreName": true,
    "showSecurityMessage": false,
    "showFooter": false,
    "showFieldsPopup": true
  }
}
```

--------------------------------

### Exemplo básico de uso da variável dates

Source: https://ereemby.gitbook.io/docs/sistema-de-temas/variaveis/dates.md

Exibe a data e hora atual utilizando campos individuais da variável.

```liquid
Hoje é {{ dates.day }}/{{ dates.month }}/{{ dates.year }} às {{ dates.time.hours }}:{{ dates.time.minutes }}.
```

```html
Hoje é 14/5/2026 às 13:24.
```

--------------------------------

### Exibir instruções pós-compra

Source: https://ereemby.gitbook.io/docs/sistema-de-temas/variaveis/product.md

Renderiza o conteúdo das instruções de entrega caso existam no objeto do produto.

```liquid
{% if product.instructions %}
  <section class="produto-instrucoes">
    <h3>Como funciona a entrega</h3>
    <div class="instrucoes-conteudo">
      {{ product.instructions }}
    </div>
  </section>
{% endif %}
```

--------------------------------

### Implementar página de produto com Liquid

Source: https://ereemby.gitbook.io/docs/sistema-de-temas/visao-geral.md

Exemplo de exibição de detalhes de produto, incluindo imagem, preço formatado e botão de compra condicional ao estoque.

```liquid
{% comment %} Hero da página de produto, usa a variável `product` {% endcomment %}
<section class="produto-hero">
  {% if product.images.size > 0 %}
    <img src="{{ product.images[0] }}" alt="{{ product.name }}">
  {% endif %}

  <h1>{{ product.name }}</h1>

  <p class="preco">
    R$ {{ product.price | round: 2 | replace: ".", "," }}
  </p>

  {% if product.stock_amount > 0 %}
    <button>Comprar</button>
  {% else %}
    <button disabled>Esgotado</button>
  {% endif %}
</section>
```

--------------------------------

### Comando de envio de alterações

Source: https://ereemby.gitbook.io/docs/sistema-de-temas/editor-local.md

Utilize este comando para publicar as alterações realizadas localmente no tema da plataforma.

```bash
ereemby push
```

--------------------------------

### Disparar evento addToWishlist

Source: https://ereemby.gitbook.io/docs/sistema-de-temas/funcoes/events.md

Utilize este evento para registrar quando um cliente adiciona um item à lista de desejos.

```javascript
erbyEvent({
    event_type: 'addToWishlist',
    products: [{
        id: string,
        name: string,
        price: number,
        quantity: number
    }]
})
```

```javascript
erbyEvent({
    event_type: 'addToWishlist',
    products: [{
        id: '17811305744281024988111941416',
        name: 'Mockup Premium',
        price: 129.90,
        quantity: 1
    }]
})
```

--------------------------------

### Renderizar card de produto completo

Source: https://ereemby.gitbook.io/docs/sistema-de-temas/variaveis/catalog/products.md

Exibe informações básicas do produto, incluindo imagem, nome, preço e botão de compra condicional ao estoque.

```liquid
{% for product in catalog.products %}
  <article class="produto-card">
    {% if product.images.size > 0 %}
      <img src="{{ product.images[0] }}" alt="{{ product.name }}">
    {% endif %}

    <h3>{{ product.name }}</h3>
    <p class="preco">R$ {{ product.price }}</p>

    {% if product.stock_amount > 0 %}
      <button>Comprar</button>
    {% else %}
      <button disabled>Esgotado</button>
    {% endif %}
  </article>
{% endfor %}
```

--------------------------------

### Controlar loops com break e continue

Source: https://ereemby.gitbook.io/docs/sistema-de-temas/sintaxe-liquid-basica.md

Uso de diretivas de controle para pular iterações ou encerrar o loop prematuramente.

```liquid
{% for product in catalog.products %}
  {% if product.stock_amount == 0 %}{% continue %}{% endif %}
  {% if forloop.index > 10 %}{% break %}{% endif %}
  {{ product.name }}
{% endfor %}
```

--------------------------------

### Exibir preço a partir de

Source: https://ereemby.gitbook.io/docs/sistema-de-temas/variaveis/product.md

Calcula e exibe o preço da variante mais barata disponível utilizando ordenação.

```liquid
{% if product.variants.size > 0 %}
  {% assign mais_barata = product.variants | sort: "price" | first %}
  <p class="preco-a-partir">
    A partir de
    <strong>R$ {{ mais_barata.price }}</strong>
    ({{ mais_barata.name }})
  </p>
{% endif %}
```

--------------------------------

### Exemplo básico de Liquid

Source: https://ereemby.gitbook.io/docs/sistema-de-temas/sintaxe-liquid-basica.md

Demonstra a combinação de impressão de variáveis e lógica condicional básica.

```liquid
Olá, {{ user.name }}! Bem-vindo à {{ store.name }}.
{% if catalog.products.size > 0 %}
  Temos {{ catalog.products.size }} produtos disponíveis.
{% endif %}
```

--------------------------------

### PUT /product/variant/stock/{variantId}

Source: https://ereemby.gitbook.io/docs/desenvolvedores/documentacao-api-publica/gestao-de-catalogo/gerenciamento-de-estoque.md

Atualiza completamente a lista de chaves de estoque de uma variante, substituindo as existentes.

```APIDOC
## PUT /product/variant/stock/{variantId}

### Description
Atualiza completamente a lista de chaves de estoque de uma variante, substituindo as existentes.

### Method
PUT

### Endpoint
/product/variant/stock/{variantId}

### Parameters
#### Path Parameters
- **variantId** (string) - Required - ID da variante para atualizar o estoque

#### Request Body
- **id** (string) - Required - O identificador único da variante.
- **stock** (array) - Required - Uma lista de chaves ou códigos de estoque para associar à variante.

### Response
#### Success Response (200)
- **estoques** (array) - Lista de itens de estoque atualizados.
```

--------------------------------

### Configurar servidor MCP no Zed

Source: https://ereemby.gitbook.io/docs/desenvolvedores/mcp.md

Adiciona o servidor ao arquivo de configuração do Zed, utilizando npx para compatibilidade ou URL nativa.

```json
{
  "context_servers": {
    "ereemby-docs": {
      "source": "custom",
      "command": "npx",
      "args": ["-y", "mcp-remote", "https://ereemby.gitbook.io/docs/~gitbook/mcp"]
    }
  }
}
```

```json
{
  "context_servers": {
    "ereemby-docs": {
      "url": "https://ereemby.gitbook.io/docs/~gitbook/mcp"
    }
  }
}
```

--------------------------------

### Inserir lista de produtos ou categorias

Source: https://ereemby.gitbook.io/docs/desenvolvedores/editor-html/componentes.md

Renderiza produtos ou categorias vinculados à página atual. Utilize em vitrines ou páginas de coleção.

```html
<div id="COMPONENT_PRODUCTS_CARDS"></div>
```

--------------------------------

### Renderizar card de categoria com ícone e contagem

Source: https://ereemby.gitbook.io/docs/sistema-de-temas/variaveis/catalog/categories.md

Exibe um link para a categoria contendo seu ícone, nome e a quantidade de produtos associados.

```liquid
{% for category in catalog.categories %}
  <a href="/categoria/{{ category.slug }}" class="categoria-card">
    {% if category.icon %}
      <img src="{{ category.icon }}" alt="{{ category.name }}">
    {% endif %}
    <h3>{{ category.name }}</h3>
    <span>{{ category.products.size }} produtos</span>
  </a>
{% endfor %}
```

--------------------------------

### Definição OpenAPI para Criação de Produto

Source: https://ereemby.gitbook.io/docs/desenvolvedores/documentacao-api-publica/gestao-de-catalogo/produtos.md

Especificação completa da rota de criação de produtos, incluindo esquemas de dados e requisitos de autenticação via x-api-key.

```json
{"openapi":"3.0.0","info":{"title":"Gestão de Catálogo API","version":"1.0.0"},"servers":[{"url":"https://api.ereemby.app/api/v1","description":"Servidor de Produção"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"Chave de API gerada no painel da Ereemby. Deve ser enviada no header x-api-key em todas as requisições."}},"schemas":{"ProductCreate":{"type":"object","required":["name","price","min","description","type","category_id"],"properties":{"name":{"type":"string","description":"Nome do produto."},"price":{"type":"number","description":"Preço de venda do produto."},"compare_price":{"type":"number","description":"Preço original (riscado), para exibição comparativa."},"description":{"type":"string","description":"Descrição HTML do produto."},"category_id":{"type":"string","description":"ID da categoria à qual o produto pertence."},"status":{"type":"boolean","description":"Define se o produto está visível no catálogo."},"featured":{"type":"boolean","description":"Marca o produto como destaque."},"type":{"type":"string","description":"Tipo de entrega do produto: series (estoque em linhas) ou texto (um único texto sempre enviado ao cliente).","enum":["series","texto"]},"min":{"type":"integer","description":"Quantidade mínima por pedido."},"max":{"type":"integer","description":"Quantidade máxima por pedido."},"stock":{"type":"array","description":"Lista de itens em estoque (para entrega automática).","items":{"type":"string"}},"automatic":{"type":"boolean","description":"Ativa a entrega automática do produto."},"quantity":{"type":"integer","description":"Quantidade em estoque (para produtos com estoque numérico)."},"slug":{"type":"string","description":"Slug único para URL do produto. Se vazio, é gerado automaticamente."},"youtube":{"type":"string","description":"URL do vídeo do YouTube associado ao produto."},"images":{"type":"array","description":"Lista de URLs de imagens adicionais do produto.","items":{"type":"string"}},"open_chat":{"type":"boolean","description":"Abre o chat automaticamente ao adicionar ao carrinho."},"instructions":{"type":"string","description":"Instruções de uso entregues ao comprador."},"affiliate_fee":{"type":"number","description":"Comissão de afiliado em porcentagem."},"hide_when_out_of_stock":{"type":"boolean","description":"Oculta o produto quando o estoque zerar."},"hide_sold_count":{"type":"boolean","description":"Oculta o contador de vendas exibido no produto."}}},"Error":{"type":"object","properties":{"error":{"type":"string"}}}},"responses":{"Unauthorized":{"description":"Não autorizado: o header x-api-key está ausente ou inválido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"RateLimit":{"description":"Muitas requisições - limite de taxa excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"paths":{"/product":{"post":{"tags":["Produtos"],"summary":"Criar produto","description":"Cria um novo produto no catálogo. Os campos name, price, min, description, type e category_id são obrigatórios.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductCreate"}}}},"responses":{"201":{"description":"Produto criado com sucesso.","content":{"application/json":{}}},"400":{"description":"Erro de validação - dados inválidos ou conflito com registro existente.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"429":{"$ref":"#/components/responses/RateLimit"}}}}}}
```

--------------------------------

### Implementar cabeçalho global com Liquid

Source: https://ereemby.gitbook.io/docs/sistema-de-temas/visao-geral.md

Exemplo de estrutura de cabeçalho utilizando variáveis de loja, saudação condicional baseada em horário, navegação de catálogo e links de autenticação.

```liquid
<header class="site-header">
  {% comment %} Logo e nome da loja {% endcomment %}
  <a href="/" class="logo-area">
    {% if store.icon %}
      <img src="{{ store.icon }}" alt="{{ store.name }}">
    {% else %}
      <span>{{ store.name }}</span>
    {% endif %}
  </a>

  {% comment %} Saudação personalizada por horário e usuário {% endcomment %}
  <div class="saudacao">
    {% assign cumprimento = "Bom dia" %}
    {% if dates.time.hours >= 12 and dates.time.hours < 18 %}
      {% assign cumprimento = "Boa tarde" %}
    {% elsif dates.time.hours >= 18 %}
      {% assign cumprimento = "Boa noite" %}
    {% endif %}

    {{ cumprimento }}, {{ user.name | default: "visitante" }}!
  </div>

  {% comment %} Menu com categorias do catálogo {% endcomment %}
  <nav>
    {% for category in catalog.categories %}
      <a href="/categoria/{{ category.slug }}">{{ category.name }}</a>
    {% endfor %}
  </nav>

  {% comment %} Login ou conta {% endcomment %}
  {% if user.name %}
    <a href="/conta">Minha conta</a>
  {% else %}
    <a href="/login">Entrar</a>
  {% endif %}
</header>
```

--------------------------------

### POST /product

Source: https://ereemby.gitbook.io/docs/desenvolvedores/documentacao-api-publica/gestao-de-catalogo/produtos.md

Cria um novo produto no catálogo. Os campos name, price, min, description, type e category_id são obrigatórios.

```APIDOC
## POST /product

### Description
Cria um novo produto no catálogo. Os campos name, price, min, description, type e category_id são obrigatórios.

### Method
POST

### Endpoint
https://api.ereemby.app/api/v1/product

### Request Body
- **name** (string) - Required - Nome do produto.
- **price** (number) - Required - Preço de venda do produto.
- **min** (integer) - Required - Quantidade mínima por pedido.
- **description** (string) - Required - Descrição HTML do produto.
- **type** (string) - Required - Tipo de entrega do produto: series ou texto.
- **category_id** (string) - Required - ID da categoria à qual o produto pertence.
- **compare_price** (number) - Optional - Preço original (riscado), para exibição comparativa.
- **status** (boolean) - Optional - Define se o produto está visível no catálogo.
- **featured** (boolean) - Optional - Marca o produto como destaque.
- **max** (integer) - Optional - Quantidade máxima por pedido.
- **stock** (array) - Optional - Lista de itens em estoque.
- **automatic** (boolean) - Optional - Ativa a entrega automática do produto.
- **quantity** (integer) - Optional - Quantidade em estoque.
- **slug** (string) - Optional - Slug único para URL do produto.
- **youtube** (string) - Optional - URL do vídeo do YouTube associado ao produto.
- **images** (array) - Optional - Lista de URLs de imagens adicionais.
- **open_chat** (boolean) - Optional - Abre o chat automaticamente ao adicionar ao carrinho.
- **instructions** (string) - Optional - Instruções de uso entregues ao comprador.
- **affiliate_fee** (number) - Optional - Comissão de afiliado em porcentagem.
- **hide_when_out_of_stock** (boolean) - Optional - Oculta o produto quando o estoque zerar.
- **hide_sold_count** (boolean) - Optional - Oculta o contador de vendas exibido no produto.

### Response
#### Success Response (201)
- Produto criado com sucesso.
```

--------------------------------

### Renderizar árvore de categorias até 3 níveis

Source: https://ereemby.gitbook.io/docs/sistema-de-temas/variaveis/catalog/categories_all.md

Exemplo de renderização manual de hierarquia, dado que o Liquid não suporta recursão nativa.

```liquid
<ul class="arvore">
  {% for n1 in catalog.categories_all %}
    {% if n1.parent_category == nil %}
      <li>
        {{ n1.name }}

        {% if n1.sub_categories.size > 0 %}
          <ul>
            {% for n2 in n1.sub_categories %}
              <li>
                {{ n2.name }}

                {% if n2.sub_categories.size > 0 %}
                  <ul>
                    {% for n3 in n2.sub_categories %}
                      <li>{{ n3.name }}</li>
                    {% endfor %}
                  </ul>
                {% endif %}
              </li>
            {% endfor %}
          </ul>
        {% endif %}
      </li>
    {% endif %}
  {% endfor %}
</ul>
```

--------------------------------

### POST /categories

Source: https://ereemby.gitbook.io/docs/desenvolvedores/documentacao-api-publica/gestao-de-catalogo/categorias.md

Cria uma nova categoria no catálogo. Requer autenticação via header x-api-key.

```APIDOC
## POST /categories

### Description
Cria uma nova categoria no catálogo. Apenas o campo `name` é obrigatório.

### Method
POST

### Endpoint
/categories

### Request Body
- **name** (string) - Required - Nome da categoria
- **slug** (string) - Optional - Slug da categoria
- **pos** (integer) - Optional - Posição de ordenação da categoria
- **icon** (string) - Optional - Ícone da categoria
- **banner** (string) - Optional - Banner da categoria
- **parent_category** (string) - Optional - ID da categoria pai (para subcategorias)
- **is_private** (boolean) - Optional - Define se a categoria é visível apenas por link direto

### Response
#### Success Response (201)
- Categoria criada com sucesso.
```

--------------------------------

### Exemplo básico de saudação

Source: https://ereemby.gitbook.io/docs/sistema-de-temas/variaveis/user.md

Uso condicional da variável user para exibir uma saudação personalizada.

```liquid
{% if user.name %}
  Olá, {{ user.name }}!
{% else %}
  Olá, visitante!
{% endif %}
```

```html
Olá, João Silva!
```

```html
Olá, visitante!
```

--------------------------------

### Renderizar descrição rica do produto

Source: https://ereemby.gitbook.io/docs/sistema-de-temas/variaveis/product.md

Exibe a descrição do produto. Não utilize o filtro escape para garantir que as tags HTML sejam renderizadas corretamente.

```liquid
{% if product.description %}
  <section class="produto-descricao">
    <h2>Sobre o produto</h2>
    <div class="produto-descricao-conteudo">
      {{ product.description }}
    </div>
  </section>
{% endif %}
```

--------------------------------

### Consultar estoque de produto via cURL

Source: https://ereemby.gitbook.io/docs/desenvolvedores/documentacao-api-publica/gestao-de-catalogo/gerenciamento-de-estoque.md

Exemplo de requisição cURL para consultar o estoque de um produto específico.

```bash
curl -sS \
  -H "x-api-key: SUA_CHAVE_DE_API" \
  "https://api.ereemby.app/api/v1/product/stock/SEU_PRODUCT_ID"
```

--------------------------------

### Listar categorias com seus produtos

Source: https://ereemby.gitbook.io/docs/sistema-de-temas/variaveis/catalog/categories.md

Agrupa produtos dentro de seções baseadas em suas respectivas categorias.

```liquid
{% for category in catalog.categories %}
  <section class="categoria-bloco">
    <h2>{{ category.name }}</h2>
    {% if category.sub_title %}
      <p class="sub">{{ category.sub_title }}</p>
    {% endif %}

    <div class="produtos">
      {% for product in category.products %}
        <article>
          {% if product.images.size > 0 %}
            <img src="{{ product.images[0] }}" alt="{{ product.name }}">
          {% endif %}
          <h4>{{ product.name }}</h4>
          <p>R$ {{ product.price }}</p>
        </article>
      {% endfor %}
    </div>
  </section>
{% endfor %}
```
Tokens:
Raw