API de demandante: precio del producto

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

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

Consulta

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

Rota: {host}/public/v1/precos-do-produto?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:

{
  "precosDoProduto": [
    {
      "codProduto": "1101",
      "codListaPreco": "1",
      "unidade": "UN",
      "qtdeEmbalagem": 1,
      "valor": 1.15,
      "percentualDescontoMaximo": 0,
      "permiteVendaFracionaria": 1,
      "promocaoValor": null,
      "promocaoDataInicio": null,
      "promocaoDataFim": null,
      "lancamentoAte": null,
      "multiplosPermitidosPorEmbalagem": null,
      "valorIpiPorUnidade": 0,
      "opcoesDePrecoPreFixado": null,
      "precoTravado": null,
      "codCliente": null,
      "pesoBruto": 0,
      "pesoLiquido": 0,
      "cubagem": 0,
      "percAcrescimoMaximo": 0,
      "custoReposicao": 0,
      "unidadeEmbalagem": null,
      "altura": 0,
      "largura": 0,
      "comprimento": 0,
      "jsonPrecoPorQuantidade": null,
      "valorUnitarioRedespacho": null,
      "dataAlteracao": "2026-07-27 10:00:00"
    }
  ]
}

Insertar o actualizar

POST inserción mediante la tecla compuesta codProduto + codListaPreco + codCliente (opcional).

Rota: {host}/public/v1/precos-do-produto
Método: POST
Body: json

Propiedad	Tipo	Tamaño	Obligatorio	Descripción
codProduto	cadena	30	✓	Código de producto. Parte de la clave upsert.
codListaPreco	cadena	20	✓	Código de lista de precios. Parte de la clave upsert.
codCliente	entero			Código de cliente (precio específico).
valor	decimal		✓	Precio del producto. Acepta 0.
percentualDescontoMaximo	decimal		✓	Descuento porcentual máximo. No puede ser negativo. Acepta 0.
unidad	cadena	5		Unidad de medida. Predeterminado UN.
qtdeEmbalagem	decimal			Cantidad por paquete. Predeterminado 1.
permiteVendaFracionaria	entero			0 o 1. Predeterminado 1.
promocaoValor	decimal			Valor promocional.
promocaoDataInicio	fecha			Inicio de la promoción.
promocaoDataFim	fecha			Fin de la promoción.
lancamentoAte	fecha			Fecha límite de lanzamiento.
multiplosPermitidosPorEmbalagem	cadena	100		Múltiplos permitidos (por ejemplo, 2;4;8).
valorIpiPorUnidade	decimal			IPI por unidad. Predeterminado 0.
opcoesDePrecoPreFixado	cadena			Precios prefijados separados por ; (por ejemplo: 10;20;30).
precoTravado	decimal			Precio bloqueado.
pesoBruto	decimal			Peso bruto. Predeterminado 0.
pesoLiquido	decimal			Peso neto. Predeterminado 0.
cubo	decimal			Cubicación. Predeterminado 0.
percAcrescimoMaximo	decimal			Incremento porcentual máximo. Predeterminado 0.
custoReposicao	decimal			Costo de reposición. Predeterminado 0.
unidadeEmbalagem	cadena	5		Unidad de embalaje.
altura	decimal			Altura. Predeterminado 0.
ancho	decimal			Ancho. Predeterminado 0.
longitud	decimal			Longitud. Predeterminado 0.
jsonPrecoPorQuantidade	cadena			Precio de cantidad JSON (cadena JSON válida).
valorUnitarioRedespacho	decimal			Valor unitario de reenvío.

Precaución

Inclusión

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

Actualización

• Sólo codProduto y codListaPreco son obligatorios (codCliente cuando forman parte de la clave). Devuelve 200.

Cuerpo:

{
  "codProduto": "1101",
  "codListaPreco": "1",
  "unidade": "UN",
  "qtdeEmbalagem": 1,
  "valor": 1.15,
  "percentualDescontoMaximo": 0,
  "permiteVendaFracionaria": 1
}

Retorno:

{
  "codProduto": "1101",
  "codListaPreco": "1",
  "unidade": "UN",
  "qtdeEmbalagem": 1,
  "valor": 1.15,
  "percentualDescontoMaximo": 0,
  "permiteVendaFracionaria": 1,
  "promocaoValor": null,
  "promocaoDataInicio": null,
  "promocaoDataFim": null,
  "lancamentoAte": null,
  "multiplosPermitidosPorEmbalagem": null,
  "valorIpiPorUnidade": 0,
  "opcoesDePrecoPreFixado": null,
  "precoTravado": null,
  "codCliente": null,
  "pesoBruto": 0,
  "pesoLiquido": 0,
  "cubagem": 0,
  "percAcrescimoMaximo": 0,
  "custoReposicao": 0,
  "unidadeEmbalagem": null,
  "altura": 0,
  "largura": 0,
  "comprimento": 0,
  "jsonPrecoPorQuantidade": null,
  "valorUnitarioRedespacho": null,
  "dataAlteracao": "2026-07-27 10:00:00"
}

Eliminar

Elimina el precio del producto.

Rota: {host}/public/v1/precos-do-produto?codProduto={codProduto}&codListaPreco={codListaPreco}&codCliente={codCliente}
Método: DELETE

Retorno:

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