# Capítulo V - Consulta grupos de produtos

Consultar os grupos de produtos do cliente. Os campos de filtros são enviados como parâmetros da requisição (não há body). Consultar o Swagger para obter os filtros possíveis.

# Descrição dos campos de retorno

**Retorno**

<table border="0" cellpadding="0" cellspacing="0" class="MsoNormalTable" id="bkmrk-campo-pai-descri%C3%A7%C3%A3o-" style="width: 267.0pt; border-collapse: collapse; mso-yfti-tbllook: 1184; mso-padding-alt: 0cm 3.5pt 0cm 3.5pt;" width="356"><tbody><tr style="mso-yfti-irow: 0; mso-yfti-firstrow: yes; height: 16.5pt;"><td nowrap="nowrap" style="width: 71.0pt; border: solid black 1.0pt; mso-border-alt: solid black .5pt; background: #DDDDDD; padding: 0cm 3.5pt 0cm 3.5pt; height: 16.5pt;" width="95">**<span style="font-size: 11.0pt; font-family: 'Segoe UI',sans-serif; mso-fareast-font-family: 'Times New Roman'; color: #212529; mso-font-kerning: 0pt; mso-ligatures: none; mso-fareast-language: PT-BR;">Campo</span>**

</td><td nowrap="nowrap" style="width: 28.0pt; border: solid black 1.0pt; border-left: none; mso-border-top-alt: solid black .5pt; mso-border-bottom-alt: solid black .5pt; mso-border-right-alt: solid black .5pt; background: #DDDDDD; padding: 0cm 3.5pt 0cm 3.5pt; height: 16.5pt;" width="37">**<span style="font-size: 11.0pt; font-family: 'Segoe UI',sans-serif; mso-fareast-font-family: 'Times New Roman'; color: #212529; mso-font-kerning: 0pt; mso-ligatures: none; mso-fareast-language: PT-BR;">PAI</span>**

</td><td nowrap="nowrap" style="width: 168.0pt; border: solid black 1.0pt; border-left: none; mso-border-top-alt: solid black .5pt; mso-border-bottom-alt: solid black .5pt; mso-border-right-alt: solid black .5pt; background: #DDDDDD; padding: 0cm 3.5pt 0cm 3.5pt; height: 16.5pt;" width="224">**<span style="font-size: 11.0pt; font-family: 'Segoe UI',sans-serif; mso-fareast-font-family: 'Times New Roman'; color: #212529; mso-font-kerning: 0pt; mso-ligatures: none; mso-fareast-language: PT-BR;">Descrição</span>**

</td></tr><tr style="mso-yfti-irow: 1; height: 16.5pt;"><td nowrap="nowrap" style="width: 71.0pt; border: solid black 1.0pt; border-top: none; mso-border-left-alt: solid black .5pt; mso-border-bottom-alt: solid black .5pt; mso-border-right-alt: solid black .5pt; background: white; padding: 0cm 3.5pt 0cm 3.5pt; height: 16.5pt;" width="95"><span style="font-size: 11.0pt; font-family: 'Segoe UI',sans-serif; mso-fareast-font-family: 'Times New Roman'; color: #212529; mso-font-kerning: 0pt; mso-ligatures: none; mso-fareast-language: PT-BR;">success</span>

</td><td nowrap="nowrap" style="width: 28.0pt; border-top: none; border-left: none; border-bottom: solid black 1.0pt; border-right: solid black 1.0pt; mso-border-bottom-alt: solid black .5pt; mso-border-right-alt: solid black .5pt; background: white; padding: 0cm 3.5pt 0cm 3.5pt; height: 16.5pt;" width="37"><span style="font-size: 11.0pt; font-family: 'Segoe UI',sans-serif; mso-fareast-font-family: 'Times New Roman'; color: #212529; mso-font-kerning: 0pt; mso-ligatures: none; mso-fareast-language: PT-BR;">/</span>

</td><td nowrap="nowrap" style="width: 168.0pt; border-top: none; border-left: none; border-bottom: solid black 1.0pt; border-right: solid black 1.0pt; mso-border-bottom-alt: solid black .5pt; mso-border-right-alt: solid black .5pt; background: white; padding: 0cm 3.5pt 0cm 3.5pt; height: 16.5pt;" width="224"><span style="font-size: 11.0pt; font-family: 'Segoe UI',sans-serif; mso-fareast-font-family: 'Times New Roman'; color: #212529; mso-font-kerning: 0pt; mso-ligatures: none; mso-fareast-language: PT-BR;">Status do retorno</span>

