API de Demandante - Productos

Este artículo es parte de la documentación API de integración REST.

Documentación para consultar, insertar, actualizar y eliminar productos.

Consulta

Enumere los productos de la empresa. Sin filtro, considera dataAlteracao de los últimos 6 meses.

Rota: {host}/public/v1/produtos?pagina={pagina}&limite={limite}&filtroDataAlteracao={data}&operadorFiltro={operador}
Método: GET

Precaución

Paginación

• pagina — base 1 (predeterminado 1)
• limite — predeterminado 100, máximo 500

Filtros

• Formato filtroDataAlteracao — Y-m-d
• operadorFiltro (opcional) — <, >, =, <=, >= (predeterminado >=)

Retorno:

{
  "produtos": [
    {
      "codigo": "PROD-001",
      "codGrupoProduto": "1",
      "codMarca": 10,
      "descricao": "Produto Teste",
      "saldoEstoque": 100,
      "unidadeVenda": "UN",
      "precoVenda": 10.5,
      "permiteDesconto": 1,
      "codTamanho": null,
      "aliquotaICMSST": null,
      "bcICMSST": null,
      "aliquotaIPI": null,
      "bcIPI": null,
      "mva": null,
      "campoLivre1": null,
      "campoLivre2": null,
      "campoLivre3": null,
      "ativo": 1,
      "qtdeMinimaPorPedido": 1,
      "referencia": "REF-001",
      "controlePorLote": 0,
      "codNCM": null,
      "precoPauta": null,
      "observacao": null,
      "observacaoLojaVirtual": null,
      "dataEstoque": null,
      "segmentosRelacionados": null,
      "codProdutoPrincipal": null,
      "descProdutoPrincipal": null,
      "codSegmentoGrade": null,
      "codTipoGradeVariacao1": null,
      "codTipoGradeVariacao2": null,
      "codTipoGradeVariacao3": null,
      "codTipoGradeVariacao4": null,
      "codigoBarras": "7891234567890",
      "codigoBarrasEmbalagem": null,
      "ordemSeparacao": null,
      "qtdePorPallet": null,
      "jsonCamposAuxiliares": null,
      "dataAlteracao": "2026-07-27 14:00:00"
    }
  ]
}

Insertar o actualizar

POST inserción mediante la tecla codigo.

Rota: {host}/public/v1/produtos
Método: POST
Body: json

Propiedad	Tipo	Tamaño	Obligatorio	Descripción
código	cadena	30	✓	Código de producto. Identificador único utilizado para insertar o actualizar (upsert).
descripción	cadena	300	✓	Descripción del Producto.
codGrupoProduto	cadena	30		Código de grupo de productos.
codMarca	entero			Código de marca.
saldoEstoque	decimal			Saldo de existencias. Valor predeterminado de inclusión: 0.
unidadeVenda	cadena	5		Unidad de ventas. Los valores de más de 5 caracteres se truncan.
precoVenda	decimal			Precio de venta.
permiteDesconto	entero			Valores: 0 o 1. Valor predeterminado de inclusión: 1.
codTamanho	cadena	50		Código de talla.
aliquotaICMSST	decimal			Tasa ICMS ST.
bcICMSST	decimal			Base de cálculo del ICMS ST.
aliquotaIPI	decimal			Tasa IPI.
bcIPI	decimal			Base de cálculo del IPI.
mva	decimal			AMV.
campoLivre1	cadena	500		Campo libre 1.
campoLivre2	cadena	500		Campo libre 2.
campoLivre3	cadena	5000		Campo libre 3.
activo	entero			Valores: 0 o 1. Valor predeterminado de inclusión: 1.
qtdeMinimaPorPedido	decimal			Cantidad mínima por pedido. Valor predeterminado de inclusión: 1.
referencia	cadena	50		Referencia del producto.
controlePorLote	entero			Valores: 0 o 1. Valor predeterminado de inclusión: 0.
codNCM	cadena	50		Código NCM.
precoPauta	decimal			Precio estándar.
observación	cadena	5000		Observación del producto.
observacaoLojaVirtual	cadena			Nota para la tienda online.
dataEstoque	fecha			Fecha de existencias. Formato Y-m-d.
segmentosRelacionados	cadena	500		Segmentos relacionados. Solo se actualiza cuando se completa.
codProdutoPrincipal	cadena	30		Código de producto principal (grado).
descProdutoPrincipal	cadena	100		Descripción del producto principal (cuadrícula).
codSegmentoGrade	cadena	50		Código de segmento de cuadrícula.
codTipoGradeVariacao1	cadena	50		Código de tipo de variación de cuadrícula 1.
codTipoGradeVariacao2	cadena	50		Código de tipo de variación de cuadrícula 2.
codTipoGradeVariacao3	cadena	50		Código de tipo de variación de cuadrícula 3.
codTipoGradeVariacao4	cadena	50		Código de tipo de variación de cuadrícula 4.
codigoBarras	cadena	20		Código de barras.
codigoBarrasEmbalagem	cadena	20		Código de barras de embalaje.
ordemSeparacao	cadena	50		Orden de separación.
qtdePorPallet	decimal			Cantidad por palet.
jsonCamposAuxiliares	cadena			JSON con campos auxiliares.

Precaución

Inclusión

• Es necesario enviar todos los atributos que sean obligatorios. Devolver 201.

Actualización

• Sólo el atributo codigo es obligatorio. Devuelve 200.

Cuerpo:

{
  "codigo": "PROD-001",
  "descricao": "Produto Teste",
  "codGrupoProduto": "1",
  "unidadeVenda": "UN",
  "precoVenda": 10.5,
  "saldoEstoque": 100,
  "ativo": 1,
  "permiteDesconto": 1,
  "referencia": "REF-001",
  "codigoBarras": "7891234567890"
}

Retorno:

{
  "codigo": "PROD-001",
  "codGrupoProduto": "1",
  "codMarca": null,
  "descricao": "Produto Teste",
  "saldoEstoque": 100,
  "unidadeVenda": "UN",
  "precoVenda": 10.5,
  "permiteDesconto": 1,
  "codTamanho": null,
  "aliquotaICMSST": null,
  "bcICMSST": null,
  "aliquotaIPI": null,
  "bcIPI": null,
  "mva": null,
  "campoLivre1": null,
  "campoLivre2": null,
  "campoLivre3": null,
  "ativo": 1,
  "qtdeMinimaPorPedido": 1,
  "referencia": "REF-001",
  "controlePorLote": 0,
  "codNCM": null,
  "precoPauta": null,
  "observacao": null,
  "observacaoLojaVirtual": null,
  "dataEstoque": null,
  "segmentosRelacionados": null,
  "codProdutoPrincipal": null,
  "descProdutoPrincipal": null,
  "codSegmentoGrade": null,
  "codTipoGradeVariacao1": null,
  "codTipoGradeVariacao2": null,
  "codTipoGradeVariacao3": null,
  "codTipoGradeVariacao4": null,
  "codigoBarras": "7891234567890",
  "codigoBarrasEmbalagem": null,
  "ordemSeparacao": null,
  "qtdePorPallet": null,
  "jsonCamposAuxiliares": null,
  "dataAlteracao": "2026-07-27 14:00:00"
}

Eliminar

Retire el producto.

Rota: {host}/public/v1/produtos?codigo={codigo}
Método: DELETE

Retorno:

{
  "mensagem": "Registro excluído com sucesso."
}