Histórico da Página

Este método é responsável pela criação de novos ProdutoClientes

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

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

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

Expandir

title	Exemplo de body da requisição

[
{
"descricaonome": "string",
"unidadeMedidaendereco": "string",
"descontoMaximonumero": "string",
"arredondaTruncacomplemento": 0,
"codigoProduto": "string",
"codigoAlternativobairro": "string",
"origemProdutocidade": 0,
"situacao": 0,
"imagem": "string",
"tipoProduto": 0,
"fracionado": true,
"cnpjFornecedorestado": "string",
"escalaRelevantecep": true,
"cstIcms ": "string",
"percentualReducaoIcmstelefone": "string",
"aliquotaIcmscelular": "string",
"vlicmsret": "string",
"cestemail": "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 "dataNascimento": "2024-04-02T18:58:17.727Z",
"situacao": 0,
"pessoaFisica": 0,
"cpfCnpj": "string",
"rgInscricao": "string",
"sexo": 0,
"estadoCivil": 0,
"avatarUrl": "string",
"percentualFcp"atividade": "string",
"codigoBeneficioFiscal"cracha": "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

unidadeMedida

Campo	Tipo	Descrição	Observações
descricaonome	stringString	Descrição Nome do produtocliente
endereco
string	Unidade de medida do produto	descontoMaximo	string	Desconto máximo aplicado ao produto
String	Endereço principal do cliente
numero	String	Número do endereço principal do cliente
complemento	String	Complemente do endereço pricnipal do cliente
bairro	String	Bairro principal do cliente
cidade	String	Cidade principal do cliente
estado	String	Estado principal do cliente
cep	String	CEP do endereço principal do cliente
telefone	String	Telefone do cliente
celular	String	Celular do cliente
email	String	Email do cliente
dataNascimento	Datetime	Data de nascimento do cliente
situacao	Int	Situação do cliente (0 - Inativo, 1 - Ativo)
pessoaFisica	Int	Indica se o cliente é uma pessoa física ou jurídica
cpfCnpj	String	CPF ou CNPJ do cliente
rgInscricao	String	RG do cliente
sexo	Int	Indica o genero do cliente (Descritivo abaixo)
estadoCivil	Int	Indica o estado civil do cliente (Descritivo abaixo)
avatarUrl	String	Avatar do cliente
atividade	String	Atividade
cracha	String	Crachá
idInquilino	String	Identificador do inquilino
idRetaguarda	String	Identificador do cliente na retaguarda
idProprietario	String	Identificador do proprietário
loteOrigem	String	Identificador do lote em que serão enviados os dados	arredondaTrunca	int	codigoProduto	string	Código do produto	codigoAlternativo	string	Código alternativo do produto	origemProduto	int	Origem do produto	situacao	int	Situação do produto (0 - Inativo, 1 - Ativo)	imagem	string	URL com a imagem do produto	tipoProduto	int	fracionado	boolean	Indica se o produto é vendido fracionado	cnpjFornecedor	string	CNPJ do fornecedor do produto	escalaRelevante	boolean	cstIcms	string	CST ICMS do produto	percentualReducaoIcms	string	Percentual de redução ICMS	aliquotaIcms	string	Aliquota ICMS	vlicmsret	string	cest	string	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	associacaoProdutosClassificacao.ordem	int	associacaoProdutosClassificacao.situacao	int	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	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	produtoEmbalagens.unidadeMedida	string	Unidade de medida da embalagem	produtoKits	Lista de objetos	Lista de kits	produtoKits.idRetaguardaProduto	string	Identificador do produto na retaguarda	produtoKits.idRetaguardaProdutoKit	string	Identificador do kit na retaguarda	produtoKits.descricao	string	Descrição do kit	produtoKits.quantidadeVendaKit	int	produtoKits.tipoValorKit	int	produtoKits.situacao	int	produtoKits.valorDesconto	string	produtoKits.novoValorUnitario	string	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	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	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	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	fcps.descontaDesoneracaoNf	boolean	fcps.idProprietario	string	Identificador do proprietário	quantidadeMovimentacao	float	idInquilino	string	Identificador do inquilino	idRetaguarda	string	Identificador do produto na retaguarda	idProprietario	string	Identificador do proprietário	loteOrigem	string	Identificador do lote que os dados serão enviados

Expandir

title	Definição dos campos de retorno

Expandir

title	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

Expandir

title	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

Árvore de páginas

Versões comparadas

Versão antiga 1

Nova versão 2

Chave