</td></tr><tr style="mso-yfti-irow: 2; height: 16.5pt;"><td nowrap="nowrap" style="width: 71.0pt; border: solid black 1.0pt; border-top: none; mso-border-left-alt: solid black .5pt; mso-border-bottom-alt: solid black .5pt; mso-border-right-alt: solid black .5pt; background: white; padding: 0cm 3.5pt 0cm 3.5pt; height: 16.5pt;" width="95"><span style="font-size: 11.0pt; font-family: 'Segoe UI',sans-serif; mso-fareast-font-family: 'Times New Roman'; color: #212529; mso-font-kerning: 0pt; mso-ligatures: none; mso-fareast-language: PT-BR;">message</span>

</td><td nowrap="nowrap" style="width: 28.0pt; border-top: none; border-left: none; border-bottom: solid black 1.0pt; border-right: solid black 1.0pt; mso-border-bottom-alt: solid black .5pt; mso-border-right-alt: solid black .5pt; background: white; padding: 0cm 3.5pt 0cm 3.5pt; height: 16.5pt;" width="37"><span style="font-size: 11.0pt; font-family: 'Segoe UI',sans-serif; mso-fareast-font-family: 'Times New Roman'; color: #212529; mso-font-kerning: 0pt; mso-ligatures: none; mso-fareast-language: PT-BR;">/</span>

</td><td nowrap="nowrap" style="width: 168.0pt; border-top: none; border-left: none; border-bottom: solid black 1.0pt; border-right: solid black 1.0pt; mso-border-bottom-alt: solid black .5pt; mso-border-right-alt: solid black .5pt; background: white; padding: 0cm 3.5pt 0cm 3.5pt; height: 16.5pt;" width="224"><span style="font-size: 11.0pt; font-family: 'Segoe UI',sans-serif; mso-fareast-font-family: 'Times New Roman'; color: #212529; mso-font-kerning: 0pt; mso-ligatures: none; mso-fareast-language: PT-BR;">Mensagem do retorno</span>

</td></tr><tr style="mso-yfti-irow: 3; height: 16.5pt;"><td nowrap="nowrap" style="width: 71.0pt; border: solid black 1.0pt; border-top: none; mso-border-left-alt: solid black .5pt; mso-border-bottom-alt: solid black .5pt; mso-border-right-alt: solid black .5pt; background: white; padding: 0cm 3.5pt 0cm 3.5pt; height: 16.5pt;" width="95"><span style="font-size: 11.0pt; font-family: 'Segoe UI',sans-serif; mso-fareast-font-family: 'Times New Roman'; color: #212529; mso-font-kerning: 0pt; mso-ligatures: none; mso-fareast-language: PT-BR;">record\_count</span>

</td><td nowrap="nowrap" style="width: 28.0pt; border-top: none; border-left: none; border-bottom: solid black 1.0pt; border-right: solid black 1.0pt; mso-border-bottom-alt: solid black .5pt; mso-border-right-alt: solid black .5pt; background: white; padding: 0cm 3.5pt 0cm 3.5pt; height: 16.5pt;" width="37"><span style="font-size: 11.0pt; font-family: 'Segoe UI',sans-serif; mso-fareast-font-family: 'Times New Roman'; color: #212529; mso-font-kerning: 0pt; mso-ligatures: none; mso-fareast-language: PT-BR;">/</span>

</td><td nowrap="nowrap" style="width: 168.0pt; border-top: none; border-left: none; border-bottom: solid black 1.0pt; border-right: solid black 1.0pt; mso-border-bottom-alt: solid black .5pt; mso-border-right-alt: solid black .5pt; background: white; padding: 0cm 3.5pt 0cm 3.5pt; height: 16.5pt;" width="224"><span style="font-size: 11.0pt; font-family: 'Segoe UI',sans-serif; mso-fareast-font-family: 'Times New Roman'; color: #212529; mso-font-kerning: 0pt; mso-ligatures: none; mso-fareast-language: PT-BR;">Número de registros retornados</span>

</td></tr><tr style="mso-yfti-irow: 4; height: 16.5pt;"><td nowrap="nowrap" style="width: 71.0pt; border: solid black 1.0pt; border-top: none; mso-border-left-alt: solid black .5pt; mso-border-bottom-alt: solid black .5pt; mso-border-right-alt: solid black .5pt; background: white; padding: 0cm 3.5pt 0cm 3.5pt; height: 16.5pt;" width="95"><span style="font-size: 11.0pt; font-family: 'Segoe UI',sans-serif; mso-fareast-font-family: 'Times New Roman'; color: #212529; mso-font-kerning: 0pt; mso-ligatures: none; mso-fareast-language: PT-BR;">id</span>

