---
title: "Visualizar informações de banners"
method: GET
path: "/{alias}/public/catalog/banners"
tags: ["Público - Catálogo"]
---

# Visualizar informações de banners

`GET /{alias}/public/catalog/banners`

## Request

- Base URL: `https://api.dooki.com.br/v2`
- URL: `https://api.dooki.com.br/v2/{alias}/public/catalog/banners`
- Auth: none required

Retorna as Informações dos banners

## Path parameters

- `alias` string, required

## Response `200`

Retorna as Informações de banners

- BannersPublic: Lista de banners públicos.
  - `data` object[], required: Lista dos banners retornados.
    - `id` integer, required: ID do banner.
    - `product_id` integer, nullable: ID do produto vinculado ao banner, quando o banner apontar para um produto específico.
    - `type` string, required: Tipo do banner: `image` (banner de imagem) ou `product` (banner vinculado a um produto, exigindo `product_id`).
    - `active` boolean, required: Indica se o banner está ativo.
    - `home` boolean, required: Indica se o banner é exibido na página inicial.
    - `name` string, required: Nome do banner.
    - `slug` string, required: Slug do banner.
    - `image_url` string, uri, nullable: URL da imagem do banner para exibição em desktop.
    - `mobile_image_url` string, uri, nullable: URL da imagem do banner para exibição em dispositivos móveis.
    - `link` string, uri, nullable: URL de destino ao clicar no banner.
    - `expired` boolean, required: Indica se o período de exibição do banner já expirou.
    - `stopwatch` string, nullable: Texto de contagem regressiva exibido no banner, quando configurado.
    - `stopwatch_expires_in` integer, nullable: Tempo restante, em segundos, para o fim da contagem regressiva do banner.
    - `start_at` BaseTimestamp, required: Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada.
      - `date` string: Data e hora no formato YYYY-MM-DD H:MM:SS.
      - `timezone_type` integer: Número de representação do timezone.
      - `timezone` string: Fuso horário associado.
    - `end_at` BaseTimestamp, required: Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada.
      - `date` string: Data e hora no formato YYYY-MM-DD H:MM:SS.
      - `timezone_type` integer: Número de representação do timezone.
      - `timezone` string: Fuso horário associado.
    - `first_banner` object, required: Dados resumidos do primeiro banner ativo do grupo.
      - `id` integer, required: ID do primeiro banner ativo do grupo.
      - `link` string, uri, nullable: URL de destino ao clicar no primeiro banner do grupo.
      - `image` string, uri, nullable: URL da imagem do primeiro banner do grupo para exibição em desktop.
      - `mobile_image` string, uri, nullable: URL da imagem do primeiro banner do grupo para exibição em dispositivos móveis.
      - `stopwatch` string, nullable: Texto de contagem regressiva exibido no primeiro banner do grupo, quando configurado.
    - `dimensions` object, required: Dimensões recomendadas para as imagens do banner.
      - `desktop` object, required: Dimensões recomendadas para a imagem exibida em desktop.
        - `width` string, required: Largura recomendada para a imagem do banner em desktop.
        - `height` string, required: Altura recomendada para a imagem do banner em desktop.
      - `mobile` object, required: Dimensões recomendadas para a imagem exibida em dispositivos móveis.
        - `width` string, required: Largura recomendada para a imagem do banner em mobile.
        - `height` string, required: Altura recomendada para a imagem do banner em mobile.
    - `product` object, required: Produtos vinculados ao banner.
      - `data` ProductBannerPublic[], required: Lista dos produtos vinculados ao banner.
        - `data` object: Dados do produto vinculado ao banner.
          - `id` integer: ID do produto.
          - `name` string: Nome do produto.
          - `slug` string: Slug do produto, usado na URL da página do produto.
          - `blocked_sale` boolean: Indica se o produto está bloqueado para novos pedidos.
          - `rating` string: Nota média de avaliação do produto, formatada para exibição.
          - `url` string, uri: URL completa da página do produto na loja.
          - `url_path` string: Caminho relativo da URL da página do produto.
          - `brand` object: Marca do produto.
            - `data` object: Dados da marca do produto.
              - …
          - `images` object: Imagens do produto.
            - `data` object[]: Lista das imagens do produto.
              - …
          - `prices` object: Preços e condições de pagamento do produto.
            - `data` object: Dados de preços e condições de pagamento do produto.
              - …

## Changes

- **2026-11-03** `bbafb577e11c`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/yampi/apis/yampi-api/changes/:alias/public/catalog/banners/get.md)

---

[API](https://skmtc.dev/yampi/apis/yampi-api.md) - [All operations](https://skmtc.dev/yampi/apis/yampi-api/llms.txt) - [OpenAPI document](https://skmtc.dev/yampi/apis/yampi-api/revisions/74739ec8876f?raw)