> ## 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. # Listar coleções ativas de uma loja > Retorna as coleções ativas e dentro do período de validade, com banners incluídos por padrão ## OpenAPI ````yaml get /{alias}/public/catalog/collections/active 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}/public/catalog/collections/active: get: tags: - Público - Catálogo summary: Listar coleções ativas de uma loja description: >- Retorna as coleções ativas e dentro do período de validade, com banners incluídos por padrão operationId: GetPublicCatalogCollectionsActive parameters: - name: alias in: path description: Alias da loja required: true schema: type: string - name: page in: query description: 'Número da página (padrão: 1)' required: false schema: type: integer minimum: 1 - name: limit in: query description: 'Quantidade de itens por página, entre 1 e 100 (padrão: 16)' required: false schema: type: integer maximum: 100 minimum: 1 - name: featured in: query description: >- Filtra por destaque: `1` retorna apenas coleções em destaque, `0` apenas fora de destaque. Ausente ou inválido retorna todas. required: false schema: type: integer enum: - 0 - 1 - name: q in: query description: >- Busca por nome da coleção (contém, case-insensitive). Máximo de 100 caracteres. required: false schema: type: string maxLength: 100 responses: '200': description: Lista de coleções ativas da loja content: application/json: schema: properties: data: type: array items: properties: id: type: integer example: 5287 name: type: string example: Promoção de Verão url: type: string format: uri example: https://loja.yampi.com.br/promocao-de-verao/l url_path: type: string example: /promocao-de-verao/l banners: properties: data: type: array items: $ref: '#/components/schemas/BannersPublic' type: object type: object type: object '404': description: Loja não encontrada security: [] components: schemas: BannersPublic: description: Lista de banners públicos. required: - data properties: data: type: array items: required: - id - type - active - home - name - slug - expired - start_at - end_at - first_banner - dimensions - product properties: id: type: integer example: 119474 product_id: type: integer example: null nullable: true type: type: string example: image active: type: boolean example: true home: type: boolean example: true name: type: string example: Top-banner slug: type: string example: top-banner image_url: type: string format: uri example: >- //images.yampi.me/assets/stores/mytems/uploads/banners/62c6fbff0fddc.jpg nullable: true mobile_image_url: type: string format: uri example: null nullable: true link: type: string format: uri example: null nullable: true expired: type: boolean example: false stopwatch: type: string example: null nullable: true stopwatch_expires_in: type: integer example: null nullable: true start_at: required: - date - timezone_type - timezone properties: date: type: string example: '2025-01-21 10:35:41.000000' timezone_type: type: integer example: 3 timezone: type: string example: America/Sao_Paulo type: object end_at: required: - date - timezone_type - timezone properties: date: type: string example: '3024-01-21 10:35:41.000000' timezone_type: type: integer example: 3 timezone: type: string example: America/Sao_Paulo type: object first_banner: required: - id properties: id: type: integer example: 119474 link: type: string format: uri example: null nullable: true image: type: string format: uri example: >- //images.yampi.me/assets/stores/mytems/uploads/banners/62c6fbff0fddc.jpg nullable: true mobile_image: type: string format: uri example: null nullable: true stopwatch: type: string example: null nullable: true type: object dimensions: required: - desktop - mobile properties: desktop: required: - width - height properties: width: type: string example: '1186.00' height: type: string example: '441.00' type: object mobile: required: - width - height properties: width: type: string example: '0.00' height: type: string example: '0.00' type: object type: object product: required: - data properties: data: type: array items: $ref: '#/components/schemas/ProductBannerPublic' type: object type: object type: object ProductBannerPublic: description: Produto resumido vinculado a um banner. properties: data: properties: id: type: integer example: 17790530 name: type: string example: GTA V Premium 10Uni. slug: type: string example: gta-v-premium-10uni blocked_sale: type: boolean example: false rating: type: string example: '4.7' url: type: string format: uri example: https://www.mytems.com/gta-v-premium-10uni/p url_path: type: string example: /gta-v-premium-10uni/p brand: properties: data: properties: id: type: integer example: 733502 name: type: string example: Rockstar Games logo_url: type: string example: null nullable: true type: object type: object images: properties: data: type: array items: properties: url: type: string format: uri example: >- https://images.yampi.me/assets/stores/mytems/uploads/images/gta-v-premium-10uni-ps5-dvd-67939caf6a3ac-large.jpg type: object type: object prices: properties: data: properties: currency: type: string example: R$ price: type: number format: float example: 1 price_formated: type: string example: R$ 1,00 price_sale: type: number format: float example: 1.11 price_sale_formated: type: string example: R$ 1,11 has_promotion: type: boolean example: true percent_discount: type: number format: float example: 9.91 type: object type: object type: object type: object securitySchemes: ApiToken: type: apiKey name: User-Token in: header ApiSecretKey: type: apiKey name: User-Secret-Key in: header ````