Histórico da Página

draw.io Diagram

border	true

diagramName	API Consulta-cadastro cliente online
simpleViewer	false
width
links	auto
tbstyle	top
lbox	true
diagramWidth	2601
revision	9

Dores e necessidade	Efetuar a consulta online de cadastro de cliente na retaguarda
Negócio	No PDV e Pedido deve ser possível, após informar o CPF/CNPJ do cliente, efetuar consulta na retaguarda para valdiar se o cliente já existe cadastrado
Entrega de valor	A consulta será efetuada de forma online otimizando o processo de integração de clientes entre retaguarda e PDV Omni

Dores e necessidades	Cadastrar cliente na base no PDV Omni atraves de consulta na retaguarda
Negócio	No PDV e Pedido após informar um cliente que possua cadastro na retaguarda os dados devem ser inseridos na base do PDV para que o cliente seja cadastrado
Entrega de valor	O Processo irá buscar cadastros na retaguarda e inserir na base do PDV otimizando a necessidade de cadastros

Dores e necessidade	Efetuar a consulta na retaguarda para validar se cliente pode ser alterado
Negócio	Devido a restrições de pedido em andamento é necessario validar se o cadastro de um cliente poderá ser alterado
Entrega de valor	A consulta será efetuada de forma online onde a retaguarda irá definir se o cadastro do cliente pode ser alterado devido a restrições da operação.

Tabelas e campos no PDV Omni

Tabela:

Nome do campo	Tipo do campo	Obrigatorio

Definição de contratos de API:

ProcessoOnlineConsultaCliente

Request:

Response:

{
"success": true,
"message": "",
"data": {

    {
      "atividade": "string",
      "avatarUrl": "string",
      "bairro": "string",
      "celular": "string",
      "cep": "string",
      "cidade": "string",
      "complemento": "string",
      "cpfCnpj": "string",
      "cracha": "string",
      "dataNascimento": "2024-04-02T18:58:17.727Z",
      "email": "string",
      "endereco": "string",
      "estado": "string",
      "estadoCivil": 0,
      "idInquilino": "string",
      "idProprietario": "string",
      "idRetaguarda": "string",
      "loteOrigem": "string",
      "nome": "string",
      "numero": "string",
      "pessoaFisica": 0,
      "rgInscricao": "string",
      "sexo": 0,
      "situacao": 0,
      "telefone": "string",
      "IdRetaguardaProfissional": "string",
      "IdRetaguardaRamoAtividade": "string",
      "IdRetaguardaRedeCliente": "string",
      "IdRetaguardaClientePrincipal": "string",
      "IdRetaguardaPraca": "string",
      "IdRetaguardaRegiao": "string",
      "UtilizaPrecoAtacado": false
    }

},
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}

Especificações campo objeto data de retorno:

Definições dos campos do body

Campo

Tipo

Descrição

Obrigatório

Observações

nome

String

Nome do cliente

Sim

Tamanho máximo: 250 caracteres

endereco

String

Endereço principal do cliente

Não

Tamanho máximo: 150 caracteres

numero

String

Número do endereço principal do cliente

Não

Tamanho máximo: 15 caracteres

complemento

String

Complemente do endereço principal do cliente

Não

Tamanho máximo: 50 caracteres

bairro

String

Bairro principal do cliente

Não

Tamanho máximo: 100 caracteres

cidade

String

Cidade principal do cliente

Não

Tamanho máximo: 100 caracteres

estado

String

Estado principal do cliente

Não

Tamanho máximo: 30 caracteres

cep

String

CEP do endereço principal do cliente

Não

Tamanho máximo: 10 caracteres

telefone

String

Telefone do cliente

Não

Tamanho máximo: 20 caracteres

celular

String

Celular do cliente

Não

Tamanho máximo: 20 caracteres

email

String

Email do cliente

Não

Tamanho máximo: 80 caracteres

dataNascimento

Datetime

Data de nascimento do cliente

Não

situacao

Int

Situação do cliente

Sim

0 - Inativo, 1 - Ativo

pessoaFisica

Int

Indica se o cliente é uma pessoa física ou jurídica

Sim

0 - Pessoa Física, 1 - Pessoa Jurídica

cpfCnpj

String

CPF ou CNPJ do cliente

Não

Tamanho máximo: 25 caracteres

rgInscricao

String

RG do cliente

Não

Tamanho máximo: 25 caracteres

sexo

Int

Indica o genero do cliente

Não

Descrição	Código
Não informado	0
Masculino	1
Feminino	2

estadoCivil

Int

Indica o estado civil do cliente

Não

Descrição	Código
Não informado	0
Casado	1
Solteiro	2
Viúvo	3
Separado	4
Divorciado	5
Outros	6

avatarUrl

String

DEFASADO

Não

DEFASADO

atividade

String

Atividade

Não

Tamanho máximo: 500 caracteres

cracha

String

DEFASADO

Não

DEFASADO

idInquilino

String

Identificador do inquilino

Sim

idRetaguarda

String

Identificador do cliente na retaguarda

Sim

Tamanho máximo: 100 caracteres

idProprietario

String

Identificador do proprietário

Sim

loteOrigem

String

Identificador do lote em que serão enviados os dados

Sim

tipoEndereco

Int

Tipo Endereço

Não

Descrição	Código
Entrega	0
Comercial	1
Cobrança	2

descricao

String

Descrição

Não

Tamanho máximo: 100 caracteres

IdRetaguardaProfissional

String

Id Retaguarda do Profissional vinculado a tabela usuario

Não

Tamanho máximo: 100 caracteres

regra de gravação: campos null ou não preenchidos e os encontrados na tabela usuario.

regra de erro: não encontrado na tabela usuário o registro inteiro estará com erro.

IdRetaguardaRamoAtividade

String

Id Retaguarda Ramo Atividade vinculado a tabela ramo_atividade

Não

Tamanho máximo: 100 caracteres

regra de gravação: campos null ou não preenchidos e os encontrados na tabela cliente.

regra de erro: não encontrado na tabela cliente ou enviado no mesmo payload o registro inteiro estará com erro.

IdRetaguardaRedeCliente

String

Id Retaguarda da rede do cliente

Não

Tamanho máximo: 100 caracteres

IdRetaguardaClientePrincipal

String

Id Retaguarda do cliente principal, caso seja o principal será nulo.

Não

Tamanho máximo: 100 caracteres

regra de gravação: campos null ou não preenchidos e os encontrados na tabela cliente.

regra de erro: não encontrado na tabela cliente ou enviado no mesmo payload o registro inteiro estará com erro.

IdRetaguardaPraca

String

Id Retaguarda praça do cliente

Não

Tamanho máximo: 100 caracteres

IdRetaguardaRegiao

String

Id Retaguarda regiao vinculado a tabela regiao

Não

Tamanho máximo: 100 caracteres

regra de gravação: campos null ou não preenchidos e os encontrados na tabela regiao.

regra de erro: não encontrado na tabela regiao o registro inteiro estará com erro.

UtlizadaPrecoAtacado

bool

Falso ou Verdadeiro

Não

False - Falso, True - Verdadeiro
Valor default = False

Premissas:

Restrições:

Parametros de sistema:

Pontos de atenção:

verificar documentação do varejo 801 - DT -API de gravação de clientes fidelidade

TDN referencia

Árvore de páginas

Versões comparadas

Versão antiga 19

Nova versão Atual

Chave

Definições dos campos do body