# products

O Objeto `products` é um array que disponibiliza informações de todos os produtos possíveis na página atual.&#x20;

Na pagina de categorias “catalog”, por exemplo contém somente os produtos da categoria determinada de acordo com os filtros aplicados, e na “search” contém os produtos de acordo com os critérios da busca e os filtros aplicados.

Para chamar produtos com critérios personalizados, veja a função [Products()](/themes/construindo-seu-template/referencias/funcoes/products.md).

{% hint style="warning" %}
**Disponível para uso nas páginas:** home | catalog | search
{% endhint %}

{% hint style="info" %}
**Para saber mais sobre como gerenciar produtos acesse:** [Cadastrar Produto](https://basedeconhecimento.tray.com.br/hc/pt-br/articles/6732451110171-Cadastrar-Produto)
{% endhint %}

### Atributos disponíveis​ <a href="#atributos-disponiveis" id="atributos-disponiveis"></a>

As requisições de produtos sempre retornarão um array de dados, portanto podem ser exibidos com a utilização de um índice determinado como nos atributos abaixo, ou quando iterados em um laço de repetição.

| Atributos                                 | Característica                                                                                                                                                                                                               |     |             |       |       |                |           |                  |              |                |                 |                     |     |                              |
| ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | ----------- | ----- | ----- | -------------- | --------- | ---------------- | ------------ | -------------- | --------------- | ------------------- | --- | ---------------------------- |
| `{{ products[0].id }}`                    | Identificador único do produto.                                                                                                                                                                                              |     |             |       |       |                |           |                  |              |                |                 |                     |     |                              |
| `{{ products[0].name }}`                  | Nome do produto.                                                                                                                                                                                                             |     |             |       |       |                |           |                  |              |                |                 |                     |     |                              |
| `{{ products[0].description_small }}`     | Retorna um texto com a uma descrição  [simplificada do produto.](https://basedeconhecimento.tray.com.br/hc/pt-br/articles/7114185489691-SEO-Otimiza%C3%A7%C3%A3o-de-Busca-por-Produto)                                       |     |             |       |       |                |           |                  |              |                |                 |                     |     |                              |
| `{{ products[0].category_id }}`           | Identificador único da Categoria Principal do Produto                                                                                                                                                                        |     |             |       |       |                |           |                  |              |                |                 |                     |     |                              |
| `{{ products[0].price }}`                 | Exibe o valor de venda configurado no produto.                                                                                                                                                                               |     |             |       |       |                |           |                  |              |                |                 |                     |     |                              |
| `{{ products[0].start_promotion }}`       | Exibe a data de inicio da promoção do produto.                                                                                                                                                                               |     |             |       |       |                |           |                  |              |                |                 |                     |     |                              |
| `{{ products[0].end_promotion }}`         | Exibe a data de término da promoção do produto.                                                                                                                                                                              |     |             |       |       |                |           |                  |              |                |                 |                     |     |                              |
| `{{ products[0].brand }}`                 | Exibe a marca do produto.                                                                                                                                                                                                    |     |             |       |       |                |           |                  |              |                |                 |                     |     |                              |
| `{{ products[0].model}}`                  | Exibe o modelo do produto.                                                                                                                                                                                                   |     |             |       |       |                |           |                  |              |                |                 |                     |     |                              |
| `{{ products[0].weight }}`                | Exibe o peso do produto em gramas.                                                                                                                                                                                           |     |             |       |       |                |           |                  |              |                |                 |                     |     |                              |
| `{{ products[0].length }}`                | Exibe o comprimento do produto em centímetros.                                                                                                                                                                               |     |             |       |       |                |           |                  |              |                |                 |                     |     |                              |
| `{{ products[0].width }}`                 | Exibe a largura do produto em centímetros.                                                                                                                                                                                   |     |             |       |       |                |           |                  |              |                |                 |                     |     |                              |
| `{{ products[0].height }}`                | Exibe a altura do produto em centímetros.                                                                                                                                                                                    |     |             |       |       |                |           |                  |              |                |                 |                     |     |                              |
| `{{ products[0].reference }}`             | Exibe o código de Referência do produto.                                                                                                                                                                                     |     |             |       |       |                |           |                  |              |                |                 |                     |     |                              |
| `{{ products[0].quantity_sold }}`         | Exibe a quantidade de produtos vendidos.                                                                                                                                                                                     |     |             |       |       |                |           |                  |              |                |                 |                     |     |                              |
| `{{ products[0].price_offer }}`           | Exibe o preço em promoção do produto.                                                                                                                                                                                        |     |             |       |       |                |           |                  |              |                |                 |                     |     |                              |
| `{{ products[0].show_price }}`            | <p>Existem regras na plataforma referente a exibição do preço.<br>Só exiba o preço se o <code>show\_price</code> for verdadeiro</p>                                                                                          |     |             |       |       |                |           |                  |              |                |                 |                     |     |                              |
| `{% if products[0].has_other_prices %}`   | Retorna se o produto possui outros preços                                                                                                                                                                                    |     |             |       |       |                |           |                  |              |                |                 |                     |     |                              |
| `{{ products[0].has_variation }}`         | Retorna o valor **1** caso o produto possua variações.                                                                                                                                                                       |     |             |       |       |                |           |                  |              |                |                 |                     |     |                              |
| `{{ product.variants }}`                  | <p>Retorna um array com todas as informações das variações, os índices retornados são:</p><p>id                                                                                                                              | ean | product\_id | price | stock | minimum\_stock | reference | start\_promotion | VariantImage | end\_promotion | payment\_option | illustrative\_image | Sku | payment\_option\_details</p> |
| `{{ products[0].payment }}`               | Retorna opões de parcelamento do produto                                                                                                                                                                                     |     |             |       |       |                |           |                  |              |                |                 |                     |     |                              |
| `{{ products[0].link }}`                  | Link para a página do produto                                                                                                                                                                                                |     |             |       |       |                |           |                  |              |                |                 |                     |     |                              |
| `{{ products[0].upon_request }}`          | Retorna se o produto está sob consulta                                                                                                                                                                                       |     |             |       |       |                |           |                  |              |                |                 |                     |     |                              |
| `{{ products[0].available }}`             | Retorna um valor booleano. Caso o produto esteja ativo para venda, exibe o valor **1**. A opção "Produto ativo - será exibido na loja para venda" no cadastro do produto tem que estar setada.                               |     |             |       |       |                |           |                  |              |                |                 |                     |     |                              |
| `{{ products[0].availability }}`          | Retorna o [Prazo de disponibilidade](https://basedeconhecimento.tray.com.br/hc/pt-br/articles/6735743602203-Prazo-de-Disponibilidade-para-Produtos) configurado para o produto.                                              |     |             |       |       |                |           |                  |              |                |                 |                     |     |                              |
| `{{ products[0].stock }}`                 | Quantidade de produtos em estoque.                                                                                                                                                                                           |     |             |       |       |                |           |                  |              |                |                 |                     |     |                              |
| `{% if products[0].featured %}`           | Retorna verdadeiro se for destaque                                                                                                                                                                                           |     |             |       |       |                |           |                  |              |                |                 |                     |     |                              |
| `{% if products[0].new %}`                | Retorna verdadeiro se for lançamento                                                                                                                                                                                         |     |             |       |       |                |           |                  |              |                |                 |                     |     |                              |
| `{% if products[0].free_shipping %}`      | Retorna verdadeiro se possuir frete grátis                                                                                                                                                                                   |     |             |       |       |                |           |                  |              |                |                 |                     |     |                              |
| `{{ products[0].additional_button }}`     | Retorna o valor **1** caso o produto **não** necessite de alguma seleção adicional para comprar. Não retornará nenhum valor para produtos com variação, kit, entre outros que necessitem de ação adicional antes de comprar. |     |             |       |       |                |           |                  |              |                |                 |                     |     |                              |
| `{{ products[0].additional_message }}`    | Exibe a mensagem adicional cadastrada do produto.                                                                                                                                                                            |     |             |       |       |                |           |                  |              |                |                 |                     |     |                              |
| `{% set ranking = products[0].ranking %}` | count \| rating Ranking (avaliação) do produto                                                                                                                                                                               |     |             |       |       |                |           |                  |              |                |                 |                     |     |                              |
| `{{ products[0].warranty }}`              | Exibe a opção selecionada no tempo de garantia do produto.                                                                                                                                                                   |     |             |       |       |                |           |                  |              |                |                 |                     |     |                              |
| `{{ product.bonus_html }}`                | [Programa de fidelização](https://basedeconhecimento.tray.com.br/hc/pt-br/articles/6743361546011-Programa-de-Fidelidade)                                                                                                     |     |             |       |       |                |           |                  |              |                |                 |                     |     |                              |
| `{{ product.data_tray_ga4 }}`             | [Atributo para o Google Analytics 4](/themes/construindo-seu-template/desenvolver/atributo-google-analytics-4.md)                                                                                                            |     |             |       |       |                |           |                  |              |                |                 |                     |     |                              |

### Atributo **`product.images`** <a href="#imagens" id="imagens"></a>

Este atributo retorna um array com informações sobre as imagens cadastradas no produto, que pode ser usado nas páginas home, catalog e search. É possível manipular o tamanho da imagem para uso em Thumbnails por exemplo, com os atributos da tabela abaixo:

<table><thead><tr><th width="150">Atributos disponíveis do "product.images"</th><th>Características e Exemplo de uso</th></tr></thead><tbody><tr><td><code>small</code>​</td><td><p>Exibe a imagem do produto nas dimensões de <strong>30x30px</strong>. Exemplo de código:</p><pre class="language-html"><code class="lang-html">{% set images = products[0].images %}
&#x3C;img src="{{ images[0].small }}" alt="">
</code></pre></td></tr><tr><td><code>medium</code></td><td><p>Exibe a imagem do produto nas dimensões de <strong>90x90px</strong>. Exemplo de código:</p><pre class="language-html"><code class="lang-html">{% set images = products[0].images %}
&#x3C;img src="{{ images[0].medium }}" alt="">
</code></pre></td></tr><tr><td><code>large</code></td><td><p>Exibe a imagem do produto nas dimensões de <strong>180x180px.</strong> Exemplo de código:</p><pre class="language-html"><code class="lang-html">{% set images = products[0].images %}
&#x3C;img src="{{ images[0].large }}" alt="">
</code></pre></td></tr><tr><td><code>full</code></td><td><p>Exibe a imagem do produto no <strong>tamanho original</strong> dela. Exemplo de código:</p><pre class="language-html"><code class="lang-html">{% set images = products[0].images %}
  &#x3C;img src="{{ images[0].full }}" alt="">
</code></pre></td></tr></tbody></table>

### Como Usar&#x20;

Abaixo você pode ver alguns exemplos da utilização do Objeto `products`

{% code title="Input" %}

```html
<div class="showcase-catalog">
    <ul class="list-product">
        {% for item in products %}
            <li class="item">                
                <div class="product">
                    <div class="image">                        
                        <a href="{{ item.link }}" class="space-image">
                            <img class="image" src="{{ asset('img/empty.png') }}" data-src="{{ item.images[0].large }}" alt="{{ item.name }}">
                        </a>
                        {% set replaceTags = {'src=': 'width="119" height="22" alt="Selo" src='} %}
                         {% if product.featured and Image('featured') %}
                            <div class="tag featured">
                                {{ Image('featured') | replace(replaceTags) }}
                            </div>
                        {% endif %}                                       
                    </div>

                    <a class="item-info" href="{{ item.link }}">
                        <div class="item-name">
                            {{ item.name }}
                        </div>
                        <div class="item-price">
                            {% if item.available and item.stock > 0 and not item.upon_request %}
                            
                                {% set current_price = item.price_offer > 0 ? item.price_offer : item.price %}
                                {% set old_price     = item.price_offer > 0 ? item.price : false %}                                
                                {% if item.has_variation and item.has_other_prices %}
                                    <span class="item-has-variants">
                                        {{ Translation('a_partir_de') }}
                                    </span>
                                {% endif %}
                                                                
                                <div class="price display-cash">                                
                                    {% if old_price %}
                                        <span class="old-price">
                                            {{ settings.currency }} {{ old_price | currency }}
                                        </span>
                                    {% endif %}                                
                                    <span class="current-price">
                                        {{ settings.currency }} {{ current_price | currency }}
                                    </span>                                
                                    <span class="item-installments">
                                        {{ item.payment }}
                                    </span>                                
                                </div>
                                                            
                            {% endif %}
                        </div>
                    </a>

                    <div class="actions">
                        {% if item.available and item.stock > 0 and not item.upon_request %}
                            <a class="item-button" href="{{ item.link }}">
                                Ver produto
                            </a>
                        {% endif %}
                    </div>

                </div>
            </li>
        {% endfor %}
    </ul>
</div>
```

{% endcode %}

{% code title="Output" %}

```html
<div class="showcase-catalog">
    <ul class="list-product">
        <li class="item">                
            <div class="product">
                <div class="image">                        
                    <a href="www.sualoja/categoria/produto-a" class="space-image">
                        <img class="image" src="https://caminhoimg.com.br/produto-a.png" alt="Produto A">
                    </a>
                    <div class="tag featured">
                        Destaque
                    </div>
                </div>
                <a class="item-info" href="{{ item.link }}">
                    <div class="item-name">
                        Produto A
                    </div>
                    <div class="item-price">
                        <span class="item-has-variants">
                            A partir de
                        </span>
                        <div class="price display-cash">                                
                            <span class="old-price">
                                R$ 500,00
                            </span>                          
                            <span class="current-price">
                                R$ 450,00
                            </span>                                
                            <span class="item-installments">
                                ou 10x de 53,40 com juros
                            </span>                                
                        </div>
                    </div>
                </a>
                <div class="actions">
                    <a class="item-button" href="https://www.sualoja.com.br/produto-a">
                        Ver produto
                    </a>
                </div>
            </div>
        </li>
    </ul>
</div>

```

{% endcode %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://partners.tray.com.br/themes/construindo-seu-template/referencias/objetos/products.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