</td><td nowrap="nowrap" style="width: 28.0pt; border-top: none; border-left: none; border-bottom: solid black 1.0pt; border-right: solid black 1.0pt; mso-border-bottom-alt: solid black .5pt; mso-border-right-alt: solid black .5pt; background: white; padding: 0cm 3.5pt 0cm 3.5pt; height: 16.5pt;" width="37"><span style="font-size: 11.0pt; font-family: 'Segoe UI',sans-serif; mso-fareast-font-family: 'Times New Roman'; color: #212529; mso-font-kerning: 0pt; mso-ligatures: none; mso-fareast-language: PT-BR;">data</span>

</td><td nowrap="nowrap" style="width: 168.0pt; border-top: none; border-left: none; border-bottom: solid black 1.0pt; border-right: solid black 1.0pt; mso-border-bottom-alt: solid black .5pt; mso-border-right-alt: solid black .5pt; background: white; padding: 0cm 3.5pt 0cm 3.5pt; height: 16.5pt;" width="224"><span style="font-size: 11.0pt; font-family: 'Segoe UI',sans-serif; mso-fareast-font-family: 'Times New Roman'; color: #212529; mso-font-kerning: 0pt; mso-ligatures: none; mso-fareast-language: PT-BR;">ID do grupo</span>

</td></tr><tr style="mso-yfti-irow: 5; mso-yfti-lastrow: yes; height: 16.5pt;"><td nowrap="nowrap" style="width: 71.0pt; border: solid black 1.0pt; border-top: none; mso-border-left-alt: solid black .5pt; mso-border-bottom-alt: solid black .5pt; mso-border-right-alt: solid black .5pt; background: white; padding: 0cm 3.5pt 0cm 3.5pt; height: 16.5pt;" width="95"><span style="font-size: 11.0pt; font-family: 'Segoe UI',sans-serif; mso-fareast-font-family: 'Times New Roman'; color: #212529; mso-font-kerning: 0pt; mso-ligatures: none; mso-fareast-language: PT-BR;">descricao</span>

</td><td nowrap="nowrap" style="width: 28.0pt; border-top: none; border-left: none; border-bottom: solid black 1.0pt; border-right: solid black 1.0pt; mso-border-bottom-alt: solid black .5pt; mso-border-right-alt: solid black .5pt; background: white; padding: 0cm 3.5pt 0cm 3.5pt; height: 16.5pt;" width="37"><span style="font-size: 11.0pt; font-family: 'Segoe UI',sans-serif; mso-fareast-font-family: 'Times New Roman'; color: #212529; mso-font-kerning: 0pt; mso-ligatures: none; mso-fareast-language: PT-BR;">data</span>

</td><td nowrap="nowrap" style="width: 168.0pt; border-top: none; border-left: none; border-bottom: solid black 1.0pt; border-right: solid black 1.0pt; mso-border-bottom-alt: solid black .5pt; mso-border-right-alt: solid black .5pt; background: white; padding: 0cm 3.5pt 0cm 3.5pt; height: 16.5pt;" width="224"><span style="font-size: 11.0pt; font-family: 'Segoe UI',sans-serif; mso-fareast-font-family: 'Times New Roman'; color: #212529; mso-font-kerning: 0pt; mso-ligatures: none; mso-fareast-language: PT-BR;">Descrição do grupo</span>

</td></tr></tbody></table>

**Tabela de referência para os campo "success" e "message"**

<table border="0" cellpadding="0" cellspacing="0" class="MsoNormalTable" id="bkmrk-c%C3%B3digo-de-retorno-su" style="width: 226.0pt; border-collapse: collapse; mso-yfti-tbllook: 1184; mso-padding-alt: 0cm 3.5pt 0cm 3.5pt;" width="301"><tbody><tr style="mso-yfti-irow: 0; mso-yfti-firstrow: yes; height: 16.5pt;"><td nowrap="nowrap" style="width: 104.0pt; border: solid black 1.0pt; mso-border-alt: solid black .5pt; background: #DDDDDD; padding: 0cm 3.5pt 0cm 3.5pt; height: 16.5pt;" width="139">**<span style="font-size: 11.0pt; font-family: 'Segoe UI',sans-serif; mso-fareast-font-family: 'Times New Roman'; color: #212529; mso-font-kerning: 0pt; mso-ligatures: none; mso-fareast-language: PT-BR;">Código de retorno</span>**

