> ## 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 > Retorna uma lista de produtos ## OpenAPI ````yaml get /{alias}/catalog/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: 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: 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: Logística - Frete Público description: Logística - Frete Público - 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}/catalog/products: get: tags: - Catálogo - Produtos summary: Listar produtos description: Retorna uma lista de produtos operationId: GetCatalogProducts parameters: - name: alias in: path description: Alias da loja required: true schema: type: string - name: include in: query description: Incluir relacionamentos adicionais schema: type: array items: type: string enum: - dates - brand - affiliation - extras - texts - seo - filters - filtersSearch - flags - variations - categories - prices - images - skus - firstImage - searchAttributes - reviews - combos - collections - shortCollections - groups - similarsIds - categoriesIds - seller - services - spreadsheet - metadata example: '?include=dates,brand' - $ref: '#/components/parameters/ProductCriteria' responses: '200': description: Lista de produtos content: application/json: schema: properties: data: type: array items: allOf: - $ref: '#/components/schemas/Product' - $ref: '#/components/schemas/ProductAdditionalResponse' meta: $ref: '#/components/schemas/SimplePaginatorWithMeta' type: object '400': description: Requisição inválida components: parameters: ProductCriteria: name: filters in: query style: form explode: false schema: allOf: - $ref: '#/components/schemas/ProductCriteria' - $ref: '#/components/schemas/SearchTrait' schemas: Product: title: Produto description: Representa um produto do catálogo properties: id: description: Identificador único do produto. type: integer example: 12345678 merchant_id: description: ID da loja type: integer readOnly: true example: 1 affiliation_id: description: ID de afiliação do produto type: integer erp_id: description: ID do produto no ERP type: integer seller_id: description: ID do vendedor type: integer active: description: Indica se o produto está ativo type: boolean example: true searchable: description: Indica se o produto é buscável type: boolean example: true is_digital: description: Indica se o produto é digital type: boolean example: true rating: description: Nota média de avaliação do produto. type: integer example: 4 priority: description: Nível de relevância (1 -> Padrão, 2 -> Média, 3 -> Alta) type: integer ncm: description: Código NCM do produto type: string name: description: Nome do produto type: string slug: description: Slug (URL amigável) do produto type: string example: nome-do-produto warranty: description: Garantia em meses type: integer custom_shipping: description: Indica se o Frete é customizado type: boolean example: true shipping_price: description: Valor do frete customizado em reais type: number format: float example: 39.9 gift_value: description: Valor de presente (se aplicável) type: number format: float simple: description: Indica se o produto é simples type: boolean example: true type: object ProductAdditionalResponse: properties: days_availability_formated: description: Tempo de disponibilidade em dias type: string variations: description: Lista de variações do produto type: array items: type: string combinations: description: >- Lista dos identificadores de combinação de variações de cada SKU do produto. type: array items: type: string total_in_stock: description: Quantidade total disponível em estoque type: integer relevance: description: >- Nível de prioridade do produto na busca (1 = padrão, 2 = média, 3 = alta), definido pelo campo `priority` na requisição. type: integer has_variations: description: Indica se o produto possui variações type: boolean example: true sku: description: Código identificador principal do produto type: string example: SKU-TEST-API url: description: URL pública do produto type: string format: url redirect_url_card: description: URL de redirecionamento após compra no cartão type: string format: url nullable: true redirect_url_billet: description: URL de redirecionamento após compra no boleto type: string format: url nullable: true total_orders: description: Número total de pedidos realizados do produto type: integer image_reference_sku_id: description: >- ID do SKU de referência de onde as imagens deste SKU são herdadas, quando configurado. type: integer purchase_url: description: URL direta para a compra do produto type: string preview_url: description: URL de pré-visualização do produto type: string format: url created_at: $ref: '#/components/schemas/BaseTimestamp' updated_at: $ref: '#/components/schemas/BaseTimestamp' type: object SimplePaginatorWithMeta: title: SimplePaginatorWithMeta description: Representa uma paginação com meta properties: meta: properties: pagination: properties: total: type: integer example: '10' count: type: integer example: '30' per_page: type: integer example: '10' current_page: type: integer example: '1' total_pages: type: integer example: '3' links: properties: previous: type: string example: '' next: type: string example: '' type: object type: object type: object type: object ProductCriteria: title: Filtros de Produtos description: Mapeia os filtros disponíveis para pesquisa de produtos. properties: customization: description: Indica se o produto contém customizações. type: boolean example: '?customization=true' custom_shipping: description: Indica se o produto utiliza frete customizado. type: boolean example: '?custom_shipping=false' shopify_id: description: ID do produto no Shopify. type: integer example: '?shopify_id=123456' variations_type: description: Indica se o produto possui variantes (ativa=1 ou inativa=0). type: integer example: '?variations_type=1' type: object x-folder: catalogo/produtos SearchTrait: title: Filtros de Produtos properties: active: description: Status do produto (ativa=1 ou inativa=0). type: integer example: 1 brand_id: description: IDs das marcas associadas aos produtos. type: array items: type: integer example: - 3 - 5 category_id: description: IDs das categorias associadas aos produtos. type: array items: type: integer example: - 8 - 12 flag_id: description: IDs dos selos associados aos produtos. type: array items: type: integer example: - 2 - 4 collection_id: description: IDs das coleções associadas aos produtos. type: array items: type: integer example: - 1 - 3 not_collection_id: description: IDs das coleções a serem excluídas da busca. type: array items: type: integer example: - 1 - 3 priority: description: Filtra produtos pela prioridade definida. type: array items: type: integer enum: - 1 - 2 - 3 example: - 1 q: description: Termo de busca para pesquisa personalizada. type: string example: nome-do-produto quality: description: Filtro de qualidade e completude do cadastro do produto. type: array items: type: string enum: - with_description - without_description - with_seo_title - without_seo_title - with_seo_description - without_seo_description - with_seo_keywords - without_seo_keywords - with_images - without_images - with_skus - without_skus - with_barcode - without_barcode - with_dimensions - without_dimensions - with_weight - without_weight - with_filters - without_filters - with_price - without_price - with_erp_code - without_erp_code - with_categories - without_categories - with_no_stock - with_one_stock example: - with_images orderBy: description: Ordenação especial. type: string enum: - total_in_stock example: total_in_stock type: object BaseTimestamp: properties: date: description: Data e hora no formato YYYY-MM-DD H:MM:SS. type: string example: '2000-08-17 10:24:24' timezone_type: description: Número de representação do timezone. type: integer example: 3 timezone: description: Fuso horário associado. type: string example: America/Sao_Paulo type: object securitySchemes: ApiToken: type: apiKey name: User-Token in: header ApiSecretKey: type: apiKey name: User-Secret-Key in: header ````