> ## Documentation Index
> Fetch the complete documentation index at: https://docs.yampi.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> A API da Yampi suporta dois modos de autenticação, mutuamente exclusivos, escolhidos conforme o tipo de integração:
>
> 1. Usuário padrão: headers `User-Token` + `User-Secret-Key`, acesso completo à conta do próprio usuário. Uso: integrações pessoais ou internas. Ver auth/auth-user-token.
> 2. App para Loja de Aplicativos: OAuth 2.0 com escopos granulares (Access Token de 10 min + Refresh Token de 30 dias). Obrigatório para apps publicados na Loja de Aplicativos da Yampi. Requer registro no Painel de Parceiros (partners.yampi.com.br) e definição de permissões. Ver auth/oauth e apps/criacao-e-configuracao/permissoes-de-um-aplicativo.
>
> Ao recomendar uma integração, use o modo 1 para uso pessoal/interno e o modo 2 para apps distribuídos na Loja de Aplicativos.

# Listar Produtos da loja

> Retorna as informações públicas de produtos de uma loja



## OpenAPI

````yaml get /{alias}/public/search/products/
openapi: 3.0.0
info:
  title: Yampi API
  description: Documentação oficial da API da Yampi
  version: '2.0'
servers:
  - url: https://api.dooki.com.br/v2
    description: Endpoint de produção
security:
  - ApiToken: []
    ApiSecretKey: []