</td><td nowrap="nowrap" style="width: 46.0pt; border: solid black 1.0pt; border-left: none; mso-border-top-alt: solid black .5pt; mso-border-bottom-alt: solid black .5pt; mso-border-right-alt: solid black .5pt; background: #DDDDDD; padding: 0cm 3.5pt 0cm 3.5pt; height: 16.5pt;" width="61">**<span style="font-size: 11.0pt; font-family: 'Segoe UI',sans-serif; mso-fareast-font-family: 'Times New Roman'; color: #212529; mso-font-kerning: 0pt; mso-ligatures: none; mso-fareast-language: PT-BR;">success</span>**

</td><td nowrap="nowrap" style="width: 76.0pt; border: solid black 1.0pt; border-left: none; mso-border-top-alt: solid black .5pt; mso-border-bottom-alt: solid black .5pt; mso-border-right-alt: solid black .5pt; background: #DDDDDD; padding: 0cm 3.5pt 0cm 3.5pt; height: 16.5pt;" width="101">**<span style="font-size: 11.0pt; font-family: 'Segoe UI',sans-serif; mso-fareast-font-family: 'Times New Roman'; color: #212529; mso-font-kerning: 0pt; mso-ligatures: none; mso-fareast-language: PT-BR;">message</span>**

</td></tr><tr style="mso-yfti-irow: 1; height: 16.5pt;"><td nowrap="nowrap" style="width: 104.0pt; border: solid black 1.0pt; border-top: none; mso-border-left-alt: solid black .5pt; mso-border-bottom-alt: solid black .5pt; mso-border-right-alt: solid black .5pt; background: white; padding: 0cm 3.5pt 0cm 3.5pt; height: 16.5pt;" width="139"><span style="font-size: 11.0pt; font-family: 'Segoe UI',sans-serif; mso-fareast-font-family: 'Times New Roman'; color: #212529; mso-font-kerning: 0pt; mso-ligatures: none; mso-fareast-language: PT-BR;">200</span>

</td><td nowrap="nowrap" style="width: 46.0pt; border-top: none; border-left: none; border-bottom: solid black 1.0pt; border-right: solid black 1.0pt; mso-border-bottom-alt: solid black .5pt; mso-border-right-alt: solid black .5pt; background: white; padding: 0cm 3.5pt 0cm 3.5pt; height: 16.5pt;" width="61"><span style="font-size: 11.0pt; font-family: 'Segoe UI',sans-serif; mso-fareast-font-family: 'Times New Roman'; color: #212529; mso-font-kerning: 0pt; mso-ligatures: none; mso-fareast-language: PT-BR;">true</span>

</td><td nowrap="nowrap" style="width: 76.0pt; border-top: none; border-left: none; border-bottom: solid black 1.0pt; border-right: solid black 1.0pt; mso-border-bottom-alt: solid black .5pt; mso-border-right-alt: solid black .5pt; background: white; padding: 0cm 3.5pt 0cm 3.5pt; height: 16.5pt;" width="101"><span style="font-size: 11.0pt; font-family: 'Segoe UI',sans-serif; mso-fareast-font-family: 'Times New Roman'; color: #212529; mso-font-kerning: 0pt; mso-ligatures: none; mso-fareast-language: PT-BR;">OK</span>

</td></tr><tr style="mso-yfti-irow: 2; height: 16.5pt;"><td nowrap="nowrap" rowspan="2" style="width: 104.0pt; border: solid black 1.0pt; border-top: none; mso-border-left-alt: solid black .5pt; mso-border-bottom-alt: solid black .5pt; mso-border-right-alt: solid black .5pt; background: white; padding: 0cm 3.5pt 0cm 3.5pt; height: 16.5pt;" width="139"><span style="font-size: 11.0pt; font-family: 'Segoe UI',sans-serif; mso-fareast-font-family: 'Times New Roman'; color: #212529; mso-font-kerning: 0pt; mso-ligatures: none; mso-fareast-language: PT-BR;">400</span>

</td><td nowrap="nowrap" style="width: 46.0pt; border-top: none; border-left: none; border-bottom: solid black 1.0pt; border-right: solid black 1.0pt; mso-border-bottom-alt: solid black .5pt; mso-border-right-alt: solid black .5pt; background: white; padding: 0cm 3.5pt 0cm 3.5pt; height: 16.5pt;" width="61"><span style="font-size: 11.0pt; font-family: 'Segoe UI',sans-serif; mso-fareast-font-family: 'Times New Roman'; color: #212529; mso-font-kerning: 0pt; mso-ligatures: none; mso-fareast-language: PT-BR;">false</span>

