POST api/retaguarda/v2/produtos

Este método é responsável pela criação ou alteração de produtos que devem ser enviados para o PDV

Endpoint: /api/retaguarda/v2/produtos
Método: Post
Autenticação: Bearer token
Permissão: Retaguarda

Este endpoint recebe uma lista de Produtos para que possam ser enviados vários na mesma requisição

Para que a baixa do Produto criado ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo 12 = Produto

Exemplo de body da requisição

[
{
"descricao": "string",
"unidadeMedida": "string",
"descontoMaximo": "string",
"arredondaTrunca": 0,
"codigoProduto": "string",
"codigoAlternativo": "string",
"origemProduto": 0,
"situacao": 0,
"imagem": "string",
"tipoProduto": 0,
"fracionado": true,
"cnpjFornecedor": "string",
"escalaRelevante": true,
"cstIcms": "string",
"percentualReducaoIcms": "string",
"aliquotaIcms": "string",
"vlicmsret": "string",
"cest": "string",
"encomenda": true,
"pesoLiquido": 0,
"pesoBruto": 0,
"associacaoProdutosClassificacao": [
{
"idRetaguarda": "string",
"idRetaguardaProduto": "string",
"idRetaguardaClassificacaoProduto": "string",
"ordem": 0,
"situacao": 0
}
],
"produtoEmbalagens": [
{
"codigoBarras": "string",
"descricao": "string",
"idProdutoRetaguarda": "string",
"idRetaguarda": "string",
"pesoBruto": 0,
"pesoLiquido": 0,
"quantidade": 0,
"situacao": 0,
"unidadeMedida": "string"
}
],
"produtoKits": [
{
"idRetaguardaProduto": "string",
"idRetaguardaProdutoKit": "string",
"descricao": "string",
"quantidadeVendaKit": 0,
"tipoValorKit": 0,
"situacao": 0,
"valorDesconto": "string",
"novoValorUnitario": "string"
}
],
"produtosSimilares": [
{
"idRetaguardaProduto": "string",
"idRetaguardaSimilar": "string",
"situacao": 0
}
],
"produtosSugestoes": [
{
"idRetaguardaProduto": "string",
"idRetaguardaSugestao": "string",
"situacao": 0
}
],
"codigosProduto": [
{
"codigo": "string",
"descricao": "string",
"idRetaguarda": "string",
"dataAtualizacao": "2024-03-28T13:13:11.127Z",
"dataCadastro": "2024-03-28T13:13:11.127Z",
"situacao": 0
}
],
"impostos": [
{
"idRetaguarda": "string",
"idProprietario": "string"
}
],
"ncms": [
{
"idRetaguarda": "string",
"idProprietario": "string"
}
],
"pisCofins": [
{
"idRetaguarda": "string",
"idProprietario": "string"
}
],
"fcps": [
{
"valorBaseFcp": "string",
"percentualFcp": "string",
"codigoBeneficioFiscal": "string",
"motivoDesoneracaoIcms": 0,
"descontaDesoneracaoNf": true,
"idProprietario": "string"
}
],
"quantidadeMovimentacao": 0,
"idInquilino": "string",
"idRetaguarda": "string",
"idProprietario": "string",
"loteOrigem": "string"
}
]

Definição dos campos de requisição

