Histórico da Página

Este método é responsável pela criação de novos Produtoou 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

...

Expandir

title	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" 0,
"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"
}
]

Expandir

title	Definição dos campos de requisição

Campo	Tipo	Descrição	Obrigatório	Observações
descricao	string	Descrição do produto

Obrigatório;

Sim	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

Obrigatório;

Sim

Tamanho máximo: 20

descontoMaximo

string

numérico

Desconto máximo aplicado ao produto

Opcional

Não

arredondaTrunca


tipoArredondaTrunca	int

Opcional

	Não
codigoProduto	string	Código do produto

Obrigatório;

Sim	Tamanho máximo:

600

20
codigoAlternativo	string	Código alternativo do produto

Obrigatório;

Sim

Tamanho máximo: 40

origemProduto

int

Origem do produto

Obrigatório

	Sim	0 – Nacional: exceto as indicadas nos códigos 3, 4, 5 e 8; 1 – Estrangeira: importação direta, exceto a indicada no código 6; 2 – Estrangeira: adquirida no mercado interno, exceto a indicada no código 7; 3 – Nacional: mercadoria ou bem com conteúdo de importação superior a 40% e inferior ou igual a 70%; 4 – Nacional: cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam o Decreto-Lei nº 288/1967, e as Leis nº 8.248/1991, 8.387/1991, 10.176/2001 e 11.484/2007; 5 – Nacional: mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%; 6 – Estrangeira: importação direta, sem similar nacional, constante em lista de Resolução Camex e gás natural; 7 – Estrangeira: adquirida no mercado interno, sem similar nacional, constante em lista de Resolução Camex e gás natural; 8 – Nacional: mercadoria ou bem com Conteúdo de Importação superior a 70%.
situacao	int	Situação do

produto (

produto

Sim

0 - Inativo, 1 - Ativo

)

Obrigatório

imagem

string

URL com a imagem do produto

Opcional

	Não	Tamanho máximo: 200 caracteres
tipoProduto	int	Tipo do produto

Obrigatório

Não

Descrição	Valor
Não definido	0
Consumo	1
Revenda	2
Kit	3
Matéria	4
Produto acabado	5
Serviço	6

fracionado

boolean

Indica se o produto é vendido fracionado

Opcional

Não
cnpjFornecedor	string	CNPJ do fornecedor do produto

Opcional

	Não	Tamanho máximo: 20 caracteres
escalaRelevante	boolean	Escala relevante

Opcional

Não
cstIcms	string

CST ICMS do produto

DEFASADO

Não

Tamanho máximo: 4 caracteres

Opcional

percentualReducaoIcms

string

numérico

Percentual de redução ICMS

Opcional

Não
aliquotaIcms

string

numérico

Aliquota ICMS

Opcional

	Não	Pode ser enviado como string para atender ao legado, contudo, caso se enviado algo que não possa ser convertido para inteiro será devolvido um retorno de erro.
vlicmsret	string

vlicmsret

DEFASADO

Não

Tamanho máximo: 7 caracteres

Opcional


cest	string	Cest

Opcional

Não
encomenda	boolean	Indica se o produto é uma encomenda

Opcional

Não
pesoLiquido

float

numérico

Peso liquido do produto

Opcional

Não
pesoBruto

float

numérico

Peso bruto do produto

Opcional

Não
associacaoProdutosClassificacao	Lista de objetos	Lista de classificação do produto

Opcional

Não
associacaoProdutosClassificacao.idRetaguarda	string	Identificador da classificação na retaguarda

Opcional

Sim	Tamanho máximo: 100 caracteres
associacaoProdutosClassificacao.idRetaguardaProduto	string	Identificador do produto na retaguarda

Opcional

Sim
associacaoProdutosClassificacao.idRetaguardaClassificacaoProduto	string	Identificador da classificação na retaguarda

Opcional

Sim
associacaoProdutosClassificacao.

ordemOpcional

ordem

int

Ordem

opcional

Opcional

Sim
associacaoProdutosClassificacao.situacao	int	Situação da classificação

Opcional

Sim
produtoEmbalagens	lista de objetos	Lista de embalagens do produto

Opcional

Não
produtoEmbalagens.codigoBarras	string	Código de barras da embalagem

Opcional

	Sim	Tamanho máximo: 20 caracteres
produtoEmbalagens.descricao	string	Descrição da embalagem

Opcional

	Não	Tamanho máxiom: 200 caracteres 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

Opcional

	Sim	Tamanho máximo: 100 caracteres
produtoEmbalagens.idRetaguarda	string	Identificador da embalagem na retaguarda

Opcional

	Sim	Tamanho máximo: 100 caracteres
produtoEmbalagens.pesoBruto

float

int	Peso bruto da embalagem

Opcional

Não
produtoEmbalagens.pesoLiquido

float

int	Peso liquido da embalagem

Opcional

Não
produtoEmbalagens.quantidade	int	Quantidade de produtos na embalagem

Opcional

Não
produtoEmbalagens.situacao	int	Situação da embalagem

Opcional

	Sim	0 - Inativo 1 - Ativo
produtoEmbalagens.unidadeMedida	string	Unidade de medida da embalagem

