---
title: "Listar produtos"
method: GET
path: "/{alias}/catalog/products"
tags: ["Catálogo - Produtos"]
---

# Listar produtos

`GET /{alias}/catalog/products`

Retorna uma lista de produtos

## Path parameters

- `alias` string, required

## Query parameters

- `include` string[]
- `filters` object — Mapeia os filtros disponíveis para pesquisa de produtos.
  - `customization` boolean — Indica se o produto contém customizações.
  - `custom_shipping` boolean — Indica se o produto utiliza frete customizado.
  - `shopify_id` integer — ID do produto no Shopify.
  - `variations_type` integer — Indica se o produto possui variantes (ativa=1 ou inativa=0).
  - `active` integer — Status do produto (ativa=1 ou inativa=0).
  - `brand_id` integer[] — IDs das marcas associadas aos produtos.
  - `category_id` integer[] — IDs das categorias associadas aos produtos.
  - `flag_id` integer[] — IDs dos selos associados aos produtos.
  - `collection_id` integer[] — IDs das coleções associadas aos produtos.
  - `not_collection_id` integer[] — IDs das coleções a serem excluídas da busca.
  - `priority` integer[] — Filtra produtos pela prioridade definida.
  - `q` string — Termo de busca para pesquisa personalizada.
  - `quality` string[] — Filtro de qualidade e completude do cadastro do produto.
  - `orderBy` 'total_in_stock' — Ordenação especial.

## Response `200`

Lista de produtos

- object
  - `data` object[]
    - `id` integer — Identificador único do produto.
    - `merchant_id` integer — ID da loja
    - `affiliation_id` integer — ID de afiliação do produto
    - `erp_id` integer — ID do produto no ERP
    - `seller_id` integer — ID do vendedor
    - `active` boolean — Indica se o produto está ativo
    - `searchable` boolean — Indica se o produto é buscável
    - `is_digital` boolean — Indica se o produto é digital
    - `rating` integer — Nota média de avaliação do produto.
    - `priority` integer — Nível de relevância (1 -> Padrão, 2 -> Média, 3 -> Alta)
    - `ncm` string — Código NCM do produto
    - `name` string — Nome do produto
    - `slug` string — Slug (URL amigável) do produto
    - `warranty` integer — Garantia em meses
    - `custom_shipping` boolean — Indica se o Frete é customizado
    - `shipping_price` number, float — Valor do frete customizado em reais
    - `gift_value` number, float — Valor de presente (se aplicável)
    - `simple` boolean — Indica se o produto é simples
    - `days_availability_formated` string — Tempo de disponibilidade em dias
    - `variations` string[] — Lista de variações do produto
    - `combinations` string[] — Lista dos identificadores de combinação de variações de cada SKU do produto.
    - `total_in_stock` integer — Quantidade total disponível em estoque
    - `relevance` integer — Nível de prioridade do produto na busca (1 = padrão, 2 = média, 3 = alta), definido pelo campo `priority` na requisição.
    - `has_variations` boolean — Indica se o produto possui variações
    - `sku` string — Código identificador principal do produto
    - `url` string, url — URL pública do produto
    - `redirect_url_card` string, url, nullable — URL de redirecionamento após compra no cartão
    - `redirect_url_billet` string, url, nullable — URL de redirecionamento após compra no boleto
    - `total_orders` integer — Número total de pedidos realizados do produto
    - `image_reference_sku_id` integer — ID do SKU de referência de onde as imagens deste SKU são herdadas, quando configurado.
    - `purchase_url` string — URL direta para a compra do produto
    - `preview_url` string, url — URL de pré-visualização do produto
    - `created_at` BaseTimestamp
      - `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.
    - `updated_at` BaseTimestamp
      - `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.
  - `meta` SimplePaginatorWithMeta — Representa uma paginação com meta
    - `meta` object
      - `pagination` object
        - `total` integer
        - `count` integer
        - `per_page` integer
        - `current_page` integer
        - `total_pages` integer
        - `links` object
          - `previous` string
          - `next` string

## Other responses

- `400` — Requisição inválida

---

[API](https://skmtc.dev/yampi/apis/yampi-api.md) · [All operations](https://skmtc.dev/yampi/apis/yampi-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/yampi/yampi-api/revisions/fa16c50bef09/schema)