Campo	Tipo	Descrição	Obrigatório	Observações
descricao	string	Descrição do produto	X	Tamanho máximo: 200 Estes caracteres especiais: "\r","\n","\"",@"\" são removidos ao inserir no PDV, pois podem ocasionar erro na SEFAZ.
unidadeMedida	string	Unidade de medida do produto	X	Tamanho máximo: 20
descontoMaximo	string	Desconto máximo aplicado ao produto
arredondaTrunca	int
codigoProduto	string	Código do produto	X	Tamanho máximo: 600
codigoAlternativo	string	Código alternativo do produto	X	Tamanho máximo: 40
origemProduto	int	Origem do produto	X
situacao	int	Situação do produto (0 - Inativo, 1 - Ativo)	X
imagem	string	URL com a imagem do produto
tipoProduto	int	Tipo do produto	X
fracionado	boolean	Indica se o produto é vendido fracionado
cnpjFornecedor	string	CNPJ do fornecedor do produto
escalaRelevante	boolean	Escala relevante
cstIcms	string	CST ICMS do produto
percentualReducaoIcms	string	Percentual de redução ICMS
aliquotaIcms	string	Aliquota ICMS
vlicmsret	string	vlicmsret
cest	string	Cest
encomenda	boolean	Indica se o produto é uma encomenda
pesoLiquido	float	Peso liquido do produto
pesoBruto	float	Peso bruto do produto
associacaoProdutosClassificacao	Lista de objetos	Lista de classificação do produto
associacaoProdutosClassificacao.idRetaguarda	string	Identificador da classificação na retaguarda
associacaoProdutosClassificacao.idRetaguardaProduto	string	Identificador do produto na retaguarda
associacaoProdutosClassificacao.idRetaguardaClassificacaoProduto	string	Identificador da classificação na retaguarda
associacaoProdutosClassificacao.ordemOpcional	int	Ordem opcional
associacaoProdutosClassificacao.situacao	int	Situação da classificação
produtoEmbalagens	lista de objetos	Lista de embalagens do produto
produtoEmbalagens.codigoBarras	string	Código de barras da embalagem
produtoEmbalagens.descricao	string	Descrição da embalagem		Estes caracteres especiais: "\r","\n","\"",@"\" são removidos ao inserir no PDV, pois podem ocasionar erro na SEFAZ.
produtoEmbalagens.idProdutoRetaguarda	string	Identificador do produto na retaguarda
produtoEmbalagens.idRetaguarda	string	Identificador da embalagem na retaguarda
produtoEmbalagens.pesoBruto	float	Peso bruto da embalagem
produtoEmbalagens.pesoLiquido	float	Peso liquido da embalagem
produtoEmbalagens.quantidade	int	Quantidade de produtos na embalagem
produtoEmbalagens.situacao	int	Situação da embalagem
produtoEmbalagens.unidadeMedida	string	Unidade de medida da embalagem
produtoKits	Lista de objetos	Lista de kits
produtoKits.idRetaguarda	string	Registo único, responsável por identificar o item na tabela de produto_kit.		Registro único, não deve ser enviado mais de uma vez, em caso de criação de itens dentro do kit. Caso seja enviado mais de uma vez, o mesmo código, o registro será alterado.
produtoKits.idRetaguardaProduto	string	Identificador do produto KIT criado na tabela de produto.		Todo kit é um produto, devido a isso sempre haverá um registro descrito como kit na tabela de produto.
produtoKits.idRetaguardaProdutoKit	string	Identificador do item do kit na tabela de produto		Referencia os itens da tabela de produto que compõe o kit.
produtoKits.descricao	string	Descrição do kit
produtoKits.quantidadeVendaKit	int	Quantidade de venda do kit
produtoKits.tipoValorKit	int	Tipo valor kit
produtoKits.situacao	int	Situação do kit
produtoKits.valorDesconto	string	Valor de desconto
produtoKits.novoValorUnitario	string	Novo valor unitário
produtosSimilares	Lista de objetos	Lista de produtos similares
produtosSimilares.idRetaguardaProduto	string	Identificador do produto na retaguarda
produtosSimilares.idRetaguardaSimilar	string	Identificador do produto similar na retaguarda
produtosSimilares.situacao	int	Situação do produto similar
produtosSugestoes	Lista de objetos	Lista de sugestôes
produtosSugestoes.idRetaguardaProduto	string	Identificador do produto na retaguarda
produtosSugestoes.idRetaguardaSugestao	string	Identificador da sugestão na retaguarda
produtosSugestoes.situacao	int	Situação da sugestão
codigosProduto	Lista de objetos	Lista de códigos do produto
codigosProduto.codigo	string	Código do produto
codigosProduto.descricao	string	Descrição do código
codigosProduto.idRetaguarda	string	Identificador do código na retaguarda
codigosProduto.dataAtualizacao	string	Data atualização do código
codigosProduto.dataCadastro	string	Data cadastro do código
codigosProduto.situacao	int	Situação do produto
impostos	Lista de objetos	Lista de impostos do produto
impostos.idRetaguarda	string	Identificador do imposto na retaguarda
impostos.idProprietario	string	Identificador do proprietário
ncms	Lista de objetos	Lista de NCMs
ncms.idRetaguarda	string	Identificador do NCM na retaguarda
ncms.idProprietario	string	Identificador do proprietário
pisCofins	Lista de objetos	Lista de PisCofins
pisCofins.idRetaguarda	string	Identificador do PisCofin na retaguarda
pisCofins.idProprietario	string	Identificador do proprietário
fcps	Lista de objetos	Lista de FCPs
fcps.valorBaseFcp	string	Valor base do FCP
fcps.percentualFcp	string	Percentual do FCP
fcps.codigoBeneficioFiscal	string	Código de benefício fiscal
fcps.motivoDesoneracaoIcms	int	Motivo desoneração
fcps.descontaDesoneracaoNf	boolean	Desconto desoneraçao
fcps.idProprietario	string	Identificador do proprietário
quantidadeMovimentacao	float	Quanitdade de movimentação
idInquilino	string	Identificador do inquilino	X
idRetaguarda	string	Identificador do produto na retaguarda	X	Tamanho máximo: 100
idProprietario	string	Identificador do proprietário
loteOrigem	string	Identificador do lote que os dados serão enviados

Definição dos campos de retorno

200 - Ok

Campo	Tipo	Descrição
Success	bool	Indica se a criação do compartilhamento foi feita com sucesso
Message	string	Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo
Data	objeto	Objeto compartilhamento criado
Errors	Lista	Listas com os erros encontrados no processo
TotalTime	int	tempo da requisição
NumberOfRecords	int	número de dados inseridos

Body de retorno

{
"success": true,
"message": "",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}

400 - Bad Request

Campo	Tipo	Descrição
code	string	Código de erro
message	string	Mensagem do erro
detailedMessage	string	Detalhamento do erro
helpUrl	string	url de ajuda
TotalTime	string	Tempo total de busca
details	lista de objeto	Lista de objeto de erros
details.guid	string	Identificador do erro
details.code	string	Código do erro
details.message	string	Mensagem do erro
details.detailedMessage	string	Detalhamento do erro

Atalhos

Árvore de páginas