Opcional

Sim
produtoKits	Lista de objetos	Lista de kits

Opcional

	Não
produtoKits.idRetaguarda	string	Registo único, responsável por identificar o item na tabela de produto_kit.	Sim	Tamanho máximo: 100 caracteres 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

na retaguardaOpcional

KIT criado na tabela de produto.	Não	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

retaguardaOpcional

tabela de produto	Não	Referencia os itens da tabela de produto que compõe o kit.
produtoKits.descricao	string	Descrição do

kitOpcional

produto que compõe o KIT	Sim	Tamanho máximo: 100 caracteres
produtoKits.quantidadeVendaKit	int	Quantidade

de venda do kit

daquele determinado item dentro do KIT.

Sim

Opcional


produtoKits.tipoValorKit	int	Tipo valor kit

Opcional

Sim

Tipo	Valor	Descrição
Não tem desconto	0	O valor da tabela vigente será considerado para o item
Valor fixo	1	O valor do campo novoValorUnitario será o valor do item no KIT
Percentual desconto	2	O valor do campo valorDesconto será aplicado no item percentualmente. Por exemplo: Se o valor da valorDesconto for 10.00, será aplicado 10% de desconto no item

produtoKits.situacao

int

Situação do kit

Opcional

	Sim	0 - Inativo 1 - Ativo
produtoKits.valorDesconto

string

numérico

Valor percentual que será aplicado de desconto

Opcional

no item da composição do KIT	Não
produtoKits.novoValorUnitario

stringNovo valor unitário

numérico

Valor real que será aplicado de desconto no item da composição do KIT, desconsiderando o valor da tabela de preço atual

Não

Opcional


produtosSimilares	Lista de objetos	Lista de produtos similares

Opcional

Não
produtosSimilares.idRetaguardaProduto	string	Identificador do produto na retaguarda

Opcional

	Sim	Tamanho máximo: 100 caracteres
produtosSimilares.idRetaguardaSimilar	string	Identificador do produto similar na retaguarda

Opcional

	Sim	Tamanho máximo: 100 caracteres
produtosSimilares.situacao	int	Situação do produto similar

Opcional

	Sim	0 - Inativo 1 - Ativo
produtosSugestoes	Lista de objetos	Lista de sugestôes

Opcional

Não
produtosSugestoes.idRetaguardaProduto	string	Identificador do produto na retaguarda

Opcional

Sim
produtosSugestoes.idRetaguardaSugestao	string	Identificador da sugestão na retaguarda

Opcional

Sim
produtosSugestoes.situacao	int	Situação da sugestão

Opcional

Sim
codigosProduto	Lista de objetos	Lista de códigos do produto

Opcional

Não
codigosProduto.codigo	string	Código do produto

Opcional

Não
codigosProduto.descricao	string	Descrição do código

Opcional

Não
codigosProduto.idRetaguarda	string	Identificador do código na retaguarda

Opcional

Não
codigosProduto.dataAtualizacao	string	Data atualização do código

Opcional

Não
codigosProduto.dataCadastro	string	Data cadastro do código

Opcional

Não
codigosProduto.situacao	int	Situação do produto

Opcional

Não
impostos	Lista de objetos	Lista de impostos do produto

Obrigatório

Sim
impostos.idRetaguarda	string	Identificador do imposto na retaguarda

Opcional

Sim
impostos.idProprietario	string	Identificador do proprietário

Opcional

Sim
ncms	Lista de objetos	Lista de NCMs

Opcional

Sim
ncms.idRetaguarda	string	Identificador do NCM na retaguarda

Opcional

Sim
ncms.idProprietario	string	Identificador do proprietário

Opcional

Sim
pisCofins	Lista de objetos	Lista de PisCofins

Opcional

Sim
pisCofins.idRetaguarda	string	Identificador do PisCofin na retaguarda

Opcional

Sim
pisCofins.idProprietario	string	Identificador do proprietário

Opcional

Sim
fcps	Lista de objetos	Lista de FCPs

Opcional

Não
fcps.valorBaseFcp	string

Valor base do FCP

DEFASADO

Não

Opcional


fcps.percentualFcp

string

numérico

Percentual do FCP

Opcional

Não
fcps.codigoBeneficioFiscal	string	Código de benefício fiscal

Opcional

	Não	Tamanho máximo: 20 caracteres
fcps.motivoDesoneracaoIcms	int	Motivo desoneração

Opcional

Não
fcps.descontaDesoneracaoNf	boolean

Desconto desoneraçao

DEFASADO

Opcional

Não
fcps.idProprietario	string	Identificador do proprietário

Opcional

Não
quantidadeMovimentacao

float

numérico

Quanitdade de movimentação

Opcional

Não
idInquilino	string	Identificador do inquilino

Obrigatório

Sim
idRetaguarda	string	Identificador do produto na retaguarda

Obrigatório;

Sim

Tamanho máximo: 100

idProprietario

string

Identificador do proprietário

Obrigatório

Sim
loteOrigem	string	Identificador do lote que os dados serão enviados

Opcional

Sim

Árvore de páginas

Versões comparadas

Versão antiga 4

Nova versão 19

Chave