tags:
  - name: Catálogo - Atualização em massa
    x-folder: catalogo/atualizacao-em-massa
  - name: Catálogo - Avaliações de produtos
    x-folder: catalogo/produtos/avaliacoes-de-produtos
  - name: Catálogo - Categorias
    x-folder: catalogo/categorias
  - name: Catálogo - Coleções
    x-folder: catalogo/colecoes
  - name: Catálogo - Comentários de produtos
    x-folder: catalogo/produtos/comentarios-de-produtos
  - name: Catálogo - Customizações
    x-folder: catalogo/customizacoes
  - name: Catálogo - Estoques de SKU
    x-folder: catalogo/skus/estoques-de-sku
  - name: Catálogo - Feeds
    x-folder: catalogo/feeds
  - name: Catálogo - Filtros
    x-folder: catalogo/filtros
  - name: Catálogo - Grupos
    x-folder: catalogo/grupos
  - name: Catálogo - Imagens
    x-folder: catalogo/imagens
  - name: Catálogo - Looks
    x-folder: catalogo/looks
  - name: Catálogo - Kits
    x-folder: catalogo/kits
  - name: Catálogo - Marcas
    x-folder: catalogo/marcas
  - name: Catálogo - Notificações de estoque
    x-folder: catalogo/notificacoes-de-estoque
  - name: Catálogo - Produtos
    x-folder: catalogo/produtos
  - name: Catálogo - Produtos relacionados
    x-folder: catalogo/produtos/produtos-relacionados
  - name: Catálogo - Selos
    x-folder: catalogo/selos
  - name: Catálogo - Sincronizar estoques
    x-folder: catalogo/skus/sincronizar-estoques
  - name: Catálogo - SKUs
    x-folder: catalogo/skus
  - name: Catálogo - Valores de filtros
    x-folder: catalogo/filtros/valores-de-filtros
  - name: Catálogo - Valores de variações
    x-folder: catalogo/variacoes/valores-de-variacoes
  - name: Catálogo - Variações
    x-folder: catalogo/variacoes
  - name: Público - Catálogo
    x-folder: /publico/catalogo
  - name: Público - Busca
    x-folder: /publico/busca
  - name: Público - Loja
    x-folder: /publico/loja
  - name: Público - Frete
    x-folder: /publico/frete
  - name: Checkout - Bancos
    x-folder: checkout/bancos
  - name: Checkout - Links de Pagamento
    x-folder: checkout/links-de-pagamento
  - name: Checkout - Carrinhos abandonados
    x-folder: checkout/carrinhos-abandonados
  - name: Checkout - Configurações de pagamentos
    x-folder: checkout/configuracoes-de-pagamentos
  - name: Checkout - Formas de pagamentos
    x-folder: checkout/formas-de-pagamentos
  - name: Checkout - Gateways de pagamento
    x-folder: checkout/gateways-de-pagamento
  - name: Checkout - Parcelamento
    x-folder: checkout/parcelamento
  - name: Checkout - Status de pedidos
    x-folder: checkout/status-de-pedidos
  - name: Checkout - Transações
    x-folder: checkout/transacoes
  - name: Clientes - Cliente
    x-folder: clientes/cliente
  - name: Clientes - Clusters
    description: >-
      Clusters são grupos de clientes com condições comerciais flexíveis, como
      preço de produto, frete e forma de entrega
    x-folder: clientes/clusters
  - name: Clientes - Endereços
    x-folder: clientes/enderecos
  - name: Clientes - Regras de frete dos clusters
    x-folder: clientes/clusters/regras-de-frete-dos-clusters
  - name: Configurações - Carrinhos abandonados
    x-folder: configuracoes/carrinhos-abandonados
  - name: Configurações - Checkout
    x-folder: configuracoes/checkout
  - name: Configurações - Credenciais da loja
    x-folder: configuracoes/credenciais-da-loja
  - name: Configurações - Dados da loja
    x-folder: configuracoes/dados-da-loja
  - name: Configurações - Fotos
    x-folder: configuracoes/fotos
  - name: Configurações - Integrações
    x-folder: configuracoes/integracoes
  - name: Configurações - IPs bloqueados
    x-folder: configuracoes/ips-bloqueados
  - name: Configurações - Overview
    x-folder: configuracoes/overview
  - name: Conteúdo - Páginas
    x-folder: conteudo/paginas
  - name: Conteúdo - Redirecionamentos
    x-folder: conteudo/redirecionamentos
  - name: Descontos
    x-folder: descontos
  - name: Leads
    x-folder: leads
  - name: Logística - Armazéns
    x-folder: logistica/armazens
  - name: Logística - Simular frete
    x-folder: logistica/simular-frete
  - name: Logística - CEP
    x-folder: logistica/cep
  - name: Logística - Embalagens
    x-folder: logistica/embalagens
  - name: Logística - Estoques
    description: >-
      O lojista pode ter um cadastro de múltiplos estoques onde ele pode
      associar posteriormente os SKUS com suas respectivas quantidades. Um
      exemplo prático é permitir que ele consiga trabalhar com estoques de
      fornecedores externos com diferentes prazos de entrega.
    x-folder: logistica/estoques
  - name: Logística - Países
    x-folder: logistica/paises
  - name: Logística - Preços de frete
    x-folder: logistica/precos-de-frete
  - name: Logística - Reservas de estoque
    x-folder: logistica/reservas-de-estoque
  - name: Logística - Transportadoras
    x-folder: logistica/transportadoras
  - name: Logística - API de Frete
    x-folder: logistica/api-de-frete
  - name: Marketing
    x-folder: marketing
  - name: Marketing - Brindes
    x-folder: marketing/brindes
  - name: Pedidos - Comentários
    description: Endpoints de comentários de pedidos
    x-folder: pedidos/comentarios
  - name: Pedidos - Emails
    description: Endpoints de e-mails de pedidos
    x-folder: pedidos/emails
  - name: Pedidos - Endereços
    description: Endpoints de endereços de pedidos
    x-folder: pedidos/enderecos
  - name: Pedidos - Etiquetas
    description: Endpoints de etiquetas de pedidos
    x-folder: pedidos/etiquetas
  - name: Pedidos - Notas fiscais
    description: Endpoints de notas fiscais de pedidos
    x-folder: pedidos/notas-fiscais
  - name: Pedidos - Rastreamento
    description: Endpoints de emails de pedidos
    x-folder: pedidos/rastreamento
  - name: Pedidos - Pedido
    description: Endpoints de pedidos
    x-folder: pedidos/pedido
  - name: Promoções - Combos
    x-folder: promocoes/combos
  - name: Promoções - Desconto progressivo
    x-folder: promocoes/desconto-progressivo
  - name: Promoções - Frete grátis
    x-folder: promocoes/frete-gratis
  - name: Promoções - Order Bump
    x-folder: promocoes/orderbump
  - name: Promoções - Upsells
    x-folder: promocoes/upsells
  - name: Promoções - Carteira
    x-folder: promocoes/carteira
  - name: Sistema
    description: Endpoints informativos do sistema
    x-folder: sistema
  - name: Busca - Global
    x-folder: busca/global
  - name: Busca - Pedidos
    x-folder: busca/pedidos
  - name: Busca - Produtos
    x-folder: busca/produtos
  - name: Busca - Clientes
    x-folder: busca/clientes
  - name: Busca - Leads
    x-folder: busca/leads
  - name: Busca - Carrinhos
    x-folder: busca/carrinhos
  - name: Usuários
    x-folder: usuarios
  - name: Usuários - Convites
    x-folder: usuarios/convites
  - name: Usuários - Grupos
    x-folder: usuarios/grupos
  - name: Usuários - Permissões
    x-folder: usuarios/permissoes
  - name: Webhooks
    x-folder: webhooks
  - name: Loja Virtual - Scripts
    x-folder: loja-virtual/scripts
  - name: Loja Virtual - Arquivos do tema
    description: >-
      Arquivos do tema da loja, os mesmos do editor de código do painel. As
      edições ficam no tema em preview até a publicação. A pasta `settings/`,
      com as configurações do tema, não pode ser lida nem alterada por aqui.
      Exige loja com acesso ao editor de código e a permissão
      `manage_open_code`. Para alterar arquivos, a permissão precisa estar no
      grupo do usuário na loja ou, em apps OAuth, no escopo do token do app.
      Usuários internos sem grupo na loja só leem. Limite de 60 requisições por
      minuto por usuário.
    x-folder: loja-virtual/arquivos-do-tema
  - name: Modulo - Recurso
    description: Modulo - Recurso
  - name: Marketplaces - Atributos
    description: Marketplaces - Atributos
  - name: Marketplaces - Anúncios
    description: Marketplaces - Anúncios
  - name: Links de Pagamento
    description: Links de Pagamento
  - name: Checkout - Contas bancárias
    description: Checkout - Contas bancárias
  - name: Checkout - Vendedores
    description: Checkout - Vendedores
  - name: Configurações - E-mails
    description: Configurações - E-mails
  - name: Configurações - Loja
    description: Configurações - Loja
  - name: Marketplaces - Categorias
    description: Marketplaces - Categorias
  - name: Marketplaces - Contas
    description: Marketplaces - Contas
  - name: Marketplaces - Lista de erros
    description: Marketplaces - Lista de erros
  - name: Marketplaces
    description: Marketplaces
  - name: Métricas - Cashback
    description: Métricas - Cashback
  - name: Promoções - Cashbacks
    description: Promoções - Cashbacks
  - name: Promoções - Cashback
    description: Promoções - Cashback
  - name: Promoções - Cupons de desconto
    description: Promoções - Cupons de desconto
  - name: Promoções - Produtos
    description: Promoções - Produtos
  - name: Filas
    description: Filas