</td><td nowrap="nowrap" style="width: 76.0pt; border-top: none; border-left: none; border-bottom: solid black 1.0pt; border-right: solid black 1.0pt; mso-border-bottom-alt: solid black .5pt; mso-border-right-alt: solid black .5pt; background: white; padding: 0cm 3.5pt 0cm 3.5pt; height: 16.5pt;" width="101"><span style="font-size: 11.0pt; font-family: 'Segoe UI',sans-serif; mso-fareast-font-family: 'Times New Roman'; color: #212529; mso-font-kerning: 0pt; mso-ligatures: none; mso-fareast-language: PT-BR;">token\_invalid</span>

</td></tr><tr style="mso-yfti-irow: 3; height: 16.5pt;"><td nowrap="nowrap" style="width: 46.0pt; border-top: none; border-left: none; border-bottom: solid black 1.0pt; border-right: solid black 1.0pt; mso-border-bottom-alt: solid black .5pt; mso-border-right-alt: solid black .5pt; background: white; padding: 0cm 3.5pt 0cm 3.5pt; height: 16.5pt;" width="61"><span style="font-size: 11.0pt; font-family: 'Segoe UI',sans-serif; mso-fareast-font-family: 'Times New Roman'; color: #212529; mso-font-kerning: 0pt; mso-ligatures: none; mso-fareast-language: PT-BR;">false</span>

</td><td nowrap="nowrap" style="width: 76.0pt; border-top: none; border-left: none; border-bottom: solid black 1.0pt; border-right: solid black 1.0pt; mso-border-bottom-alt: solid black .5pt; mso-border-right-alt: solid black .5pt; background: white; padding: 0cm 3.5pt 0cm 3.5pt; height: 16.5pt;" width="101"><span style="font-size: 11.0pt; font-family: 'Segoe UI',sans-serif; mso-fareast-font-family: 'Times New Roman'; color: #212529; mso-font-kerning: 0pt; mso-ligatures: none; mso-fareast-language: PT-BR;">token\_expired</span>

</td></tr><tr style="mso-yfti-irow: 4; mso-yfti-lastrow: yes; height: 16.5pt;"><td nowrap="nowrap" style="width: 104.0pt; border: solid black 1.0pt; border-top: none; mso-border-left-alt: solid black .5pt; mso-border-bottom-alt: solid black .5pt; mso-border-right-alt: solid black .5pt; background: white; padding: 0cm 3.5pt 0cm 3.5pt; height: 16.5pt;" width="139"><span style="font-size: 11.0pt; font-family: 'Segoe UI',sans-serif; mso-fareast-font-family: 'Times New Roman'; color: #212529; mso-font-kerning: 0pt; mso-ligatures: none; mso-fareast-language: PT-BR;">500</span>

</td><td nowrap="nowrap" style="width: 46.0pt; border-top: none; border-left: none; border-bottom: solid black 1.0pt; border-right: solid black 1.0pt; mso-border-bottom-alt: solid black .5pt; mso-border-right-alt: solid black .5pt; background: white; padding: 0cm 3.5pt 0cm 3.5pt; height: 16.5pt;" width="61"><span style="font-size: 11.0pt; font-family: 'Segoe UI',sans-serif; mso-fareast-font-family: 'Times New Roman'; color: #212529; mso-font-kerning: 0pt; mso-ligatures: none; mso-fareast-language: PT-BR;">false</span>

</td><td nowrap="nowrap" style="width: 76.0pt; border-top: none; border-left: none; border-bottom: solid black 1.0pt; border-right: solid black 1.0pt; mso-border-bottom-alt: solid black .5pt; mso-border-right-alt: solid black .5pt; background: white; padding: 0cm 3.5pt 0cm 3.5pt; height: 16.5pt;" width="101"><span style="font-size: 11.0pt; font-family: 'Segoe UI',sans-serif; mso-fareast-font-family: 'Times New Roman'; color: #212529; mso-font-kerning: 0pt; mso-ligatures: none; mso-fareast-language: PT-BR;">internal error</span>

</td></tr></tbody></table>

# Exemplos de chamada e retorno

**Chamada**

[![Exemplo Chamada.PNG](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/scaled-1680-/exemplo-chamada.PNG)](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/exemplo-chamada.PNG)

**Retorno**

{  
 "success": true,  
 "message": "Ok",  
 "record\_count": 1,  
 "data": \[  
 {  
 "id": "135146",  
 "descricao": "SP-SP-235-137-2"  
 }  
 \]  
}