API de Demander: grupos de productos
Este artículo es parte de la documentación API de integración REST.
Documentación para consultar, insertar, actualizar y eliminar grupos de productos.
Consulta
Sección titulada «Consulta»Enumera los grupos de productos de la empresa. Sin filtro, considera dataAlteracao de los últimos 6 meses.
Rota: {host}/public/v1/grupos-de-produto?pagina={pagina}&limite={limite}&filtroDataAlteracao={data}&operadorFiltro={operador}Método: GETRetorno:
{ "gruposDeProduto": [ { "codigo": "1", "descricao": "ENLATADOS", "ativo": 1, "codGrupoPai": null, "ocultarNaLojaVirtual": 0, "dataAlteracao": "2026-07-15 10:00:00" } ]}Insertar o actualizar
Sección titulada «Insertar o actualizar»POST inserción mediante la tecla codigo.
Rota: {host}/public/v1/grupos-de-produtoMétodo: POSTBody: json| Propiedad | Tipo | Tamaño | Obligatorio | Descripción |
|---|---|---|---|---|
| código | cadena | 30 | ✓ | Código de grupo. Identificador único utilizado para insertar o actualizar (upsert). |
| descripción | cadena | 255 | ✓ | Nombre del grupo de productos. |
| activo | entero | Valores: 0 o 1. Valor predeterminado de inclusión: 1. |
||
| codGrupoPai | cadena | 30 | Código de grupo principal (jerarquía). | |
| ocultarNaLojaVirtual | entero | Valores: 0 o 1. Valor predeterminado de inclusión: 0. Si se omite en la actualización, mantiene el valor actual. |
Cuerpo:
{ "codigo": "1", "descricao": "ENLATADOS", "ativo": 1, "codGrupoPai": null, "ocultarNaLojaVirtual": 0}Retorno:
{ "codigo": "1", "descricao": "ENLATADOS", "ativo": 1, "codGrupoPai": null, "ocultarNaLojaVirtual": 0, "dataAlteracao": "2026-07-15 10:00:00"}Eliminar
Sección titulada «Eliminar»Elimina el grupo de productos.
Rota: {host}/public/v1/grupos-de-produto?codigo={codigo}Método: DELETERetorno:
{ "mensagem": "Registro excluído com sucesso."}