> ## 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. # Visualizar informações dos grupos do produto > Retorna as Informações dos produtos do grupo ## OpenAPI ````yaml get /{alias}/public/catalog/products/{id}/groups 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/products/{id}/groups: get: tags: - Público - Catálogo summary: Visualizar informações dos grupos do produto description: Retorna as Informações dos produtos do grupo operationId: GetPublicCatalogProductsIdGroups parameters: - name: alias in: path description: Alias da loja required: true schema: type: string - name: id in: path description: id do produto required: true schema: type: string responses: '200': description: Retorna as Informações de grupos de produtos content: application/json: schema: $ref: '#/components/schemas/ProductPublicGroup' '404': description: Produto não encontrado security: [] components: schemas: ProductPublicGroup: properties: data: type: array items: properties: id: description: ID do produto. type: integer example: 17790530 sku_id: description: ID do SKU representativo do produto no resultado. type: integer example: 262573372 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: false has_variations: description: 'Indica se o produto possui variações (ex.: cor, tamanho).' type: boolean example: true 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: GTA V Premium 10Uni. slug: description: Slug do produto, usado na URL da página do produto. type: string example: gta-v-premium-10uni sku: description: Um ou mais SKUs separados por vírgula. type: string example: >- GQVQLNP34,69SQH26GU,QWNVUZHMQ,EPSHDEZPT,K89BHGYNV,SKU-TEST-API,LLKUD2KAM,E7K48R248 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, formatada para exibição. type: string example: '4.7' total_approved_reviews: description: Quantidade de avaliações aprovadas do produto. type: integer example: 3 url: description: URL completa da página do produto na loja. type: string format: uri example: https://www.mytems.com/gta-v-premium-10uni/p url_path: description: Caminho relativo da URL da página do produto. type: string example: /gta-v-premium-10uni/p use_different_images: description: >- Indica se o produto usa imagens diferentes para cada variação (ex.: uma imagem por cor). type: integer example: 1 brand: description: Marca do produto. properties: data: properties: id: description: ID da marca do produto. type: integer example: 733502 name: description: Nome da marca do produto. type: string example: Rockstar Games logo_url: description: URL do logotipo da marca. type: string example: null nullable: true type: object type: object images: description: Imagens do produto. properties: data: type: array items: properties: url: description: URL da imagem do produto. 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: description: Preços e condições de pagamento do produto. properties: data: 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, 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 de tabela do produto, sem descontos aplicados. type: number format: float example: 1 price_formated: description: Preço de tabela formatado para exibição. type: string example: R$ 1,00 base_amount: description: >- Parte inteira, em reais, do valor total (ex.: '100' em R$ 100,50). type: string example: '1' 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 venda do produto após aplicar promoções ativas. type: number format: float example: 1.11 price_sale_formated: description: Preço de venda formatado para exibição. type: string example: R$ 1,11 price_discount: description: >- Valor do desconto aplicado ao preço de venda do produto. type: number format: float example: 0 price_discount_formated: description: Valor do desconto formatado para exibição. type: string example: R$ 0,00 has_promotion: description: Indica se o produto possui alguma promoção ativa. type: boolean example: true percent_discount: description: Percentual de desconto aplicado ao preço de venda. type: number format: float example: 9.91 billet: description: Condições de pagamento via boleto. properties: price: description: Preço do produto quando pago via boleto. type: number format: float example: 1 price_formated: description: Preço via boleto formatado para exibição. type: string example: R$ 1,00 base_amount: description: >- Parte inteira, em reais, do valor total via boleto (ex.: '100' em R$ 100,50). type: string example: '1' 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 format: float 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$ 1,00 à vista com 0.00% de desconto type: object pix: description: Condições de pagamento via Pix. properties: price: description: Preço do produto quando pago via Pix. type: number format: float example: 0.9 price_formatted: description: Preço via Pix formatado para exibição. type: string example: R$ 0,90 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: '90' discount_value: description: Valor do desconto aplicado ao preço via Pix. type: number format: float example: 0.1 discount_percent: description: Percentual de desconto aplicado ao preço via Pix. type: string example: '10.00' discount_text: description: >- Texto pronto de exibição do desconto do Pix (ex.: '10% off no Pix'). type: string example: R$ 0,90 à vista com 10.00% de desconto type: object installments: description: Condições de parcelamento do produto. properties: data: properties: max_installment: description: >- Número máximo de parcelas disponíveis para o produto. type: integer example: 1 max_installment_value: description: >- Valor de cada parcela no número máximo de parcelas. type: number format: float example: 1.11 amount: description: >- Valor total do produto considerado como base para o cálculo do parcelamento. type: number format: float example: 1.11 text: description: >- Texto pronto de exibição das condições de parcelamento (ex.: '3x de R$ 33,30'). type: string example: 1x de R$ 1,11 sem juros text_with_tax: description: >- Texto pronto de exibição das condições de parcelamento incluindo juros. type: string example: 1x de R$ 1,11 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 type: object type: object type: object flags: description: Selos vinculados ao produto. properties: data: type: array items: properties: id: description: ID do selo. type: integer example: 24875 name: description: Nome do selo. type: string example: Pronta Entrega slug: description: Slug do selo. type: string example: pronta-entrega text_color: description: Cor do texto do selo, em hexadecimal. type: string example: '#333333' background_color: description: Cor de fundo do selo, em hexadecimal. type: string example: '#D0D0D0' image_url: description: URL do ícone do selo, quando configurado. type: string example: null nullable: true 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 ````