Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

draw.io Diagram
bordertrue
diagramNameAPI Consulta-cadastro cliente online
simpleViewerfalse
width
linksauto
tbstyletop
lboxtrue
diagramWidth2601
revision89



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

...

Definição de contratos de API:

Consulta online cliente:ProcessoOnlineConsultaCliente 

Request:

Response:

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

...

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

enderecoStringEndereço principal do cliente

Não

Tamanho máximo: 150 caracteres

numeroStringNúmero do endereço principal do cliente

Não

Tamanho máximo: 15 caracteres

complementoStringComplemente do endereço principal do cliente

Não

Tamanho máximo: 50 caracteres

bairroStringBairro principal do cliente

Não

Tamanho máximo: 100 caracteres

cidadeStringCidade principal do cliente

Não

Tamanho máximo: 100 caracteres

estadoStringEstado principal do cliente

Não

Tamanho máximo: 30 caracteres

cepStringCEP do endereço principal do cliente

Não

Tamanho máximo: 10 caracteres

telefoneStringTelefone do cliente

Não

Tamanho máximo: 20 caracteres

celularStringCelular do cliente

Não

Tamanho máximo:  20 caracteres

emailStringEmail do cliente

Não

Tamanho máximo: 80 caracteres

dataNascimentoDatetime

Data de nascimento do cliente

Não
situacaoIntSituação do cliente 

Sim

0 - Inativo, 1 - Ativo

pessoaFisicaIntIndica se o cliente é uma pessoa física ou jurídicaSim0 - Pessoa Física, 1 - Pessoa Jurídica
cpfCnpjStringCPF ou CNPJ do cliente

Não

Tamanho máximo: 25 caracteres

rgInscricaoStringRG do cliente

Não

Tamanho máximo: 25 caracteres

sexoIntIndica o genero do cliente 

Não

Descrição

Código

Não informado0
Masculino1
Feminino2
estadoCivilIntIndica o estado civil do cliente

Não

Descrição

Código

Não informado0
Casado1
Solteiro2
Viúvo3
Separado4
Divorciado5
Outros6
avatarUrlStringDEFASADONãoDEFASADO
atividadeStringAtividade

Não

Tamanho máximo: 500 caracteres

crachaStringDEFASADO

Não

DEFASADO

idInquilinoString

Identificador do inquilino 

Sim
idRetaguardaStringIdentificador do cliente na retaguardaSimTamanho máximo: 100 caracteres
idProprietarioStringIdentificador do proprietárioSim
loteOrigemStringIdentificador do lote em que serão enviados os dadosSim
tipoEnderecoIntTipo EndereçoNão

Descrição

Código

Entrega0
Comercial1
Cobrança2
descricaoStringDescriçãoNão

Tamanho máximo: 100 caracteres

IdRetaguardaProfissionalStringId 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.

IdRetaguardaRamoAtividadeString

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

IdRetaguardaClientePrincipalString

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.

IdRetaguardaPracaString

Id Retaguarda praça do cliente

Não

Tamanho máximo: 100 caracteres

IdRetaguardaRegiaoString

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.

UtlizadaPrecoAtacadobool

Falso ou Verdadeiro

NãoFalse - Falso, True - Verdadeiro
Valor default = False



Premissas: 

Restrições: 

Parametros de sistema:

...