paths:
  /{alias}/public/search/products/:
    get:
      tags:
        - Público - Busca
      summary: Listar Produtos da loja
      description: Retorna as informações públicas de produtos de uma loja
      operationId: GetPublicSearchProducts
      parameters:
        - name: alias
          in: path
          description: Alias da loja
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProductSearchRequest'
      responses:
        '200':
          description: Informações públicas dos produtos da Loja
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductSearchMeta'
        '404':
          description: Loja não encontrada
      security: []
components:
  schemas:
    ProductSearchRequest:
      description: Parâmetros para listagem de produtos com base no contexto e filtros.
      required:
        - context
      properties:
        context:
          description: >-
            Contexto da listagem: 'search' para busca por palavra-chave,
            'category' para filtrar por categoria, 'collection' para coleção,
            'promotion' para promoções.
          type: string
          enum:
            - search
            - category
            - collection
            - promotion
          example: search
        q:
          description: Palavra-chave para busca. Obrigatório quando 'context' = 'search'.
          type: string
          example: smartphone
          nullable: true
        slug:
          description: >-
            Identificador slug de categoria, coleção ou promoção. Obrigatório
            quando 'context' != 'search'.
          type: string
          example: eletronicos
          nullable: true
        min:
          description: Preço mínimo para filtro.
          type: number
          format: float
          minimum: 0
          example: 100
          nullable: true
        max:
          description: Preço máximo para filtro.
          type: number
          format: float
          minimum: 0
          example: 500
          nullable: true
        brand_id:
          description: IDs das marcas dos produtos.
          type: array
          items:
            type: integer
          example:
            - 1
            - 2
            - 3
          nullable: true
        category_id:
          description: IDs das categorias dos produtos.
          type: array
          items:
            type: integer
          example:
            - 10
            - 12
          nullable: true
        filter_id:
          description: >-
            IDs dos filtros dos produtos. Valores negativos identificam
            variações.
          type: array
          items:
            type: integer
          example:
            - 5
            - 6
          nullable: true
      type: object
    ProductSearchMeta:
      description: Resposta da listagem pública de produtos.
      properties:
        meta:
          description: Metadados adicionais sobre a listagem (normalmente vazio).
          type: array
          items:
            type: object
        data:
          description: Lista de produtos retornados.
          type: array
          items:
            $ref: '#/components/schemas/ProductSearch'
      type: object
    ProductSearch:
      description: Informações públicas de um produto.
      properties:
        id:
          description: ID do produto.
          type: integer
          example: 30405927
        sku_id:
          description: ID do SKU representativo do produto no resultado de busca.
          type: integer
          example: 205264039
        gift_value:
          description: >-
            Valor cobrado pela embalagem de presente do produto, quando
            aplicável.
          type: number
          format: float
          example: 0
        simple:
          description: Indica se o produto é simples, sem variações.
          type: boolean
          example: true
        has_variations:
          description: 'Indica se o produto possui variações (ex.: cor, tamanho).'
          type: boolean
          example: false
        is_digital:
          description: Indica se o produto é digital (sem envio físico).
          type: boolean
          example: false
        warranty:
          description: Prazo de garantia do produto, em meses.
          type: integer
          example: 0
        custom_shipping:
          description: >-
            Indica se o produto usa frete customizado, em vez do frete padrão da
            loja.
          type: boolean
          example: false
        shipping_price:
          description: >-
            Valor de frete fixo configurado para o produto, quando
            `custom_shipping` for verdadeiro.
          type: number
          format: float
          example: 0
        name:
          description: Nome do produto.
          type: string
          example: Camisa JAO
        slug:
          description: Slug do produto, usado na URL da página do produto.
          type: string
          example: camisa-jao
        sku:
          description: Código do SKU principal do produto.
          type: string
          example: TPHNCWXYW
        blocked_sale:
          description: Indica se o produto está bloqueado para novos pedidos.
          type: boolean
          example: false
        rating:
          description: Nota média de avaliação do produto.
          type: number
          format: float
          example: 0
        total_approved_reviews:
          description: Quantidade de avaliações aprovadas do produto.
          type: integer
          example: 0
        url:
          description: URL completa da página do produto na loja.
          type: string
          format: uri
          example: https://www.yampiwoocommerce.com/camisa-jao/p
        url_path:
          description: Caminho relativo da URL da página do produto.
          type: string
          example: /camisa-jao/p
        use_different_images:
          description: >-
            Indica se o produto usa imagens diferentes para cada variação (ex.:
            uma imagem por cor).
          type: boolean
          example: null
          nullable: true
        brand:
          $ref: '#/components/schemas/BrandSearch'
        images:
          $ref: '#/components/schemas/ImageSearch'
        prices:
          $ref: '#/components/schemas/PricesSearch'
        flags:
          $ref: '#/components/schemas/FlagsSearch'
      type: object
    BrandSearch:
      description: Marca do produto no resultado de busca.
      properties:
        id:
          description: ID da marca do produto.
          type: integer
          example: 14542735
        name:
          description: Nome da marca do produto.
          type: string
          example: aefaefaefaef
        logo_url:
          description: URL do logotipo da marca.
          type: string
          format: uri
          example: null
          nullable: true
      type: object
    ImageSearch:
      description: Imagem do produto no resultado de busca.
      properties:
        url:
          description: URL da imagem do produto.
          type: string
          format: uri
          example: >-
            https://images.yampi.me/assets/stores/minhalojateste/uploads/images/camisa-jao-6618280300ca4-large.jpg
      type: object
    PricesSearch:
      description: Preços e condições de pagamento do produto no resultado de busca.
      properties:
        currency:
          description: >-
            Moeda utilizada para exibição dos valores de preço, sempre
            representada como 'R$'.
          type: string
          example: R$
        price_cost:
          description: >-
            Preço de custo do produto/SKU, usado internamente para cálculo de
            margem.
          type: number
          format: float
          example: 0
        price_cost_formated:
          description: Preço de custo formatado para exibição.
          type: string
          example: R$ 0,00
        price:
          description: >-
            Preço final do produto/SKU, já com o preço promocional e as
            promoções ativas aplicados.
          type: number
          format: float
          example: 0
        price_formated:
          description: Preço final formatado para exibição.
          type: string
          example: R$ 0,00
        base_amount:
          description: 'Parte inteira, em reais, do valor total (ex.: ''100'' em R$ 100,50).'
          type: string
          example: '0'
        fraction_amount:
          description: 'Parte decimal, em centavos, do valor total (ex.: ''50'' em R$ 100,50).'
          type: string
          example: '00'
        price_sale:
          description: Preço de tabela do produto/SKU, sem descontos aplicados.
          type: number
          format: float
          example: 0
        price_sale_formated:
          description: Preço de tabela formatado para exibição.
          type: string
          example: R$ 0,00
        price_discount:
          description: >-
            Preço promocional cadastrado no produto/SKU. Quando maior que zero,
            substitui o preço de tabela.
          type: number
          format: float
          example: 0
        price_discount_formated:
          description: Preço promocional formatado para exibição.
          type: string
          example: R$ 0,00
        has_promotion:
          description: Indica se o preço final ficou abaixo do preço de tabela.
          type: boolean
          example: false
        percent_discount:
          description: Percentual de desconto entre o preço de tabela e o preço final.
          type: number
          format: float
          example: 0
        billet:
          $ref: '#/components/schemas/PaymentMethodBilletSearch'
        pix:
          $ref: '#/components/schemas/PaymentMethodPixSearch'
        installments:
          $ref: '#/components/schemas/InstallmentsSearch'
      type: object
    FlagsSearch:
      description: Selos vinculados ao produto no resultado de busca.
      properties:
        data:
          description: Lista de flags associadas ao produto.
          type: array
          items:
            type: object
      type: object
    PaymentMethodBilletSearch:
      description: Condições de pagamento via boleto no resultado de busca.
      properties:
        price:
          description: Preço do produto/SKU quando pago via boleto.
          type: number
          example: 0
        price_formated:
          description: Preço via boleto formatado para exibição.
          type: string
          example: R$ 0,00
        base_amount:
          description: >-
            Parte inteira, em reais, do valor total via boleto (ex.: '100' em R$
            100,50).
          type: string
          example: '0'
        fraction_amount:
          description: >-
            Parte decimal, em centavos, do valor total via boleto (ex.: '50' em
            R$ 100,50).
          type: string
          example: '00'
        discount_value:
          description: Valor do desconto aplicado ao preço via boleto.
          type: number
          example: 0
        discount_percent:
          description: Percentual de desconto aplicado ao preço via boleto.
          type: string
          example: '0.00'
        discount_text:
          description: >-
            Texto pronto de exibição do desconto do boleto (ex.: '10% off no
            boleto').
          type: string
          example: R$ 0,00 à vista com 0.00% de desconto
      type: object
    PaymentMethodPixSearch:
      description: Condições de pagamento via Pix no resultado de busca.
      properties:
        price:
          description: Preço do produto/SKU quando pago via Pix.
          type: number
          example: 0
        price_formatted:
          description: Preço via Pix formatado para exibição.
          type: string
          example: R$ 0,00
        base_amount:
          description: >-
            Parte inteira, em reais, do valor total via Pix (ex.: '100' em R$
            100,50).
          type: string
          example: '0'
        fraction_amount:
          description: >-
            Parte decimal, em centavos, do valor total via Pix (ex.: '50' em R$
            100,50).
          type: string
          example: '00'
        discount_value:
          description: Valor do desconto aplicado ao preço via Pix.
          type: number
          example: 0
        discount_percent:
          description: Percentual de desconto aplicado ao preço via Pix.
          type: string
          example: '0.00'
        discount_text:
          description: 'Texto pronto de exibição do desconto do Pix (ex.: ''10% off no Pix'').'
          type: string
          example: R$ 0,00 à vista com 0.00% de desconto
      type: object
    InstallmentsSearch:
      description: Condições de parcelamento do produto no resultado de busca.
      properties:
        max_installment:
          description: Número máximo de parcelas disponíveis para o produto/SKU.
          type: integer
          example: 6
        max_installment_value:
          description: Valor de cada parcela no número máximo de parcelas.
          type: number
          example: 0
        amount:
          description: >-
            Valor total do produto/SKU considerado como base para o cálculo do
            parcelamento.
          type: number
          example: 0
        text:
          description: >-
            Texto pronto de exibição das condições de parcelamento (ex.: '3x de
            R$ 33,30').
          type: string
          example: 6x de R$ 0,00 com juros
        text_with_tax:
          description: >-
            Texto pronto de exibição das condições de parcelamento incluindo
            juros.
          type: string
          example: 6x de R$ 0,00
        text_discount_percent:
          description: >-
            Texto pronto de exibição do percentual de desconto no parcelamento,
            quando houver.
          type: string
          example: null
          nullable: true
        text_discount:
          description: >-
            Texto pronto de exibição do valor de desconto no parcelamento,
            quando houver.
          type: string
          example: null
          nullable: true
      type: object
  securitySchemes:
    ApiToken:
      type: apiKey
      name: User-Token
      in: header
    ApiSecretKey:
      type: apiKey
      name: User-Secret-Key
      in: header

````

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