--- title: "Listar Produtos da loja" method: GET path: "/{alias}/public/search/products/" tags: ["Público - Busca"] --- # Listar Produtos da loja `GET /{alias}/public/search/products/` ## Request - Base URL: `https://api.dooki.com.br/v2` - URL: `https://api.dooki.com.br/v2/{alias}/public/search/products/` - Auth: none required Retorna as informações públicas de produtos de uma loja ## Path parameters - `alias` string, required ## Request body - ProductSearchRequest: Parâmetros para listagem de produtos com base no contexto e filtros. - `context` 'search' | 'category' | 'collection' | 'promotion', required: Contexto da listagem: 'search' para busca por palavra-chave, 'category' para filtrar por categoria, 'collection' para coleção, 'promotion' para promoções. - `q` string, nullable: Palavra-chave para busca. Obrigatório quando 'context' = 'search'. - `slug` string, nullable: Identificador slug de categoria, coleção ou promoção. Obrigatório quando 'context' != 'search'. - `min` number, float, nullable: Preço mínimo para filtro. - `max` number, float, nullable: Preço máximo para filtro. - `brand_id` integer[], nullable: IDs das marcas dos produtos. - `category_id` integer[], nullable: IDs das categorias dos produtos. - `filter_id` integer[], nullable: IDs dos filtros dos produtos. Valores negativos identificam variações. ## Response `200` Informações públicas dos produtos da Loja - ProductSearchMeta: Resposta da listagem pública de produtos. - `meta` object[]: Metadados adicionais sobre a listagem (normalmente vazio). - `data` ProductSearch[]: Lista de produtos retornados. - `id` integer: ID do produto. - `sku_id` integer: ID do SKU representativo do produto no resultado de busca. - `gift_value` number, float: Valor cobrado pela embalagem de presente do produto, quando aplicável. - `simple` boolean: Indica se o produto é simples, sem variações. - `has_variations` boolean: Indica se o produto possui variações (ex.: cor, tamanho). - `is_digital` boolean: Indica se o produto é digital (sem envio físico). - `warranty` integer: Prazo de garantia do produto, em meses. - `custom_shipping` boolean: Indica se o produto usa frete customizado, em vez do frete padrão da loja. - `shipping_price` number, float: Valor de frete fixo configurado para o produto, quando `custom_shipping` for verdadeiro. - `name` string: Nome do produto. - `slug` string: Slug do produto, usado na URL da página do produto. - `sku` string: Código do SKU principal do produto. - `blocked_sale` boolean: Indica se o produto está bloqueado para novos pedidos. - `rating` number, float: Nota média de avaliação do produto. - `total_approved_reviews` integer: Quantidade de avaliações aprovadas do produto. - `url` string, uri: URL completa da página do produto na loja. - `url_path` string: Caminho relativo da URL da página do produto. - `use_different_images` boolean, nullable: Indica se o produto usa imagens diferentes para cada variação (ex.: uma imagem por cor). - `brand` BrandSearch: Marca do produto no resultado de busca. - `id` integer: ID da marca do produto. - `name` string: Nome da marca do produto. - `logo_url` string, uri, nullable: URL do logotipo da marca. - `images` ImageSearch: Imagem do produto no resultado de busca. - `url` string, uri: URL da imagem do produto. - `prices` PricesSearch: Preços e condições de pagamento do produto no resultado de busca. - `currency` string: Moeda utilizada para exibição dos valores de preço, sempre representada como 'R$'. - `price_cost` number, float: Preço de custo do produto/SKU, usado internamente para cálculo de margem. - `price_cost_formated` string: Preço de custo formatado para exibição. - `price` number, float: Preço final do produto/SKU, já com o preço promocional e as promoções ativas aplicados. - `price_formated` string: Preço final formatado para exibição. - `base_amount` string: Parte inteira, em reais, do valor total (ex.: '100' em R$ 100,50). - `fraction_amount` string: Parte decimal, em centavos, do valor total (ex.: '50' em R$ 100,50). - `price_sale` number, float: Preço de tabela do produto/SKU, sem descontos aplicados. - `price_sale_formated` string: Preço de tabela formatado para exibição. - `price_discount` number, float: Preço promocional cadastrado no produto/SKU. Quando maior que zero, substitui o preço de tabela. - `price_discount_formated` string: Preço promocional formatado para exibição. - `has_promotion` boolean: Indica se o preço final ficou abaixo do preço de tabela. - `percent_discount` number, float: Percentual de desconto entre o preço de tabela e o preço final. - `billet` PaymentMethodBilletSearch: Condições de pagamento via boleto no resultado de busca. - `price` number: Preço do produto/SKU quando pago via boleto. - `price_formated` string: Preço via boleto formatado para exibição. - `base_amount` string: Parte inteira, em reais, do valor total via boleto (ex.: '100' em R$ 100,50). - `fraction_amount` string: Parte decimal, em centavos, do valor total via boleto (ex.: '50' em R$ 100,50). - `discount_value` number: Valor do desconto aplicado ao preço via boleto. - `discount_percent` string: Percentual de desconto aplicado ao preço via boleto. - `discount_text` string: Texto pronto de exibição do desconto do boleto (ex.: '10% off no boleto'). - `pix` PaymentMethodPixSearch: Condições de pagamento via Pix no resultado de busca. - `price` number: Preço do produto/SKU quando pago via Pix. - `price_formatted` string: Preço via Pix formatado para exibição. - `base_amount` string: Parte inteira, em reais, do valor total via Pix (ex.: '100' em R$ 100,50). - `fraction_amount` string: Parte decimal, em centavos, do valor total via Pix (ex.: '50' em R$ 100,50). - `discount_value` number: Valor do desconto aplicado ao preço via Pix. - `discount_percent` string: Percentual de desconto aplicado ao preço via Pix. - `discount_text` string: Texto pronto de exibição do desconto do Pix (ex.: '10% off no Pix'). - `installments` InstallmentsSearch: Condições de parcelamento do produto no resultado de busca. - `max_installment` integer: Número máximo de parcelas disponíveis para o produto/SKU. - `max_installment_value` number: Valor de cada parcela no número máximo de parcelas. - `amount` number: Valor total do produto/SKU considerado como base para o cálculo do parcelamento. - `text` string: Texto pronto de exibição das condições de parcelamento (ex.: '3x de R$ 33,30'). - `text_with_tax` string: Texto pronto de exibição das condições de parcelamento incluindo juros. - `text_discount_percent` string, nullable: Texto pronto de exibição do percentual de desconto no parcelamento, quando houver. - `text_discount` string, nullable: Texto pronto de exibição do valor de desconto no parcelamento, quando houver. - `flags` FlagsSearch: Selos vinculados ao produto no resultado de busca. - `data` object[]: Lista de flags associadas ao produto. ## Other responses - `404`: Loja não encontrada ## Changes - **2026-11-03** `bbafb577e11c`: 1 info - endpoint added [Operation history](https://skmtc.dev/yampi/apis/yampi-api/changes/:alias/public/search/products/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)